Skip to content

Configuration Cheat Sheet

YAML Config KeyEnvironment VariableDefault valueDescription
log-levelOG_LOG_LEVELwarnSet the log level to one of the following: debug, info, warn, error, fatal.
log-outputOG_LOG_OUTPUTstdout,fileSet the log output to one or more of the following: stdout, file.
external-urlOG_EXTERNAL_URLnonePublic URL to access to Opengist.
opengist-homeOG_OPENGIST_HOMEhome directoryPath to the directory where Opengist stores its data.
db-filenameOG_DB_FILENAMEopengist.dbName of the SQLite database file.
index.enabledOG_INDEX_ENABLEDtrueEnable or disable the code search index (true or false)
index.dirnameOG_INDEX_DIRNAMEopengist.indexName of the directory where the code search index is stored.
git.default-branchOG_GIT_DEFAULT_BRANCHnoneDefault branch name used by Opengist when initializing Git repositories. If not set, uses the Git default branch name. More info here
sqlite.journal-modeOG_SQLITE_JOURNAL_MODEWALSet the journal mode for SQLite. More info here
http.hostOG_HTTP_HOST0.0.0.0The host on which the HTTP server should bind.
http.portOG_HTTP_PORT6157The port on which the HTTP server should listen.
http.git-enabledOG_HTTP_GIT_ENABLEDtrueEnable or disable git operations (clone, pull, push) via HTTP. (true or false)
ssh.git-enabledOG_SSH_GIT_ENABLEDtrueEnable or disable git operations (clone, pull, push) via SSH. (true or false)
ssh.hostOG_SSH_HOST0.0.0.0The host on which the SSH server should bind.
ssh.portOG_SSH_PORT2222The port on which the SSH server should listen.
ssh.external-domainOG_SSH_EXTERNAL_DOMAINnonePublic domain for the Git SSH connection, if it has to be different from the HTTP one. If not set, uses the URL from the request.
ssh.keygen-executableOG_SSH_KEYGEN_EXECUTABLEssh-keygenPath to the SSH key generation executable.
github.client-keyOG_GITHUB_CLIENT_KEYnoneThe client key for the GitHub OAuth application.
github.secretOG_GITHUB_SECRETnoneThe secret for the GitHub OAuth application.
gitlab.client-keyOG_GITLAB_CLIENT_KEYnoneThe client key for the GitLab OAuth application.
gitlab.secretOG_GITLAB_SECRETnoneThe secret for the GitLab OAuth application.
gitlab.urlOG_GITLAB_URLhttps://gitlab.com/The URL of the GitLab instance.
gitlab.nameOG_GITLAB_NAMEGitLabThe name of the GitLab instance. It is displayed in the OAuth login button.
gitea.client-keyOG_GITEA_CLIENT_KEYnoneThe client key for the Gitea OAuth application.
gitea.secretOG_GITEA_SECRETnoneThe secret for the Gitea OAuth application.
gitea.urlOG_GITEA_URLhttps://gitea.com/The URL of the Gitea instance.
gitea.nameOG_GITEA_NAMEGiteaThe name of the Gitea instance. It is displayed in the OAuth login button.
oidc.client-keyOG_OIDC_CLIENT_KEYnoneThe client key for the OpenID application.
oidc.secretOG_OIDC_SECRETnoneThe secret for the OpenID application.
oidc.discovery-urlOG_OIDC_DISCOVERY_URLnoneDiscovery endpoint of the OpenID provider.
custom.logoOG_CUSTOM_LOGOnonePath to an image, relative to $opengist-home/custom.
custom.faviconOG_CUSTOM_FAVICONnonePath to an image, relative to $opengist-home/custom.
custom.static-linksOG_CUSTOM_STATIC_LINK_#_(PATH,NAME)nonePath and name to custom links, more info here.