Add insecureTLS doc to skip TLS certificate verification feature fo…

…r `s3`. (#287) Signed-off-by: Anisur Rahman <[email protected]>
stashed · Sep 6, 2024 · ef15b0a · ef15b0a
1 parent 7bcba1f
commit ef15b0a
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 8 deletions.
diff --git a/docs/guides/backends/s3/index.md b/docs/guides/backends/s3/index.md
@@ -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.
 

diff --git a/docs/reference/cli/kubectl-stash.md b/docs/reference/cli/kubectl-stash.md
@@ -19,7 +19,7 @@ kubectl plugin for Stash by AppsCode
 
 ### Synopsis
 
-kubectl plugin for Stash by AppsCode. For more information, visit here: https://appscode.com/products/stash
+kubectl plugin for Stash by AppsCode. For more information, visit here: https://stash.run
 
 ### Options
 

diff --git a/docs/reference/operator/stash.md b/docs/reference/operator/stash.md
@@ -19,7 +19,7 @@ Stash by AppsCode - Backup your Kubernetes Volumes
 
 ### Synopsis
 
-Stash is a Kubernetes operator for restic. For more information, visit here: https://appscode.com/products/stash
+Stash is a Kubernetes operator for restic. For more information, visit here: https://stash.run
 
 ### Options