opengist/config.yml

# Learn more about Opengist configuration here:
# https://github.com/thomiceli/opengist/blob/master/docs/configuration/configure.md
# https://github.com/thomiceli/opengist/blob/master/docs/configuration/cheat-sheet.md

# Set the log level to one of the following: debug, info, warn, error, fatal. Default: warn
log-level: warn

# Set the log output to one or more of the following: `stdout`, `file`. Default: stdout,file
log-output: stdout,file

# Public URL to access to Opengist
external-url:

# Directory where Opengist will store its data. Default: ~/.opengist/
opengist-home:

# Secret key used for session store & encrypt MFA data on database. Default: <randomized 32 bytes>
secret-key:

# URI of the database. Default: opengist.db (SQLite) is placed in opengist-home
# SQLite:        file:/path/to/database
# PostgreSQL:    postgres://user:password@host:port/database
# MySQL/MariaDB: mysql://user:password@host:port/database
db-uri: opengist.db

# Define the code indexer (either `bleve`, `meilisearch`, or empty for no index). Default: bleve
index: bleve

# Set the host for the Meiliseach server
index.meili.host:

# Set the API key for the Meiliseach server
index.meili.api-key:

# Set the default search fields. Can contain multiple fields (e.g., `content,username`).
# Fields: content,user,title,description,filename,extension,language,topic. Default: content
search.default: content

# Default branch name used by Opengist when initializing Git repositories.
# If not set, uses the Git default branch name. See https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup#_new_default_branch
git.default-branch:

# Set the journal mode for SQLite. Default: WAL
# See https://www.sqlite.org/pragma.html#pragma_journal_mode
# For SQLite databases only.
sqlite.journal-mode: WAL

# HTTP server configuration
# Host to bind to. Default: 0.0.0.0
# Use an IP address for network binding. Use a path for Unix socket binding (e.g. /run/opengist.sock)
http.host: 0.0.0.0

# Port to bind to. Default: 6157
http.port: 6157

# Enable or disable git operations (clone, pull, push) via HTTP (either `true` or `false`). Default: true
http.git-enabled: true

# Enable or disable the REST API (either `true` or `false`). Default: true
api.enabled: true

# Disable file uploads when creating or editing gists (either `true` or `false`). Default: false
disable-file-upload: false

# File permissions for Unix socket (octal format). Default: 0666
unix-socket-permissions: 0666

# Enable or disable the Prometheus metrics server (either `true` or `false`). Default: false
metrics.enabled: false

# The host on which the metrics server should bind. Default: 0.0.0.0
metrics.host: 0.0.0.0

# The port on which the metrics server should listen. Default: 6158
metrics.port: 6158

# SSH built-in server configuration

# Enable or disable and specify which SSH server serves git over SSH (either `builtin`, `host`, or `disabled` (no SSH git access).
# Default: builtin
ssh.git-enabled: builtin

# Host to bind to. Default: 0.0.0.0
# This is for builtin SSH server only.
ssh.host: 0.0.0.0

# Default: 2222
# For the builtin server, this is the port it binds to.
#   Note: it cannot be the same port as the SSH daemon if it's currently running.
#   If you want to use port 22 for the built-in server, change the SSH daemon's port or stop it.
# For `host` mode, this is only used to build the SSH clone URLs (set it to your OpenSSH port, usually 22).
ssh.port: 2222

# Username shown in SSH clone URLs (e.g. `gist` → `gist@host:user/repo.git`).
# For `host` mode set it to the OS account clients log in as. If empty, URLs carry no username.
ssh.username:

# Public 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.external-domain:

# Path to an `authorized_keys` file Opengist keeps in sync with users' keys (e.g. `/home/gist/.ssh/authorized_keys`),
# used when `ssh.git-enabled` is `host`,
# Leave empty to use OpenSSH's `AuthorizedKeysCommand` instead.
ssh.authorized-keys-file:

# OAuth2 configuration
# The callback/redirect URL must be http://opengist.url/oauth/<github|gitlab|gitea|openid-connect>/callback

# To create a new OAuth2 application using GitHub : https://github.com/settings/applications/new
github.client-key:
github.secret:

# To create a new OAuth2 application using Gitlab : https://gitlab.com/-/user_settings/applications
gitlab.client-key:
gitlab.secret:
# URL of the Gitlab instance. Default: https://gitlab.com/
gitlab.url: https://gitlab.com/
# The name of the GitLab instance. It is displayed in the OAuth login button. Default: GitLab
gitlab.name: GitLab

# To create a new OAuth2 application using Gitea : https://gitea.domain/user/settings/applications
gitea.client-key:
gitea.secret:
# URL of the Gitea instance. Default: https://gitea.com/
gitea.url: https://gitea.com/
# The name of the Gitea instance. It is displayed in the OAuth login button. Default: Gitea
gitea.name: Gitea

# To create a new OAuth2 application using OpenID Connect:
oidc.provider-name:
oidc.client-key:
oidc.secret:
# Discovery endpoint of the OpenID provider. Generally something like http://auth.example.com/.well-known/openid-configuration
oidc.discovery-url:
# The name of the claim containing the groups
oidc.group-claim-name:
# The name of the group that should receive admin rights
oidc.admin-group:

# LDAP authentication configuration
# URL of the LDAP instance e.g: ldap://ldap.example.com:389 ; if not set, LDAP authentication is disabled
ldap.url:
# Bind DN to authenticate against the LDAP e.g: cn=read-only-admin,dc=example,dc=com
ldap.bind-dn:
# The password for the Bind DN.
ldap.bind-credentials:
# The Base DN to start search from e.g: ou=People,dc=example,dc=com
ldap.search-base:
# The filter to search against (the format string %s will be replaced with the username) e.g: (uid=%s)
ldap.search-filter:

# Instance name
# Set your own custom name to be displayed instead of 'Opengist'
custom.name:

# Custom assets
# Add your own custom assets, that are files relatives to $opengist-home/custom/
custom.logo:
custom.favicon:

# Static pages in footer (like legal notices, privacy policy, etc.)
# The path can be a URL or a relative path to a file in the $opengist-home/custom/ directory
custom.static-links:
#  - name: Gitea
#    path: https://gitea.com
#  - name: Legal notices
#    path: legal.html