Image Configuration

On this page you will find all configuration options for when you are self-hosting your own ShiraKamiSRS instance.

They are provided through environment variables you set on the ShiraKamiSRS Docker container.

General Configuration

Environment Variable	Description	Value	Example Value	Default
`APP_BASE_URL`	The public base URL on which your instance is available. Should include `http://` or `https://`, and not include the trailing `/`. Required when using features like email verification.	String	https://yourcustomdomain.com
`ENABLE_PASSWORD_RESETS`	When set to `true`, users will be able to reset their own passwords when they have forgotten them, via a link sent to their email. When enabling this, the following is required: - A configured SMTP server (See Configuring SMTP) OR `SMTP_SUPPRESS` set to `true` (In which case the reset links will only be logged) - A properly configured `APP_BASE_URL`	Boolean		false

Environment Variable	Description	Value	Example Value	Default
`JWT_SECRET`	The secret used for all authentication tokens. Should be set to a secret random string unique for your instance. In case authentication tokens leak out, you will want to change this.	String	RvpaCCOX85MBtfcPuUCw	CHANGEME
`JWT_ACCESS_EXPIRY`	The timeframe in seconds after which access tokens will expire. This one is to be kept relatively short. Defaults to 1 day.	Number (Seconds)		86400
`JWT_REFRESH_EXPIRY`	The timeframe in seconds after which refresh tokens will expire. These tokens are used to obtain new access tokens when they expire, so the user does not have to log back in very often. Defaults to 30 days.	Number (Seconds)		2592000
`EMAIL_VERIFICATION`	When set to `true`, newly registered users will have to activate their accounts using a link sent by email, before they are able to log in. When enabling this, the following is required: - A configured SMTP server (See Configuring SMTP) OR `SMTP_SUPPRESS` set to `true` (In which case the verification links will only be logged) - A properly configured `APP_BASE_URL`	Boolean		false
`ENABLE_CORS`	Whether to allow cross-origin resource sharing. Unless you know what you are doing, best to leave this disabled.	Boolean		false

Environment Variable	Description	Value	Default
`MYSQL_HOST`	The hostname, address or IP on which ShiraKamiSRS can access your MariaDB instance.	String	localhost
`MYSQL_PORT`	The port on which ShiraKamiSRS can access your MariaDB instance.	Number	3306
`MYSQL_USER`	The username ShiraKamiSRS uses to authenticate with your MariaDB instance.	String	shirakami
`MYSQL_PASSWORD`	The password ShiraKamiSRS uses to authenticate with your MariaDB instance.	String	shirakami
`MYSQL_DB`	The name of the database ShiraKamiSRS will use.	String	shirakami

Environment Variable	Description	Value	Example Value	Default
`SMTP_FROM_ADDRESS`	The address from which emails will be sent	String	mail@example.com
`SMTP_FROM_NAME`	The name of the sender	String	My ShiraKamiSRS Instance
`SMTP_HOST`	The hostname/address of the SMTP server	String	smtp.yourprovider.tld
`SMTP_USER`	The username to use for authentication	String	mail@example.com
`SMTP_PASSWORD`	The password to use for authentication	String	hunter2
`SMTP_PORT`	The port the SMTP server runs on	Integer		587
`SMTP_SECURE`	Whether to enable SSL/TLS	Boolean	true	false
`SMTP_SUPPRESS`	When set to `true`, ShiraKamiSRS will not send any emails, but still allow e-mail related functionality to be enabled. The relevant information which would otherwise be emailed is still logged to the console.	Boolean		false

Environment Variable	Description	Value	Example Value	Default
`TYPEORM_LOGGING`	When set to `true`, all TypeORM related logging is logged to the console. Useful in development, otherwise best left disabled.	Boolean		false
`APP_SERVE_HTTP`	Allows you to disable the internal webserver serving the web application. Useful in development, otherwise best left enabled.	Boolean		true