Skip to content

Commit

Permalink
Add insecureTLS doc for skip TLS certificate verification feature f…
Browse files Browse the repository at this point in the history 
…or `s3`.

Signed-off-by: Anisur Rahman <[email protected]>
  • Loading branch information
@anisurrahman75
anisurrahman75 committed Feb 15, 2024
1 parent 6b84f9a commit 40a7dfc
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions docs/guides/backends/s3/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,13 @@ Now, you have to create a `Repository` crd. You have to provide the storage secr

Following parameters are available for `S3` backend.

| Parameter | Type | Description |
| ------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `s3.endpoint` | `Required` | For S3, use `s3.amazonaws.com`. If your bucket is in a different location, S3 server (s3.amazonaws.com) will redirect Stash to the correct endpoint. For DigitalOCean, use `nyc3.digitaloceanspaces.com` etc. depending on your bucket region. For S3-compatible other storage services like Minio / Rook use URL of the server. |
| `s3.bucket` | `Required` | Name of Bucket. If the bucket does not exist yet it will be created in the default location (`us-east-1` for S3). It is not possible at the moment for Stash to create a new bucket in a different location, so you need to create it using a different program. |
| `s3.region` | `Optional` | Specify the region of your bucket. |
| `s3.prefix` | `Optional` | Path prefix inside the bucket where the backed up data will be stored. |
| Parameter | Type | Description |
|------------------| ---------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `s3.endpoint` | `Required` | For S3, use `s3.amazonaws.com`. If your bucket is in a different location, S3 server (s3.amazonaws.com) will redirect Stash to the correct endpoint. For DigitalOCean, use `nyc3.digitaloceanspaces.com` etc. depending on your bucket region. For S3-compatible other storage services like Minio / Rook use URL of the server. |
| `s3.bucket` | `Required` | Name of Bucket. If the bucket does not exist yet it will be created in the default location (`us-east-1` for S3). It is not possible at the moment for Stash to create a new bucket in a different location, so you need to create it using a different program. |
| `s3.region` | `Optional` | Specify the region of your bucket. |
| `s3.prefix` | `Optional` | Path prefix inside the bucket where the backed up data will be stored. |
| `s3.insecureTLS` | `Optional` | Specify whether to skip TLS certificate verification. Setting this field to `true` disables verification, which might be necessary in cases where the server uses self-signed certificates or certificates from an untrusted CA. Use this option with caution, as it can expose the client to man-in-the-middle attacks and other security risks. Only use it when absolutely necessary. |

Below, the YAML of a sample `Repository` crd that uses an `S3` bucket as a backend.

Expand Down

0 comments on commit 40a7dfc

Please sign in to comment.