Skip to main content
Version: Next

Configuration

Currently, the only way to change most settings in SheetAble is through the env variables.

How to change environment variables#

Change vars in Docker#

To change the env variables in Docker you just have to customize your running command by adding a -e SETTING="SETTING_VALUE" to it.

Change vars natively#

You can also change env variables natively.

  • Either you add a .env file in the running directory (recommended)
    • The file should look like this:
    SETTING=SETTING_VALUENEXT_SETTING=NEXT_SETTING_VALUE
  • You export the env var on your OS
    • Windows:
      • C:\> SET SETTING="SETTING_VALUE"
    • Unix based systems (Mac, Linux):
      • export SETTING=SETTING_VALUE

Available Settings#

SettingExplanation
API_SECRETThis can be any string you want with which your jwt key is going to be encrypted
DB_DRIVERmysql, postgres, sqlite
DB_HOSTUse mysql or postgres? Enter IP here.
DB_USERUse mysql or postgres? Enter db username here.
DB_PASSWORDUse mysql or postgres? Enter db password here.
DB_NAMEUse mysql or postgres? Enter db name here.
DB_PORTUse mysql or postgres? Enter db port here.
ADMIN_EMAILYour admin email
ADMIN_PASSWORDYour admin password
PORT8080 - Can be any port you want
DEV0, 1 - if 1: activated dev mode for developing purposes
CONFIG_PATHPath where you want your data to be instead of in the root dir

Get sample .env file here