Skip to content

Configuration Reference ​

Compose and container runtime settings are environment variables in the .env file, which install.sh generates. The hostnames the server accepts and the server's own database connection come from etebase-server.ini, which the installer also generates and mounts into the container (see below). The PostgreSQL credentials in .env configure the database container and must match the [database] section of that ini file.

Environment Variables ​

VariableRequiredDefaultDescription
SILENTSUITE_SERVER_IMAGEYes--The verified server image digest the installer wrote. Compose has no default and refuses to start without it. Do not edit by hand.
SERVER_PORTNo3735Host loopback port Docker publishes the server on (127.0.0.1:SERVER_PORT). Your reverse proxy forwards traffic here.
DATABASE_PASSWORDYes--Password for the PostgreSQL silentsuite user. Must match the password in the [database] section of etebase-server.ini.
SUPER_USERNoadminUsername for the Django admin panel at https://your-domain/admin/.
SUPER_PASSNo--Password for the Django admin panel; the installer generates one. When both SUPER_USER and SUPER_PASS are set, the container creates that admin login on first start if it does not exist yet. These credentials only open the admin panel; they are not a SilentSuite account you can sign in with from the app.
ETEBASE_DISABLE_SIGNUPNofalsefalse allows new registrations (needed for your first signup). ./close-signups.sh sets it to true.
ETEBASE_BOOTSTRAP_ADMIN_TOKENNoemptyOne-time token the first signup must pass as ?bootstrap_token=... in the server URL while the server has no users. The installer generates it; leaving it empty does not protect the first signup.
ETEBASE_DISABLE_DJANGO_ADMINNotrueHides the Django /admin/ panel. Set to false to enable it; see Admin Dashboard before exposing it.
TRUSTED_PROXY_IPSNo127.0.0.1Comma-separated reverse proxy IPs allowed to set X-Forwarded-* headers. Prefer exact addresses. CIDR subnets are also accepted, but trusting an address or subnet is only safe if nothing except your proxy can reach the server from it. Never use *. The installer writes 127.0.0.1,docker-gateway: docker-gateway is the Docker network gateway a proxy on the host connects from through the 127.0.0.1 port, looked up each time the server starts. Remove it if you publish the port on any other address.
ETEBASE_MAX_AUTH_REQUEST_BYTESNo65536Largest request body, in bytes, accepted for sign-up, login, password change and billing-link requests. Allowed range: 65536 to 1073741824.
ETEBASE_MAX_REQUEST_BYTESNo67108864Largest request body, in bytes, accepted for the app's other sync API requests (collections, items, members and invitations), including sync batches and attachment uploads. Allowed range: 1048576 to 1073741824.

After changing a server runtime setting in .env (ETEBASE_DISABLE_SIGNUP, ETEBASE_BOOTSTRAP_ADMIN_TOKEN, ETEBASE_DISABLE_DJANGO_ADMIN, TRUSTED_PROXY_IPS, ETEBASE_MAX_AUTH_REQUEST_BYTES, ETEBASE_MAX_REQUEST_BYTES, SERVER_PORT), recreate the server container:

bash
docker compose up -d --force-recreate server

Request size limits. The server refuses a request body larger than its limit with HTTP 413 and stops reading it. A limit that is not a whole number within its allowed range stops the server at startup. A 413 can come from three places:

  • An app request that fails with error code request_too_large: raise ETEBASE_MAX_AUTH_REQUEST_BYTES (sign-up, login, password change) or ETEBASE_MAX_REQUEST_BYTES (sync and uploads), then recreate the server container.
  • A billing-link request answered with {"detail": "Request body too large"}: raise ETEBASE_MAX_AUTH_REQUEST_BYTES.
  • A 413 page from your reverse proxy: raise the proxy's own limit, for example client_max_body_size in nginx, to at least the server limit you need.

These settings apply only to the app's sync API listed above. They do not cover the installation-owner login or the Django /admin/ panel. They limit how many bytes the server accepts per request; they do not limit the server's total memory use.

SUPER_USER and SUPER_PASS are creation-only. When both are set, the container creates a Django admin login at startup only if no user with that username exists yet. Editing SUPER_PASS in .env and recreating the container does not change an existing user's password, and choosing a new SUPER_USER creates an additional login without renaming or retiring the existing one. To change an existing admin password, run the reset command against the existing username (replace admin with your actual admin username if it differs):

bash
docker exec -it silentsuite-server python manage.py changepassword admin

See Admin Dashboard for the admin panel itself.

The PostgreSQL values (DATABASE_NAME, DATABASE_USER, DATABASE_PASSWORD) are different. They initialize a fresh database the first time the PostgreSQL volume is created; an existing database keeps its stored name, user, and password regardless of what .env or etebase-server.ini later say. Changing them on an existing installation requires making the corresponding change inside PostgreSQL first, then updating .env and the [database] section of the ini to match. Recreating containers alone does not apply such a change, and the server will fail to start on a mismatched password. Never delete the database volume to apply a configuration change; that destroys every account and sync row.

Advanced Variables ​

These have sensible defaults and rarely need changing:

VariableDefaultDescription
DATABASE_NAMEsilentsuitePostgreSQL database name. Must match name in the [database] section of etebase-server.ini.
DATABASE_USERsilentsuitePostgreSQL username. Must match user in the [database] section of etebase-server.ini.
PROXY_NETWORKunsetRecorded by the installer when you name a Docker reverse-proxy network. The network itself is wired by the generated docker-compose.override.yml.

Host Settings: etebase-server.ini ​

The domain the server accepts and the database connection are read from etebase-server.ini, mounted read-only at /etc/etebase-server/etebase-server.ini inside the container. The installer writes the domain you entered into [allowed_hosts]. There is no ALLOWED_HOSTS or DOMAIN variable in .env; setting one has no effect.

ini
[allowed_hosts]
allowed_host1 = sync.example.com
allowed_host2 = localhost

To change the domain, edit this section (add allowed_hostN = your.domain) and restart the server:

bash
docker compose restart server

Example .env ​

bash
SILENTSUITE_SERVER_IMAGE=ghcr.io/silent-suite/silentsuite-server@sha256:<indexDigest>
SERVER_PORT=3735
TRUSTED_PROXY_IPS=127.0.0.1,docker-gateway
DATABASE_PASSWORD=<generated>
SUPER_USER=admin
SUPER_PASS=<generated>
ETEBASE_DISABLE_SIGNUP=false
ETEBASE_BOOTSTRAP_ADMIN_TOKEN=<generated>
ETEBASE_DISABLE_DJANGO_ADMIN=true

Security ​

The .env file contains secrets. Restrict its permissions:

bash
chmod 600 .env

Never commit .env to version control. It is already listed in .gitignore.

Released under the AGPL-3.0 License.