diff --git a/docs/configuration/overview.md b/docs/configuration/overview.md index bfb187ab..ae0f5451 100644 --- a/docs/configuration/overview.md +++ b/docs/configuration/overview.md @@ -48,6 +48,8 @@ REDIS_PASSWORD='topsecret' JWT_PRIVATE_KEY='topsecret' # (8)! +SECRET_KEY='anothertopsecret' # (15)! + # SeaDoc ENABLE_SEADOC='false' SEADOC_PORT='' @@ -77,7 +79,7 @@ SEATABLE_TEMPLATE_TABLE_NAME= SEATABLE_ENABLE_CREATE_BASE_FROM_TEMPLATE= # Logging -SEATABLE_LOG_LEVEL=INFO # (10)! +LOG_LEVEL=INFO # (10)! # Docker Images # You can use these variables to override the default images @@ -104,6 +106,7 @@ SEATABLE_HELP_LINK=https://seatable.com/help/ # (11)! 12. Please refer to [Email Sending](./sending-email.md) for more information. 13. Please refer to [Python Pipeline](../installation/components/python-pipeline.md) for more information. 14. Please refer to [SeaTable AI](../installation/components/seatable-ai.md) for more information. +15. This secret key is used to Django in SeaTable. -To enable S3 storage for base snapshots, files and pictures, add `seatable-s3.yml` to the `COMPOSE_FILE` variable inside your `.env` file. +To enable S3 storage for base snapshots, files, pictures and avatars, add `seatable-s3.yml` to the `COMPOSE_FILE` variable inside your `.env` file. This instructs Docker-Compose to extend the definition of the `seatable-server` service defined inside `seatable-server.yml`. @@ -108,6 +108,7 @@ Afterwards, you must configure a few environment variables inside your `.env` fi S3_COMMIT_BUCKET='' S3_FS_BUCKET='' S3_BLOCK_BUCKET='' + S3_AVATAR_BUCKET='' S3_KEY_ID='' S3_SECRET_KEY='' ``` @@ -121,6 +122,7 @@ Afterwards, you must configure a few environment variables inside your `.env` fi S3_COMMIT_BUCKET='' S3_FS_BUCKET='' S3_BLOCK_BUCKET='' + S3_AVATAR_BUCKET='' S3_HOST='sos-de-fra-1.exo.io' S3_KEY_ID='' S3_SECRET_KEY='' @@ -136,6 +138,7 @@ Afterwards, you must configure a few environment variables inside your `.env` fi S3_COMMIT_BUCKET='' S3_FS_BUCKET='' S3_BLOCK_BUCKET='' + S3_AVATAR_BUCKET='' S3_HOST='fsn1.your-objectstorage.com' S3_KEY_ID='' S3_SECRET_KEY='' @@ -151,6 +154,7 @@ Afterwards, you must configure a few environment variables inside your `.env` fi S3_COMMIT_BUCKET='' S3_FS_BUCKET='' S3_BLOCK_BUCKET='' + S3_AVATAR_BUCKET='' S3_HOST='' S3_KEY_ID='' S3_SECRET_KEY='' @@ -394,7 +398,7 @@ S3 Object storage for file and picture columns is configured in `/opt/seatable-s memcached_options = --SERVER=memcached --POOL-MIN=10 --POOL-MAX=100 ``` -## S3 for avatars +### S3 for avatars diff --git a/docs/installation/advanced/seatable-ai-standalone.md b/docs/installation/advanced/seatable-ai-standalone.md index 944f653d..f639d2a9 100644 --- a/docs/installation/advanced/seatable-ai-standalone.md +++ b/docs/installation/advanced/seatable-ai-standalone.md @@ -37,6 +37,8 @@ REDIS_PASSWORD= # This private key must have the same value as the JWT_PRIVATE_KEY variable on other SeaTable nodes JWT_PRIVATE_KEY= +SECRET_KEY= + # Public URL of your SeaTable server SEATABLE_SERVER_URL=https://seatable.your-domain.com diff --git a/docs/installation/basic-setup.md b/docs/installation/basic-setup.md index 96d930a1..6fe5adbb 100644 --- a/docs/installation/basic-setup.md +++ b/docs/installation/basic-setup.md @@ -100,6 +100,7 @@ Now use the command line tool `pwgen` to create secure passwords for your _admin sed -i "s/^MARIADB_PASSWORD=.*/MARIADB_PASSWORD=$(pwgen 40 1)/" .env sed -i "s/^REDIS_PASSWORD=.*/REDIS_PASSWORD=$(pwgen 40 1)/" .env sed -i "s/^JWT_PRIVATE_KEY=.*/JWT_PRIVATE_KEY=$(pwgen 40 1)/" .env + sed -i "s/^SECRET_KEY=.*/SECRET_KEY=$(pwgen 40 1)/" .env Alternatively, you can manually add your own passwords. @@ -150,6 +151,8 @@ Continue setting up your SeaTable server by adjusting only three more variables. # shared secret for secure communication JWT_PRIVATE_KEY='anothersecret' + + SECRET_KEY='anothertopsecret' ``` 1. COMPOSE_FILE is a comma-separated list **without spaces**. This list defines which components the server runs. Leave `caddy.yml` and `seatable-server.yml` at the beginning. You will add more components at a later time. diff --git a/docs/installation/cluster/basic-setup-with-external-services.md b/docs/installation/cluster/basic-setup-with-external-services.md index 56ad8216..6878da59 100644 --- a/docs/installation/cluster/basic-setup-with-external-services.md +++ b/docs/installation/cluster/basic-setup-with-external-services.md @@ -49,6 +49,8 @@ Follow the [installation instructions for a single node](../basic-setup.md) up t # shared secret for secure communication JWT_PRIVATE_KEY='topsecret' + + SECRET_KEY='anothertopsecret' ``` ??? success "Remove Redis and Mariadb from your YAML file."