docs: add s3 config section in install page

This commit is contained in:
Yassine Doghri 2023-03-16 15:46:50 +00:00
parent d93fc98469
commit 73c2987d4c
4 changed files with 883 additions and 1617 deletions

View File

@ -50,9 +50,16 @@ cache.handler="file"
# cache.redis.port=6379
# cache.redis.database=0
#--------------------------------------------------------------------
# S3 configuration
#--------------------------------------------------------------------
# media.fileManager="s3"
# media.s3.endpoint="your_s3_host"
# media.s3.key="your_s3_key"
# media.s3.secret="your_s3_secret"
# media.s3.region="your_s3_region"
#--------------------------------------------------------------------
# REST API configuration
#--------------------------------------------------------------------
# restapi.enabled=true

View File

@ -9,18 +9,21 @@ stages:
- cd docs
- chmod +x ./scripts/i18n-filter.sh
- ./scripts/i18n-filter.sh src
- pnpm install
- npm install
cache:
key:
files:
- docs/package-lock.json
paths:
- docs/node_modules/
- docs/node_modules
# This job only serves for validating that the docs builds correctly on all non deployment branches
build:
extends: .documentation-setup
stage: build
script:
- pnpm run build
- npm run build
except:
- main
- beta
@ -33,7 +36,7 @@ build-production:
name: production
url: https://docs.castopod.org/
script:
- pnpm run build
- npm run build
artifacts:
paths:
- docs/.vitepress/dist

2449
docs/package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -162,6 +162,35 @@ email.SMTPPass="your_smtp_password"
| **`SMTPPort`** | number | `25` |
| **`SMTPCrypto`** | [`"tls"` or `"ssl"`] | `"tls"` |
### S3
By default, files are stored in the `public/media` folder using the filesystem.
If you prefer storing your media files on an S3 compatible storage, you may
specify it in your `.env`:
```ini
# […]
media.fileManager="s3"
media.s3.endpoint="your_s3_host"
media.s3.key="your_s3_key"
media.s3.secret="your_s3_secret"
media.s3.region="your_s3_region"
```
#### S3 config options
| Variable name | Type | Default |
| ------------------------- | ------- | ----------- |
| **`endpoint`** | string | `undefined` |
| **`key`** | string | `undefined` |
| **`secret`** | string | `undefined` |
| **`region`** | string | `undefined` |
| **`bucket`** | string | `castopod` |
| **`protocol`** | number | `undefined` |
| **`path_style_endpoint`** | boolean | `false` |
## Community packages
If you don't want to bother with installing Castopod manually, you may use one