Configuration

You can configure the application through the environment variables outlined below:

Variable Name	Type	Description	Required
LICENSE_KEY	string	Application license key	Yes
DOCKER_REGISTRY_USERNAME	string	Username to access the docker registry	Yes
DOCKER_REGISTRY_SECRET	string	Secret to access docker registry	Yes
LOG_DIR	string	Directory to store logs	Yes
SESSION_SECRET	string	Secret for session/cookie creation. You can use openssl rand -hex 32 to generate a random secret	Yes
DOMAIN_NAME	string	The domain name the site is hosted on. This ensures nginx and URLs in the application point to the correct place	Yes
SERVER_HOSTNAME	string	Used for internal communication within the application. Best to leave to the default value.	Yes
API_HOSTNAME	string	Used for internal communication within the application. Best to leave to the default value.	Yes
PREVIEW_SERVER_HOSTNAME	string	Used for internal communication within the application. Best to leave to the default value.	Yes
REDIS_SESSIONS_HOSTNAME	string	Redis instance for storing user sessions. Leave default if using the bundled redis application.	Yes
REDIS_SESSIONS_PORT	number	The port session redis instance is running on	Yes
REDIS_CACHE_HOSTNAME	string	Redis instance for cache purposes. Leave default if using the bundled redis application.	Yes
REDIS_CACHE_PORT	number	The port cache redis instance is running on	Yes
MYSQL_HOSTNAME	string	Mysql instance. Leave default is using bundled mysql instance.	Yes
MYSQL_PORT	number	Port for the mysql instance. Leave default is using bundled mysql instance.	Yes
MYSQL_DATABASE	string	Which database name to use for the application within the mysql instance	Yes
MYSQL_USER	string	Which mysql user to use	Yes
MYSQL_PASSWORD	string	Password for the mysql user	Yes
MYSQL_ROOT_PASSWORD	string	Password for the root user, only needed if you are setting up the bundled instance and want to set the root password	No
MYSQL_DATA_DIR	string	The directory where the mysql data will be stored	Yes
MYSQL_CONF_FILE	string	Path pointing to an appropriate mysql.cnf file	Yes
GRANT_ORIGIN	string	The origin you want to use for Grant to authenticate users and let them sign in	No
GRANT_GITHUB_KEY	string	The key to setup Github-based OAuth. Read more here	No
GRANT_GITHUB_SECRET	string	Github OAuth Secret	No
GRANT_GOOGLE_KEY	string	The key to setup Github-based OAuth. Read more here	No
GRANT_GOOGLE_SECRET	string	Google OAuth Secret	No
NGINX_WORKER_PROCESSES	string / number	How many worker processes to use for nginx, default auto. Read more here	Yes
NGINX_WORKER_CONNECTIONS	number	Set max connections per nginx worker. Read more here	Yes
DISABLE_ACCOUNTS	boolean	Disable the account feature entirely.	No
MINIMAL_INTERFACE	boolean	Remove superfluous links and buttons from the UI. Notably removes all links and buttons from the header.	No
DISABLE_SAVE_AND_SHARE	boolean	Disable the Save and Share feature in the application.	No