Skip to main content
Version: 5.2.3

Environment Variables

The .env File​

You can set the correct values as per the following options. Once you set the values, you should rename the file to .env before you start the server.

Configure HTTPS (SSL)​

Due to Apple's mandatory requirement of mandatory HTTPS for online deployment and download services, d ownloading applications will be forced to go HTTPS protocol when redeploying.

If the deployment is a standalone service on a single machine, it is recommended to enable Let's Encrypt free SSL certificate:

ZEALOT_CERT_EMAIL=zealot@example.com

The following self-signed certificate file name, can not be set at the same time

If the deployed machine can only use self-signed certificates, they need to be configured, but note that iOS downloads require the iOS device to authorize the self-signed certificate before the download and installation is allowed. (Not recommended)

ZEALOT_CERT=zealot.test.pem
ZEALOT_CERT_KEY=zealot.test-key.pem

Configure URL (Domain)​

Must be configured otherwise downloaded applications and some static resources will not be accessed correctly

# No need http:// or https://
ZEALOT_DOMAIN=zealot.com

Database configuration​

If you have reusable postgresql and redis services, you can also customize the configuration to use them instead of using the services configured by default with docker-compose.

Postgresql​

ZEALOT_POSTGRES_HOST=127.0.0.1
ZEALOT_POSTGRES_PORT=5432
ZEALOT_POSTGRES_USERNAME=postgres
ZEALOT_POSTGRES_PASSWORD=ze@l0t
ZEALOT_POSTGRES_DB_NAME=zealot

Redis​

This is a URL connection mainly for most cloud services compatibility

REDIS_URL=redis://user:pass@127.0.0.1:6379/0

# Redis over SSL
REDIS_URL=rediss://user:pass@127.0.0.1:6379/0

Configure default language​

PacksValue
zh-CNSimplified Chinese (default)
enEnglish
DEFAULT_LOCALE=en

Configure default appearance​

AppearanceValue
lightLight mode(default)
darkDark mode
autoSystem auto
ZEALOT_APPEARANCE=dark

Configure default Administer​

The default does not configure the following will also generate the following account and password as an account with administrator privileges, it is recommended to change the password again after configuration.

ZEALOT_ADMIN_EMAIL=admin@zealot.com
ZEALOT_ADMIN_PASSWORD=ze@l0t

Enable new user registration​

After closing the registration, the administrator can add users manually through the user management in the administration panel.

# Open registration
ZEALOT_REGISTER_ENABLED=true

# Close registration
ZEALOT_REGISTER_ENABLED=false

Enable guest mode​

Enable the visitor mode to allow the application to view, download and install, it is recommended that the company internal reliance on permissions is not high condition to use, specific permission comparison can see here for details

# Guest mode is ON
ZEALOT_GUEST_MODE=true

# Guest mode is OFF
ZEALOT_GUEST_MODE=false

Configure emails​

Currently, only smtp is supported to configure email notification service. Email notification mainly affects are user registration, sending activation emails and changing password service, but it does not affect the use if it is not turned on.

# SMTP settings
SMTP_ADDRESS=smtp.gmail.com
SMTP_PORT=587
SMTP_DOMAIN=gmail.com
SMTP_USERNAME=you@gmail.com
SMTP_PASSWORD=yourpassword
SMTP_AUTH_METHOD=plain
SMTP_ENABLE_STARTTLS_AUTO=true

# Sender and email address by default
ACTION_MAILER_DEFAULT_FROM=you@gmail.com
ACTION_MAILER_DEFAULT_TO=you@gmail.com

Disbale Cable request protection​

Experimental:

ZEALOT_DISABLE_CABLE_REQUEST_PROTECTION=true