Environment Variables
Docker Compose
| Variable | Description | Default |
|---|---|---|
| AFFINE_REVISION | The AFFiNE revision to deploy, available values: stable, beta, canary | stable |
| DB_DATA_LOCATION | position of the Postgres data to persist | |
| UPLOAD_LOCATION | position of the uploaded blobs(images, files, etc.) to persist | |
| CONFIG_LOCATION | position of user custom configuration files to persist |
Server
| Variable | Description | Default |
|---|---|---|
| AFFINE_PRIVATE_KEY | The private key for used by the crypto module to create signed tokens or encrypt data. If not provided, AFFiNE will autogenerated one under CONFIG_LOCATION at first start. | |
| AFFINE_SERVER_HTTPS | Whether the server is hosted on a ssl enabled domain | false |
| AFFINE_SERVER_HOST | Where the server get deployed(FQDN) | localhost |
| AFFINE_SERVER_PORT | Which port the server will listen on(in container) | 3010 |
| AFFINE_SERVER_SUB_PATH | Subpath where the server get deployed, if there is | |
| AFFINE_SERVER_EXTERNAL_URL | Base url of AFFiNE server, used for generating external urls. Default to be [server.protocol]://[server.host][:server.port] if not specified. |
Database(Postgres)
| Variable | Description | Default |
|---|---|---|
| DATABASE_URL | Database URL passed to server if you are not using docker compose. | |
| DB_USERNAME | database user | affine |
| DB_PASSWORD | database password For docker compose users, you must set a password to initialize the Postgres, otherwise, set POSTGRES_HOST_AUTH_METHOD=trust to tell Postgres stop compaining about weak safety. | |
| DB_DATABASE | database name | affine |
Redis
| Variable | Description | Default |
|---|---|---|
| REDIS_SERVER_HOST | redis host | localhost |
| REDIS_SERVER_PORT | redis port | 6379 |
| REDIS_SERVER_USERNAME | redis username | |
| REDIS_SERVER_PASSWORD | redis password | |
| REDIS_SERVER_DATABASE | The database index of redis server to be used. if n set as REDIS_SERVER_DATABASE, AFFiNE will use database from n to n+4 for different purpose. | 0 |
| Variable | Description | Default |
|---|---|---|
| MAILER_HOST | Host of the email server (e.g. smtp.gmail.com) | |
| MAILER_PORT | Port of the email server (they commonly are 25, 465 or 587) | 465 |
| MAILER_USER | Username used to authenticate the email server | |
| MAILER_PASSWORD | Password used to authenticate the email server | |
| MAILER_SENDER | Sender of all the emails (e.g. "AFFiNE Team <[email protected]>") | |
| MAILER_IGNORE_TLS | Whether ignore email server's TSL certification verification. Enable it for self-signed certificates |
ON THIS PAGE