Gitea

`services.gitea.appName`

Application name. Type: string

Default

"gitea: Gitea Service"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.camoHmacKeyFile`

Path to a file containing the camo HMAC key. Type: null or string

Default

null

Example

"/var/lib/secrets/gitea/camoHmacKey"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.customDir`

Gitea custom directory. Used for config, custom templates and other options. Type: string

Default

"${config.services.gitea.stateDir}/custom"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.database.createDatabase`

Whether to create a local database automatically. Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.database.host`

Database host address. Type: string

Default

"127.0.0.1"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.database.name`

Database name. Type: string

Default

"gitea"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.database.password`

The password corresponding to {option}database.user. Warning: this is stored in cleartext in the Nix store! Use {option}database.passwordFile instead.

Type: string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.database.passwordFile`

A file containing the password corresponding to {option}database.user.

Type: null or path

Default

null

Example

"/run/keys/gitea-dbpassword"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.database.path`

Path to the sqlite3 database file. Type: string

Default

"${config.services.gitea.stateDir}/data/gitea.db"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.database.port`

Database host port. Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

if config.services.gitea.database.type != "postgresql"then 3306else 5432

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.database.socket`

Path to the unix socket file to use for authentication. Type: null or path

Default

null

Example

"/run/mysqld/mysqld.sock"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.database.type`

Database engine to use. Type: one of "sqlite3", "mysql", "postgres"

Default

"sqlite3"

Example

"mysql"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.database.user`

Database user. Type: string

Default

"gitea"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.dump.backupDir`

Path to the dump files. Type: string

Default

"${config.services.gitea.stateDir}/dump"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.dump.enable`

Enable a timer that runs gitea dump to generate backup-files of the current gitea database and repositories.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.dump.file`

Filename to be used for the dump. If null a default name is chosen by gitea. Type: null or string

Default

null

Example

"gitea-dump"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.dump.interval`

Run a gitea dump at this interval. Runs by default at 04:31 every day.

The format is described in {manpage}systemd.time(7).

Type: string

Default

"04:31"

Example

"hourly"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.dump.type`

Archive format used to store the dump file. Type: one of "zip", "rar", "tar", "sz", "tar.gz", "tar.xz", "tar.bz2", "tar.br", "tar.lz4", "tar.zst"

Default

"zip"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.enable`

Enable Gitea Service. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.extraConfig`

Configuration lines appended to the generated gitea configuration file. Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.group`

Group under which gitea runs. Type: string

Default

"gitea"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.lfs.contentDir`

Where to store LFS files. Type: string

Default

"${config.services.gitea.stateDir}/data/lfs"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.lfs.enable`

Enables git-lfs support. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.mailerPasswordFile`

Path to a file containing the SMTP password. Type: null or string

Default

null

Example

"/var/lib/secrets/gitea/mailpw"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.metricsTokenFile`

Path to a file containing the metrics authentication token. Type: null or string

Default

null

Example

"/var/lib/secrets/gitea/metrics_token"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.package`

The gitea package to use. Type: package

Default

pkgs.gitea

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.repositoryRoot`

Path to the git repositories. Type: string

Default

"${config.services.gitea.stateDir}/repositories"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.settings`

Gitea configuration. Refer to https://docs.gitea.io/en-us/config-cheat-sheet/ for details on supported values.

Type: attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Default

{ }

Example

{"cron.sync_external_users" = {RUN_AT_START = true;SCHEDULE = "@every 24h";UPDATE_EXISTING = true;};mailer = {ENABLED = true;MAILER_TYPE = "sendmail";FROM = "do-not-reply@example.org";SENDMAIL_PATH = "${pkgs.system-sendmail}/bin/sendmail";};other = {SHOW_FOOTER_VERSION = false;};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.settings.log.LEVEL`

General log level. Type: one of "Trace", "Debug", "Info", "Warn", "Error", "Critical"

Default

"Info"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.settings.log.ROOT_PATH`

Root path for log files. Type: string

Default

"${config.services.gitea.stateDir}/log"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.settings.server.DISABLE_SSH`

Disable external SSH feature. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.settings.server.DOMAIN`

Domain name of your server. Type: string

Default

"localhost"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.settings.server.HTTP_ADDR`

Listen address. Must be a path when using a unix socket. Type: string or path

Default

if lib.hasSuffix "+unix" cfg.settings.server.PROTOCOL then "/run/gitea/gitea.sock" else "0.0.0.0"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.settings.server.HTTP_PORT`

Listen port. Ignored when using a unix socket. Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

3000

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.settings.server.PROTOCOL`

Listen protocol. +unix means "over unix", not "in addition to." Type: one of "http", "https", "fcgi", "http+unix", "fcgi+unix"

Default

"http"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.settings.server.ROOT_URL`

Full public URL of gitea server. Type: string

Default

"http://${config.services.gitea.settings.server.DOMAIN}:${toString config.services.gitea.settings.server.HTTP_PORT}/"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.settings.server.SSH_PORT`

SSH port displayed in clone URL. The option is required to configure a service when the external visible port differs from the local listening port i.e. if port forwarding is used.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

22

Example

2222

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.settings.server.STATIC_ROOT_PATH`

Upper level of template and static files path. Type: string or path

Default

config.services.gitea.package.data

Example

"/var/lib/gitea/data"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gitea.nix

`services.gitea.settings.service.DISABLE_REGISTRATION`

By default any user can create an account on this gitea instance. This can be disabled by using this option.

Note: please keep in mind that this should be added after the initial deploy unless is true as the first registered user will be the administrator if no install wizard is used.

Type: boolean