Skip to content
Chorescore

Environment

Mandatory

NAMEDESCRIPTION
CHORESCORE_BLOG_LINKName of the blog, where the app is explained.
CHORESCORE_BLOG_NAMELink of the blog, where the app is explained.
CHORESCORE_CONTACTDetails of the responsible person, managing the instance.
CHORESCORE_CONTACT_MAILMail of the responsible person.
CHORESCORE_SOURCECODE_HOSTName of the sourcecode host.
CHORESCORE_SOURCECODE_LINKLink to the sourcecode.
CHORESCORE_VERSIONApplication version.
CHORESCORE_REDIS_ADDR-
CHORESCORE_REDIS_PASSWORD-

Optional

NAMEDESCRIPTION
CHORESCORE_INITIAL_ACCESS_TIMEInitial time, when the server is started and users can be created without login required.
CHORESCORE_MASTER_TOKENProvide this as PIN in the local storage, to read everything
CHORESCORE_SERVER_STATUSSet initial server status message via JSON
CHORESCORE_THEME_STATUSSet time based theme JSON
CHORESCORE_TOKENInitial login token
CHORESCORE_UI_RESETDelete the local storage on a client
CHORESCORE_REDIS_RESETWARNING Delete Redis database
CHORESCORE_GIN_MODESet the gin mode
CHORESCORE_LOG_LEVELLog level for the server
CHORESCORE_VERSIONProvide the version of the application
LOG_LEVELLog level for the server

Feature specific

NAMEDESCRIPTIONFeature Name
CHORESCORE_ADMIN_CODEAdmin code, which is created on startupadmin
CHORESCORE_ADMIN_USERAdmin name, which is created on startupadmin
CHORESCORE_API_ENABLEDEnable API keysapi
CHORESCORE_API_KEYMaster API keyapi
CHORESCORE_ASSETS_DIRContainer path, where the ui source is locatedassets
CHORESCORE_BASIC_USERBasic Usercookie+basic_auth
CHORESCORE_BASIC_USER_PWBasic User codecookie+basic_auth
CHORESCORE_CHANGELOGS_DIRContainer path, where the changelog is locatedchangelog
CHORESCORE_COOKIE_SECRETCookie secret for sessionssessions
CHORESCORE_DATA_TEMPLATE_DIRContainer path, where the ui source is locatedtemplate
CHORESCORE_DOCS_DIRContainer path, where the ui source is locateddocs
CHORESCORE_DOCU_LINKLink to the documentation pagedocs
CHORESCORE_DOCU_NAMEName of the documentation pagedocs
CHORESCORE_GITHUB_CLIENT_SECRETGithub client secretoauth2
CHORESCORE_MANUAL_DIRContainer path, where the manual files is locatedmanual
CHORESCORE_MODERATOR_CODEModerator code, which is created on startupmoderator
CHORESCORE_MODERATOR_USERModerator name, which is created on startupmoderator
CHORESCORE_ORIGIN_HOSTHost, without protocolcors
CHORESCORE_ORIGIN_PORTPort, most probably 443cors
CHORESCORE_SALT_KEYEncrypt the user headerexperimental
CHORESCORE_UIS_DIRContainer path, where the ui sources are locatedui

