.env¶
The .env
file will be used to specify the components used by the Seafile-docker instance and the environment variables required by each component. The default contents list in below
COMPOSE_FILE='seafile-server.yml,caddy.yml'
COMPOSE_PATH_SEPARATOR=','
SEAFILE_IMAGE=seafileltd/seafile-pro-mc:12.0-latest
SEAFILE_DB_IMAGE=mariadb:10.11
SEAFILE_MEMCACHED_IMAGE=memcached:1.6.29
SEAFILE_ELASTICSEARCH_IMAGE=elasticsearch:8.15.0 # pro edition only
SEAFILE_CADDY_IMAGE=lucaslorentz/caddy-docker-proxy:2.9
SEAFILE_VOLUME=/opt/seafile-data
SEAFILE_MYSQL_VOLUME=/opt/seafile-mysql/db
SEAFILE_ELASTICSEARCH_VOLUME=/opt/seafile-elasticsearch/data # pro edition only
SEAFILE_CADDY_VOLUME=/opt/seafile-caddy
SEAFILE_MYSQL_DB_HOST=db
INIT_SEAFILE_MYSQL_ROOT_PASSWORD=ROOT_PASSWORD
SEAFILE_MYSQL_DB_USER=seafile
SEAFILE_MYSQL_DB_PASSWORD=PASSWORD
SEAFILE_MYSQL_DB_SEAFILE_DB_NAME=seafile_db
SEAFILE_MYSQL_DB_CCNET_DB_NAME=ccnet_db
SEAFILE_MYSQL_DB_SEAHUB_DB_NAME=seahub_db
TIME_ZONE=Etc/UTC
JWT_PRIVATE_KEY=
SEAFILE_SERVER_HOSTNAME=seafile.example.com
SEAFILE_SERVER_PROTOCOL=https
INIT_SEAFILE_ADMIN_EMAIL=me@example.com
INIT_SEAFILE_ADMIN_PASSWORD=asecret
INIT_S3_STORAGE_BACKEND_CONFIG=false # pro edition only
INIT_S3_COMMIT_BUCKET=<your-commit-objects> # pro edition only
INIT_S3_FS_BUCKET=<your-fs-objects> # pro edition only
INIT_S3_BLOCK_BUCKET=<your-block-objects> # pro edition only
INIT_S3_KEY_ID=<your-key-id> # pro edition only
INIT_S3_SECRET_KEY=<your-secret-key> # pro edition only
CLUSTER_INIT_MODE=true # cluster only
CLUSTER_INIT_MEMCACHED_HOST=<your memcached host> # cluster only
CLUSTER_INIT_ES_HOST=<your elasticsearch server HOST> # cluster only
CLUSTER_INIT_ES_PORT=9200 # cluster only
CLUSTER_MODE=frontend # cluster only
SEADOC_IMAGE=seafileltd/sdoc-server:1.0-latest
SEADOC_VOLUME=/opt/seadoc-data
ENABLE_SEADOC=false
SEADOC_SERVER_URL=http://seafile.example.com/sdoc-server
NOTIFICATION_SERVER_IMAGE=seafileltd/notification-server:12.0-latest
NOTIFICATION_SERVER_VOLUME=/opt/notification-data
Seafile-docker configurations¶
Components configurations¶
COMPOSE_FILE
:.yml
files for components of Seafile-docker, each.yml
must be separated by the symbol defined inCOMPOSE_PATH_SEPARATOR
. The core components are involved inseafile-server.yml
andcaddy.yml
which must be taken in this term.COMPOSE_PATH_SEPARATOR
: The symbol used to separate the.yml
files in termCOMPOSE_FILE
, default is ','.
Docker images configurations¶
SEAFILE_IMAGE
: The image of Seafile-server, default isseafileltd/seafile-pro-mc:12.0-latest
.SEAFILE_DB_IMAGE
: Database server image, default ismariadb:10.11
.SEAFILE_MEMCACHED_IMAGE
: Cached server image, default ismemcached:1.6.29
SEAFILE_ELASTICSEARCH_IMAGE
: Only valid in pro edition. The elasticsearch image, default iselasticsearch:8.15.0
.SEAFILE_CADDY_IMAGE
: Caddy server image, default islucaslorentz/caddy-docker-proxy:2.9
.SEADOC_IMAGE
: Only valid after integrating SeaDoc. SeaDoc server image, default isseafileltd/sdoc-server:1.0-latest
.
Persistent Volume Configurations¶
SEAFILE_VOLUME
: The volume directory of Seafile data, default is/opt/seafile-data
.SEAFILE_MYSQL_VOLUME
: The volume directory of MySQL data, default is/opt/seafile-mysql/db
.SEAFILE_CADDY_VOLUME
: The volume directory of Caddy data used to store certificates obtained from Let's Encrypt's, default is/opt/seafile-caddy
.SEAFILE_ELASTICSEARCH_VOLUME
: Only valid in pro edition. The volume directory of Elasticsearch data, default is/opt/seafile-elasticsearch/data
.SEADOC_VOLUME
: Only valid after integrating SeaDoc. The volume directory of SeaDoc server data, default is/opt/seadoc-data
.
MySQL configurations¶
SEAFILE_MYSQL_DB_HOST
: The host address of Mysql, default is the pre-defined service namedb
in Seafile-docker instance.INIT_SEAFILE_MYSQL_ROOT_PASSWORD
: (Only required on first deployment) Theroot
password of MySQL.SEAFILE_MYSQL_DB_USER
: The user of MySQL (database
-user
can be found inconf/seafile.conf
).SEAFILE_MYSQL_DB_PASSWORD
: The userseafile
password of MySQL.SEAFILE_MYSQL_DB_SEAFILE_DB_NAME
: The name of Seafile database name, default isseafile_db
SEAFILE_MYSQL_DB_CCNET_DB_NAME
: The name of ccnet database name, default isccnet_db
SEAFILE_MYSQL_DB_SEAHUB_DB_NAME
: The name of seahub database name, default isseahub_db
Seafile-server configurations¶
SEAFILE_MYSQL_DB_PASSWORD
: The userseafile
password of MySQLJWT
: JWT_PRIVATE_KEY, A random string with a length of no less than 32 characters, generate example:pwgen -s 40 1
SEAFILE_SERVER_HOSTNAME
: Seafile server hostname or domainSEAFILE_SERVER_PROTOCOL
: Seafile server protocol (http or https)TIME_ZONE
: Time zone (default UTC)INIT_SEAFILE_ADMIN_EMAIL
: Admin usernameINIT_SEAFILE_ADMIN_PASSWORD
: Admin password
SeaDoc configurations (only valid after integrating SeaDoc)¶
ENABLE_SEADOC
: Enable the SeaDoc server or not, default isfalse
.SEADOC_SERVER_URL
: Only valid inENABLE_SEADOC=true
. Url of Seadoc server (e.g., http://seafile.example.com/sdoc-server).
Cluster init configuration¶
CLUSTER_INIT_MODE
: (only valid in pro edition at deploying first time). Cluster initialization mode, in which the necessary configuration files for the service to run will be generated (but the service will not be started). If the configuration file already exists, no operation will be performed. The default value istrue
. When the configuration file is generated, be sure to set this item tofalse
.CLUSTER_INIT_MEMCACHED_HOST
: (only valid in pro edition at deploying first time). Cluster Memcached host. (If your Memcached server dose not use port11211
, please modify the seahub_settings.py and seafile.conf).CLUSTER_INIT_ES_HOST
: (only valid in pro edition at deploying first time). Your cluster Elasticsearch server host.CLUSTER_INIT_ES_PORT
: (only valid in pro edition at deploying first time). Your cluster Elasticsearch server port. Default is9200
.CLUSTER_MODE
: Seafile service node type, i.e.,frontend
(default) orbackend
S3 storage backend configurations (only valid in pro edition at deploying first time)¶
INIT_S3_STORAGE_BACKEND_CONFIG
: Whether to configure S3 storage backend synchronously during initialization (i.e., the following features in this section, for more details, please refer to AWS S3), default isfalse
.INIT_S3_COMMIT_BUCKET
: S3 storage backend fs objects bucketINIT_S3_FS_BUCKET
: S3 storage backend block objects bucketINIT_S3_BLOCK_BUCKET
: S3 storage backend block objects bucketINIT_S3_KEY_ID
: S3 storage backend key IDINIT_S3_SECRET_KEY
: S3 storage backend secret keyINIT_S3_USE_V4_SIGNATURE
: Use the v4 protocol of S3 if enabled, default istrue
INIT_S3_AWS_REGION
: Region of your buckets (AWS only), default isus-east-1
. (Only valid whenINIT_S3_USE_V4_SIGNATURE
sets totrue
)INIT_S3_HOST
: Host of your buckets, default iss3.us-east-1.amazonaws.com
. (Only valid whenINIT_S3_USE_V4_SIGNATURE
sets totrue
)INIT_S3_USE_HTTPS
: Use HTTPS connections to S3 if enabled, default istrue