Infrastructure/pingvin-share
0
Fork 0
mirror of https://github.com/stonith404/pingvin-share.git synced 2025-01-15 01:14:27 -05:00
Code Issues Activity

docs: update S3 bucket name description (#712)

Browse source 
* update s3 docs

* Update s3.md
This commit is contained in:
Mattia Müggler 2024-12-29 18:13:09 +01:00 committed by GitHub
parent 362e7d4f38
commit a120d44185
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/docs/setup/s3.md
View file

@ -14,8 +14,8 @@ You can configure your S3 provider and bucket by going to the configuration page
| Key | Description | Value |
|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------|
| enabled | This property enables the storage location on your configured S3 bucket. | `true` |
| endpoint | This property is the host from your S3 bucket. | `sos-ch-dk-2` |
| region | This property is the region where the bucket is located. | `sos-ch-dk-2.exo.io` |
| endpoint | The host for your S3 bucket. Endpoint formats vary by provider and some may include the bucket name in the FQDN. Ensure this is configured correctly, as an incorrect value may break some features. | `sos-ch-dk-2.exo.io` |
| region | This property is the region where the bucket is located. | `sos-ch-dk-2` |
| bucketName | This property is the name of your S3 bucket. | `my-bucket` |
| bucketPath | This property defines the folder where you want to store your files which are uploaded. Hint: Don't put a slash in the start or end. | `my/custom/path` (or leave it empty for root) |
| key | This is the access key you need to access to your bucket. | `key-asdf` |
@ -29,4 +29,4 @@ Consider that ClamAV scans are not available at the moment if you store your fil
## ZIP
Creating ZIP archives is not currently supported if you store your files in an S3 bucket.
Creating ZIP archives is not currently supported if you store your files in an S3 bucket.