Details can be seen in env.go file.

  ENV_LLEVEL              = "LOG_LEVEL"
  ENV_APPLICATION_VERSION = "CHORESCORE_APPLICATION_VERSION"
  ENV_BLOG_LINK           = "CHORESCORE_BLOG_LINK"
  ENV_BLOG_NAME           = "CHORESCORE_BLOG_NAME"
  ENV_CONTACT             = "CHORESCORE_CONTACT"
  ENV_CONTACT_MAIL        = "CHORESCORE_CONTACT_MAIL"
  ENV_DOCU_LINK           = "CHORESCORE_DOCU_LINK"
  ENV_DOCU_NAME           = "CHORESCORE_DOCU_NAME"
  ENV_GIN_MODE            = "CHORESCORE_GIN_MODE"
  ENV_INITIAL_ACCESS_TIME = "CHORESCORE_INITIAL_ACCESS_TIME"
  ENV_INITIAL_TOKEN       = "CHORESCORE_INITIAL_TOKEN"
  ENV_LOG_LEVEL           = "CHORESCORE_LOG_LEVEL"
  ENV_ORIGIN_HOST         = "CHORESCORE_ORIGIN_HOST"
  ENV_ORIGIN_PORT         = "CHORESCORE_ORIGIN_PORT"
  ENV_PREFIX              = "CHORESCORE"
  ENV_REDIS_ADDR          = "CHORESCORE_REDIS_ADDR"
  ENV_REDIS_PASSWORD      = "CHORESCORE_REDIS_PASSWORD"
  ENV_RESET_REDIS         = "CHORESCORE_REDIS_RESET"
  ENV_SALT_KEY            = "CHORESCORE_SALT_KEY"
  ENV_SERVER_STATUS       = "CHORESCORE_SERVER_STATUS"
  ENV_SOURCE_CODE_LINK    = "CHORESCORE_SOURCECODE_LINK"
  ENV_SOURCE_CODE_NAME    = "CHORESCORE_SOURCECODE_HOST"
  ENV_THEME_STATUS        = "CHORESCORE_THEME_STATUS"
  // api
  ENV_ADMIN_API_KEY = "CHORESCORE_ADMIN_API_KEY"
  // ADMIN
  ENV_ADMIN_CODE = "CHORESCORE_ADMIN_CODE"
  ENV_ADMIN_USER = "CHORESCORE_ADMIN_USER"
  // api_docs
  ENV_API_DOCS_DIR = "CHORESCORE_API_DOCS_DIR"
  // api_developer
  ENV_API_TEMPLATES_DIR = "CHORESCORE_API_TEMPLATES_DIR"
  // assets
  ENV_ASSETS_DIR = "CHORESCORE_ASSETS_DIR"
  // cookie+basic_auth
  ENV_BASIC_USER    = "CHORESCORE_BASIC_USER"
  ENV_BASIC_USER_PW = "CHORESCORE_BASIC_USER_PW"
  // tls
  ENV_CERTS_DIR   = "CHORESCORE_CERTS_DIR"
  ENV_CERTS_NAME  = "CHORESCORE_CERTS_NAME"
  ENV_CERTS_TYPE  = "CHORESCORE_CERTS_TYPE"
  ENV_SECURE_HOST = "CHORESCORE_SECURE_HOST"
  // changelog
  ENV_CHANGELOGS_DIR = "CHORESCORE_CHANGELOGS_DIR"
  // cookie
  ENV_COOKIE_NAME   = "CHORESCORE_COOKIE_NAME"
  ENV_COOKIE_SECRET = "CHORESCORE_COOKIE_SECRET"
  // templates
  ENV_DATA_TEMPLATES_DIR = "CHORESCORE_DATA_TEMPLATES_DIR"
  // docs
  ENV_DOCS_DIR = "CHORESCORE_DOCS_DIR"
  // manual
  ENV_MANUAL_DIR   = "CHORESCORE_MANUAL_DIR"
  ENV_MASTER_TOKEN = "CHORESCORE_MASTER_TOKEN"
  // Moderator
  ENV_MODERATOR_CODE = "CHORESCORE_MODERATOR_CODE"
  ENV_MODERATOR_USER = "CHORESCORE_MODERATOR_USER"
  // oauth2
  ENV_OAUTH2_GITHUB_CLIENT_SECRET = "CHORESCORE_GITHUB_CLIENT_SECRET"
  // api_public
  // true, 1, y, public, ui, yes
  ENV_PUBLIC_API_ENABLED = "CHORESCORE_PUBLIC_API_ENABLED"
  // ui
  ENV_UIS_DIR    = "CHORESCORE_UIS_DIR"
  ENV_UI_API_KEY = "CHORESCORE_UI_API_KEY"
  ENV_UI_RESET   = "CHORESCORE_UI_RESET"


  DEFAULT_TMP_DIR            = "/tmp"
  DEFAULT_BACKEND_STATUS_MSG = "Happy chores!!"
  DEFAULT_CURRENT_VERSION    = "dev-unversioned"


  DEFAULT_GIN_LEVEL      = "release"
  DEFAULT_HTTPS_PROTOCOL = "https://"
  DEFAULT_HTTP_PROTOCOL  = "http://"
  DEFAULT_LOG_LEVEL      = "ERROR"
  DEFAULT_ORIGIN_HOST    = "127.0.0.1"
  DEFAULT_ORIGIN_PORT    = "3000"
  DEFAULT_REDIS_ADDR     = "localhost:6379"
  DEFAULT_SECURE_HOST    = "443"
  DEFAULT_THEME          = "Classic"
  DEFAULT_TITLE_MSG      = "Welcome back!"
  DEFAULT_UNSECURE_HOST  = "80"


  LOG_LEVEL_TRACE LogLevel = "trace"
  LOG_LEVEL_DEBUG LogLevel = "debug"
  LOG_LEVEL_LOG   LogLevel = "log"
  LOG_LEVEL_WARN  LogLevel = "warn"
  LOG_LEVEL_ERROR LogLevel = "error"
  LOG_LEVEL_FATAL LogLevel = "fatal"


  CERT_TYPE_PEM CertType = "pem"
  CERT_TYPE_CRT CertType = "crt"


  HEALTHY    AppState = "HEALTHY"
  UNHEALHTY  AppState = "UNHEALTHY"
  UNCOMPLETE AppState = "UNCOMPLETE"
  SETUP      AppState = "SETUP"