Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/configuration/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ REDIS_PASSWORD='topsecret'

JWT_PRIVATE_KEY='topsecret' # (8)!

SECRET_KEY='anothertopsecret' # (15)!

# SeaDoc
ENABLE_SEADOC='false'
SEADOC_PORT=''
Expand Down Expand Up @@ -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
Expand All @@ -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.

<!--
TODO: add environment variables for cluster setup!
Expand Down
8 changes: 6 additions & 2 deletions docs/installation/advanced/s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ While the previous approach [via configuration files](#configuration-files) is s

<!-- md:version 6.1 -->

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`.


Expand All @@ -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=''
```
Expand All @@ -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=''
Expand All @@ -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=''
Expand All @@ -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=''
Expand Down Expand Up @@ -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

<!-- md:version 4.4 -->

Expand Down
2 changes: 2 additions & 0 deletions docs/installation/advanced/seatable-ai-standalone.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 3 additions & 0 deletions docs/installation/basic-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
Loading