2021-12-19 01:06:50 +00:00
|
|
|
{ config, lib, options, pkgs, ... }:
|
2020-04-24 23:36:52 +00:00
|
|
|
|
|
|
|
with lib;
|
|
|
|
|
|
|
|
let
|
|
|
|
cfg = config.services.gitea;
|
2021-12-19 01:06:50 +00:00
|
|
|
opt = options.services.gitea;
|
2023-03-04 12:14:45 +00:00
|
|
|
exe = lib.getExe cfg.package;
|
2020-04-24 23:36:52 +00:00
|
|
|
pg = config.services.postgresql;
|
|
|
|
useMysql = cfg.database.type == "mysql";
|
|
|
|
usePostgresql = cfg.database.type == "postgres";
|
|
|
|
useSqlite = cfg.database.type == "sqlite3";
|
2022-08-21 13:32:41 +00:00
|
|
|
format = pkgs.formats.ini { };
|
2020-04-24 23:36:52 +00:00
|
|
|
configFile = pkgs.writeText "app.ini" ''
|
|
|
|
APP_NAME = ${cfg.appName}
|
|
|
|
RUN_USER = ${cfg.user}
|
|
|
|
RUN_MODE = prod
|
2023-08-04 22:07:22 +00:00
|
|
|
WORK_PATH = ${cfg.stateDir}
|
2020-04-24 23:36:52 +00:00
|
|
|
|
2020-05-15 21:57:56 +00:00
|
|
|
${generators.toINI {} cfg.settings}
|
|
|
|
|
|
|
|
${optionalString (cfg.extraConfig != null) cfg.extraConfig}
|
2020-04-24 23:36:52 +00:00
|
|
|
'';
|
|
|
|
in
|
|
|
|
|
|
|
|
{
|
2022-08-21 13:32:41 +00:00
|
|
|
imports = [
|
|
|
|
(mkRenamedOptionModule [ "services" "gitea" "cookieSecure" ] [ "services" "gitea" "settings" "session" "COOKIE_SECURE" ])
|
|
|
|
(mkRenamedOptionModule [ "services" "gitea" "disableRegistration" ] [ "services" "gitea" "settings" "service" "DISABLE_REGISTRATION" ])
|
2023-04-29 16:46:19 +00:00
|
|
|
(mkRenamedOptionModule [ "services" "gitea" "domain" ] [ "services" "gitea" "settings" "server" "DOMAIN" ])
|
|
|
|
(mkRenamedOptionModule [ "services" "gitea" "httpAddress" ] [ "services" "gitea" "settings" "server" "HTTP_ADDR" ])
|
|
|
|
(mkRenamedOptionModule [ "services" "gitea" "httpPort" ] [ "services" "gitea" "settings" "server" "HTTP_PORT" ])
|
2022-08-21 13:32:41 +00:00
|
|
|
(mkRenamedOptionModule [ "services" "gitea" "log" "level" ] [ "services" "gitea" "settings" "log" "LEVEL" ])
|
|
|
|
(mkRenamedOptionModule [ "services" "gitea" "log" "rootPath" ] [ "services" "gitea" "settings" "log" "ROOT_PATH" ])
|
2023-04-29 16:46:19 +00:00
|
|
|
(mkRenamedOptionModule [ "services" "gitea" "rootUrl" ] [ "services" "gitea" "settings" "server" "ROOT_URL" ])
|
2022-08-21 13:32:41 +00:00
|
|
|
(mkRenamedOptionModule [ "services" "gitea" "ssh" "clonePort" ] [ "services" "gitea" "settings" "server" "SSH_PORT" ])
|
2023-04-29 16:46:19 +00:00
|
|
|
(mkRenamedOptionModule [ "services" "gitea" "staticRootPath" ] [ "services" "gitea" "settings" "server" "STATIC_ROOT_PATH" ])
|
|
|
|
|
|
|
|
(mkChangedOptionModule [ "services" "gitea" "enableUnixSocket" ] [ "services" "gitea" "settings" "server" "PROTOCOL" ] (
|
|
|
|
config: if config.services.gitea.enableUnixSocket then "http+unix" else "http"
|
|
|
|
))
|
2022-08-21 13:32:41 +00:00
|
|
|
|
|
|
|
(mkRemovedOptionModule [ "services" "gitea" "ssh" "enable" ] "services.gitea.ssh.enable has been migrated into freeform setting services.gitea.settings.server.DISABLE_SSH. Keep in mind that the setting is inverted")
|
|
|
|
];
|
|
|
|
|
2020-04-24 23:36:52 +00:00
|
|
|
options = {
|
|
|
|
services.gitea = {
|
|
|
|
enable = mkOption {
|
|
|
|
default = false;
|
|
|
|
type = types.bool;
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Enable Gitea Service.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
2024-01-02 11:29:13 +00:00
|
|
|
package = mkPackageOption pkgs "gitea" { };
|
2020-04-24 23:36:52 +00:00
|
|
|
|
|
|
|
useWizard = mkOption {
|
|
|
|
default = false;
|
|
|
|
type = types.bool;
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Do not generate a configuration and use gitea' installation wizard instead. The first registered user will be administrator.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
stateDir = mkOption {
|
|
|
|
default = "/var/lib/gitea";
|
|
|
|
type = types.str;
|
2023-04-29 16:46:19 +00:00
|
|
|
description = lib.mdDoc "Gitea data directory.";
|
|
|
|
};
|
|
|
|
|
|
|
|
customDir = mkOption {
|
|
|
|
default = "${cfg.stateDir}/custom";
|
|
|
|
defaultText = literalExpression ''"''${config.${opt.stateDir}}/custom"'';
|
|
|
|
type = types.str;
|
|
|
|
description = lib.mdDoc "Gitea custom directory. Used for config, custom templates and other options.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
user = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "gitea";
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "User account under which gitea runs.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
2023-04-29 16:46:19 +00:00
|
|
|
group = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "gitea";
|
|
|
|
description = lib.mdDoc "Group under which gitea runs.";
|
|
|
|
};
|
|
|
|
|
2020-04-24 23:36:52 +00:00
|
|
|
database = {
|
|
|
|
type = mkOption {
|
|
|
|
type = types.enum [ "sqlite3" "mysql" "postgres" ];
|
|
|
|
example = "mysql";
|
|
|
|
default = "sqlite3";
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Database engine to use.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
host = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "127.0.0.1";
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Database host address.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
port = mkOption {
|
2021-07-14 22:03:04 +00:00
|
|
|
type = types.port;
|
2022-08-21 13:32:41 +00:00
|
|
|
default = if !usePostgresql then 3306 else pg.port;
|
2021-12-19 01:06:50 +00:00
|
|
|
defaultText = literalExpression ''
|
|
|
|
if config.${opt.database.type} != "postgresql"
|
|
|
|
then 3306
|
|
|
|
else config.${options.services.postgresql.port}
|
|
|
|
'';
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Database host port.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
name = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "gitea";
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Database name.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
user = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "gitea";
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Database user.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
password = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "";
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
|
|
|
The password corresponding to {option}`database.user`.
|
2020-04-24 23:36:52 +00:00
|
|
|
Warning: this is stored in cleartext in the Nix store!
|
2022-08-12 12:06:08 +00:00
|
|
|
Use {option}`database.passwordFile` instead.
|
2020-04-24 23:36:52 +00:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
passwordFile = mkOption {
|
|
|
|
type = types.nullOr types.path;
|
|
|
|
default = null;
|
|
|
|
example = "/run/keys/gitea-dbpassword";
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
A file containing the password corresponding to
|
2022-08-12 12:06:08 +00:00
|
|
|
{option}`database.user`.
|
2020-04-24 23:36:52 +00:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
socket = mkOption {
|
|
|
|
type = types.nullOr types.path;
|
|
|
|
default = if (cfg.database.createDatabase && usePostgresql) then "/run/postgresql" else if (cfg.database.createDatabase && useMysql) then "/run/mysqld/mysqld.sock" else null;
|
2021-10-06 13:57:05 +00:00
|
|
|
defaultText = literalExpression "null";
|
2020-04-24 23:36:52 +00:00
|
|
|
example = "/run/mysqld/mysqld.sock";
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Path to the unix socket file to use for authentication.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
path = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "${cfg.stateDir}/data/gitea.db";
|
2021-12-19 01:06:50 +00:00
|
|
|
defaultText = literalExpression ''"''${config.${opt.stateDir}}/data/gitea.db"'';
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Path to the sqlite3 database file.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
createDatabase = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = true;
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Whether to create a local database automatically.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
dump = {
|
|
|
|
enable = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = false;
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
Enable a timer that runs gitea dump to generate backup-files of the
|
|
|
|
current gitea database and repositories.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
interval = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "04:31";
|
|
|
|
example = "hourly";
|
2022-08-21 13:32:41 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
Run a gitea dump at this interval. Runs by default at 04:31 every day.
|
|
|
|
|
|
|
|
The format is described in
|
2022-08-21 13:32:41 +00:00
|
|
|
{manpage}`systemd.time(7)`.
|
2020-04-24 23:36:52 +00:00
|
|
|
'';
|
|
|
|
};
|
2020-08-20 17:08:02 +00:00
|
|
|
|
|
|
|
backupDir = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "${cfg.stateDir}/dump";
|
2021-12-19 01:06:50 +00:00
|
|
|
defaultText = literalExpression ''"''${config.${opt.stateDir}}/dump"'';
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Path to the dump files.";
|
2020-08-20 17:08:02 +00:00
|
|
|
};
|
2022-01-22 01:22:15 +00:00
|
|
|
|
|
|
|
type = mkOption {
|
2023-01-20 10:41:00 +00:00
|
|
|
type = types.enum [ "zip" "rar" "tar" "sz" "tar.gz" "tar.xz" "tar.bz2" "tar.br" "tar.lz4" "tar.zst" ];
|
2022-01-22 01:22:15 +00:00
|
|
|
default = "zip";
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Archive format used to store the dump file.";
|
2022-01-22 01:22:15 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
file = mkOption {
|
|
|
|
type = types.nullOr types.str;
|
|
|
|
default = null;
|
2022-12-28 21:21:41 +00:00
|
|
|
description = lib.mdDoc "Filename to be used for the dump. If `null` a default name is chosen by gitea.";
|
2022-01-22 01:22:15 +00:00
|
|
|
example = "gitea-dump";
|
|
|
|
};
|
2020-08-20 17:08:02 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
lfs = {
|
|
|
|
enable = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = false;
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Enables git-lfs support.";
|
2020-08-20 17:08:02 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
contentDir = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "${cfg.stateDir}/data/lfs";
|
2021-12-19 01:06:50 +00:00
|
|
|
defaultText = literalExpression ''"''${config.${opt.stateDir}}/data/lfs"'';
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Where to store LFS files.";
|
2020-08-20 17:08:02 +00:00
|
|
|
};
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
appName = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "gitea: Gitea Service";
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Application name.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
repositoryRoot = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "${cfg.stateDir}/repositories";
|
2021-12-19 01:06:50 +00:00
|
|
|
defaultText = literalExpression ''"''${config.${opt.stateDir}}/repositories"'';
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Path to the git repositories.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
2024-01-02 11:29:13 +00:00
|
|
|
camoHmacKeyFile = mkOption {
|
|
|
|
type = types.nullOr types.str;
|
|
|
|
default = null;
|
|
|
|
example = "/var/lib/secrets/gitea/camoHmacKey";
|
|
|
|
description = lib.mdDoc "Path to a file containing the camo HMAC key.";
|
|
|
|
};
|
|
|
|
|
2020-04-24 23:36:52 +00:00
|
|
|
mailerPasswordFile = mkOption {
|
|
|
|
type = types.nullOr types.str;
|
|
|
|
default = null;
|
|
|
|
example = "/var/lib/secrets/gitea/mailpw";
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Path to a file containing the SMTP password.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
2023-10-09 19:29:22 +00:00
|
|
|
metricsTokenFile = mkOption {
|
|
|
|
type = types.nullOr types.str;
|
|
|
|
default = null;
|
|
|
|
example = "/var/lib/secrets/gitea/metrics_token";
|
|
|
|
description = lib.mdDoc "Path to a file containing the metrics authentication token.";
|
|
|
|
};
|
|
|
|
|
2020-05-15 21:57:56 +00:00
|
|
|
settings = mkOption {
|
|
|
|
default = {};
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
|
|
|
Gitea configuration. Refer to <https://docs.gitea.io/en-us/config-cheat-sheet/>
|
2020-05-15 21:57:56 +00:00
|
|
|
for details on supported values.
|
|
|
|
'';
|
2021-10-06 13:57:05 +00:00
|
|
|
example = literalExpression ''
|
2020-05-15 21:57:56 +00:00
|
|
|
{
|
|
|
|
"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";
|
2021-12-06 16:07:01 +00:00
|
|
|
SENDMAIL_PATH = "''${pkgs.system-sendmail}/bin/sendmail";
|
2020-05-15 21:57:56 +00:00
|
|
|
};
|
|
|
|
other = {
|
|
|
|
SHOW_FOOTER_VERSION = false;
|
|
|
|
};
|
|
|
|
}
|
|
|
|
'';
|
2023-04-29 16:46:19 +00:00
|
|
|
type = types.submodule {
|
2022-08-21 13:32:41 +00:00
|
|
|
freeformType = format.type;
|
|
|
|
options = {
|
|
|
|
log = {
|
|
|
|
ROOT_PATH = mkOption {
|
|
|
|
default = "${cfg.stateDir}/log";
|
|
|
|
defaultText = literalExpression ''"''${config.${opt.stateDir}}/log"'';
|
|
|
|
type = types.str;
|
|
|
|
description = lib.mdDoc "Root path for log files.";
|
|
|
|
};
|
|
|
|
LEVEL = mkOption {
|
|
|
|
default = "Info";
|
|
|
|
type = types.enum [ "Trace" "Debug" "Info" "Warn" "Error" "Critical" ];
|
|
|
|
description = lib.mdDoc "General log level.";
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
server = {
|
2023-04-29 16:46:19 +00:00
|
|
|
PROTOCOL = mkOption {
|
|
|
|
type = types.enum [ "http" "https" "fcgi" "http+unix" "fcgi+unix" ];
|
|
|
|
default = "http";
|
|
|
|
description = lib.mdDoc ''Listen protocol. `+unix` means "over unix", not "in addition to."'';
|
|
|
|
};
|
|
|
|
|
|
|
|
HTTP_ADDR = mkOption {
|
|
|
|
type = types.either types.str types.path;
|
|
|
|
default = if lib.hasSuffix "+unix" cfg.settings.server.PROTOCOL then "/run/gitea/gitea.sock" else "0.0.0.0";
|
|
|
|
defaultText = literalExpression ''if lib.hasSuffix "+unix" cfg.settings.server.PROTOCOL then "/run/gitea/gitea.sock" else "0.0.0.0"'';
|
|
|
|
description = lib.mdDoc "Listen address. Must be a path when using a unix socket.";
|
|
|
|
};
|
|
|
|
|
|
|
|
HTTP_PORT = mkOption {
|
|
|
|
type = types.port;
|
|
|
|
default = 3000;
|
|
|
|
description = lib.mdDoc "Listen port. Ignored when using a unix socket.";
|
|
|
|
};
|
|
|
|
|
|
|
|
DOMAIN = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "localhost";
|
|
|
|
description = lib.mdDoc "Domain name of your server.";
|
|
|
|
};
|
|
|
|
|
|
|
|
ROOT_URL = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "http://${cfg.settings.server.DOMAIN}:${toString cfg.settings.server.HTTP_PORT}/";
|
|
|
|
defaultText = literalExpression ''"http://''${config.services.gitea.settings.server.DOMAIN}:''${toString config.services.gitea.settings.server.HTTP_PORT}/"'';
|
|
|
|
description = lib.mdDoc "Full public URL of gitea server.";
|
|
|
|
};
|
|
|
|
|
|
|
|
STATIC_ROOT_PATH = mkOption {
|
|
|
|
type = types.either types.str types.path;
|
|
|
|
default = cfg.package.data;
|
|
|
|
defaultText = literalExpression "config.${opt.package}.data";
|
|
|
|
example = "/var/lib/gitea/data";
|
|
|
|
description = lib.mdDoc "Upper level of template and static files path.";
|
|
|
|
};
|
|
|
|
|
2022-08-21 13:32:41 +00:00
|
|
|
DISABLE_SSH = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = false;
|
|
|
|
description = lib.mdDoc "Disable external SSH feature.";
|
|
|
|
};
|
|
|
|
|
|
|
|
SSH_PORT = mkOption {
|
2022-12-17 10:02:37 +00:00
|
|
|
type = types.port;
|
2022-08-21 13:32:41 +00:00
|
|
|
default = 22;
|
|
|
|
example = 2222;
|
|
|
|
description = lib.mdDoc ''
|
|
|
|
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.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
service = {
|
2022-09-09 14:08:57 +00:00
|
|
|
DISABLE_REGISTRATION = mkEnableOption (lib.mdDoc "the registration lock") // {
|
|
|
|
description = lib.mdDoc ''
|
|
|
|
By default any user can create an account on this `gitea` instance.
|
2022-08-21 13:32:41 +00:00
|
|
|
This can be disabled by using this option.
|
|
|
|
|
2022-09-09 14:08:57 +00:00
|
|
|
*Note:* please keep in mind that this should be added after the initial
|
|
|
|
deploy unless [](#opt-services.gitea.useWizard)
|
|
|
|
is `true` as the first registered user will be the administrator if
|
2022-08-21 13:32:41 +00:00
|
|
|
no install wizard is used.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
session = {
|
|
|
|
COOKIE_SECURE = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = false;
|
|
|
|
description = lib.mdDoc ''
|
|
|
|
Marks session cookies as "secure" as a hint for browsers to only send
|
|
|
|
them via HTTPS. This option is recommend, if gitea is being served over HTTPS.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
};
|
|
|
|
};
|
|
|
|
};
|
2020-05-15 21:57:56 +00:00
|
|
|
};
|
|
|
|
|
2020-04-24 23:36:52 +00:00
|
|
|
extraConfig = mkOption {
|
2020-05-15 21:57:56 +00:00
|
|
|
type = with types; nullOr str;
|
|
|
|
default = null;
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "Configuration lines appended to the generated gitea configuration file.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
assertions = [
|
2023-04-29 16:46:19 +00:00
|
|
|
{ assertion = cfg.database.createDatabase -> useSqlite || cfg.database.user == cfg.user;
|
2020-04-24 23:36:52 +00:00
|
|
|
message = "services.gitea.database.user must match services.gitea.user if the database is to be automatically provisioned";
|
|
|
|
}
|
2024-01-02 11:29:13 +00:00
|
|
|
{ assertion = cfg.database.createDatabase && usePostgresql -> cfg.database.user == cfg.database.name;
|
|
|
|
message = ''
|
|
|
|
When creating a database via NixOS, the db user and db name must be equal!
|
|
|
|
If you already have an existing DB+user and this assertion is new, you can safely set
|
|
|
|
`services.gitea.createDatabase` to `false` because removal of `ensureUsers`
|
|
|
|
and `ensureDatabases` doesn't have any effect.
|
|
|
|
'';
|
|
|
|
}
|
2020-04-24 23:36:52 +00:00
|
|
|
];
|
|
|
|
|
2020-05-15 21:57:56 +00:00
|
|
|
services.gitea.settings = {
|
2023-03-24 00:07:29 +00:00
|
|
|
"cron.update_checker".ENABLED = lib.mkDefault false;
|
|
|
|
|
2020-05-15 21:57:56 +00:00
|
|
|
database = mkMerge [
|
|
|
|
{
|
|
|
|
DB_TYPE = cfg.database.type;
|
|
|
|
}
|
|
|
|
(mkIf (useMysql || usePostgresql) {
|
|
|
|
HOST = if cfg.database.socket != null then cfg.database.socket else cfg.database.host + ":" + toString cfg.database.port;
|
|
|
|
NAME = cfg.database.name;
|
|
|
|
USER = cfg.database.user;
|
|
|
|
PASSWD = "#dbpass#";
|
|
|
|
})
|
|
|
|
(mkIf useSqlite {
|
|
|
|
PATH = cfg.database.path;
|
|
|
|
})
|
|
|
|
(mkIf usePostgresql {
|
|
|
|
SSL_MODE = "disable";
|
|
|
|
})
|
|
|
|
];
|
|
|
|
|
|
|
|
repository = {
|
|
|
|
ROOT = cfg.repositoryRoot;
|
|
|
|
};
|
|
|
|
|
2023-04-29 16:46:19 +00:00
|
|
|
server = mkIf cfg.lfs.enable {
|
|
|
|
LFS_START_SERVER = true;
|
|
|
|
LFS_JWT_SECRET = "#lfsjwtsecret#";
|
|
|
|
};
|
2020-05-15 21:57:56 +00:00
|
|
|
|
2024-01-02 11:29:13 +00:00
|
|
|
camo = mkIf (cfg.camoHmacKeyFile != null) {
|
|
|
|
HMAC_KEY = "#hmackey#";
|
|
|
|
};
|
|
|
|
|
2020-05-15 21:57:56 +00:00
|
|
|
session = {
|
2022-08-21 13:32:41 +00:00
|
|
|
COOKIE_NAME = lib.mkDefault "session";
|
2020-05-15 21:57:56 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
security = {
|
|
|
|
SECRET_KEY = "#secretkey#";
|
2021-01-15 22:18:51 +00:00
|
|
|
INTERNAL_TOKEN = "#internaltoken#";
|
2020-05-15 21:57:56 +00:00
|
|
|
INSTALL_LOCK = true;
|
|
|
|
};
|
|
|
|
|
|
|
|
mailer = mkIf (cfg.mailerPasswordFile != null) {
|
|
|
|
PASSWD = "#mailerpass#";
|
|
|
|
};
|
2021-01-15 22:18:51 +00:00
|
|
|
|
2023-10-09 19:29:22 +00:00
|
|
|
metrics = mkIf (cfg.metricsTokenFile != null) {
|
|
|
|
TOKEN = "#metricstoken#";
|
|
|
|
};
|
|
|
|
|
2021-01-15 22:18:51 +00:00
|
|
|
oauth2 = {
|
|
|
|
JWT_SECRET = "#oauth2jwtsecret#";
|
|
|
|
};
|
2023-01-11 07:51:40 +00:00
|
|
|
|
2023-04-29 16:46:19 +00:00
|
|
|
lfs = mkIf cfg.lfs.enable {
|
2023-01-11 07:51:40 +00:00
|
|
|
PATH = cfg.lfs.contentDir;
|
|
|
|
};
|
2023-08-04 22:07:22 +00:00
|
|
|
|
|
|
|
packages.CHUNKED_UPLOAD_PATH = "${cfg.stateDir}/tmp/package-upload";
|
2020-05-15 21:57:56 +00:00
|
|
|
};
|
|
|
|
|
2020-04-24 23:36:52 +00:00
|
|
|
services.postgresql = optionalAttrs (usePostgresql && cfg.database.createDatabase) {
|
|
|
|
enable = mkDefault true;
|
|
|
|
|
|
|
|
ensureDatabases = [ cfg.database.name ];
|
|
|
|
ensureUsers = [
|
|
|
|
{ name = cfg.database.user;
|
2024-01-02 11:29:13 +00:00
|
|
|
ensureDBOwnership = true;
|
2020-04-24 23:36:52 +00:00
|
|
|
}
|
|
|
|
];
|
|
|
|
};
|
|
|
|
|
|
|
|
services.mysql = optionalAttrs (useMysql && cfg.database.createDatabase) {
|
|
|
|
enable = mkDefault true;
|
|
|
|
package = mkDefault pkgs.mariadb;
|
|
|
|
|
|
|
|
ensureDatabases = [ cfg.database.name ];
|
|
|
|
ensureUsers = [
|
|
|
|
{ name = cfg.database.user;
|
|
|
|
ensurePermissions = { "${cfg.database.name}.*" = "ALL PRIVILEGES"; };
|
|
|
|
}
|
|
|
|
];
|
|
|
|
};
|
|
|
|
|
|
|
|
systemd.tmpfiles.rules = [
|
2023-04-29 16:46:19 +00:00
|
|
|
"d '${cfg.dump.backupDir}' 0750 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"z '${cfg.dump.backupDir}' 0750 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"d '${cfg.repositoryRoot}' 0750 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"z '${cfg.repositoryRoot}' 0750 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"d '${cfg.stateDir}' 0750 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"d '${cfg.stateDir}/conf' 0750 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"d '${cfg.customDir}' 0750 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"d '${cfg.customDir}/conf' 0750 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"d '${cfg.stateDir}/data' 0750 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"d '${cfg.stateDir}/log' 0750 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"z '${cfg.stateDir}' 0750 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"z '${cfg.stateDir}/.ssh' 0700 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"z '${cfg.stateDir}/conf' 0750 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"z '${cfg.customDir}' 0750 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"z '${cfg.customDir}/conf' 0750 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"z '${cfg.stateDir}/data' 0750 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"z '${cfg.stateDir}/log' 0750 ${cfg.user} ${cfg.group} - -"
|
2020-04-24 23:36:52 +00:00
|
|
|
|
|
|
|
# If we have a folder or symlink with gitea locales, remove it
|
|
|
|
# And symlink the current gitea locales in place
|
2023-03-04 12:14:45 +00:00
|
|
|
"L+ '${cfg.stateDir}/conf/locale' - - - - ${cfg.package.out}/locale"
|
2023-04-29 16:46:19 +00:00
|
|
|
|
|
|
|
] ++ lib.optionals cfg.lfs.enable [
|
|
|
|
"d '${cfg.lfs.contentDir}' 0750 ${cfg.user} ${cfg.group} - -"
|
|
|
|
"z '${cfg.lfs.contentDir}' 0750 ${cfg.user} ${cfg.group} - -"
|
2020-04-24 23:36:52 +00:00
|
|
|
];
|
|
|
|
|
|
|
|
systemd.services.gitea = {
|
|
|
|
description = "gitea";
|
2023-07-15 17:15:38 +00:00
|
|
|
after = [ "network.target" ] ++ optional usePostgresql "postgresql.service" ++ optional useMysql "mysql.service";
|
|
|
|
requires = optional (cfg.database.createDatabase && usePostgresql) "postgresql.service" ++ optional (cfg.database.createDatabase && useMysql) "mysql.service";
|
2020-04-24 23:36:52 +00:00
|
|
|
wantedBy = [ "multi-user.target" ];
|
2023-03-04 12:14:45 +00:00
|
|
|
path = [ cfg.package pkgs.git pkgs.gnupg ];
|
2021-01-15 22:18:51 +00:00
|
|
|
|
|
|
|
# In older versions the secret naming for JWT was kind of confusing.
|
|
|
|
# The file jwt_secret hold the value for LFS_JWT_SECRET and JWT_SECRET
|
2022-12-28 21:21:41 +00:00
|
|
|
# wasn't persistent at all.
|
2021-01-15 22:18:51 +00:00
|
|
|
# To fix that, there is now the file oauth2_jwt_secret containing the
|
|
|
|
# values for JWT_SECRET and the file jwt_secret gets renamed to
|
|
|
|
# lfs_jwt_secret.
|
|
|
|
# We have to consider this to stay compatible with older installations.
|
2020-04-24 23:36:52 +00:00
|
|
|
preStart = let
|
2023-04-29 16:46:19 +00:00
|
|
|
runConfig = "${cfg.customDir}/conf/app.ini";
|
|
|
|
secretKey = "${cfg.customDir}/conf/secret_key";
|
|
|
|
oauth2JwtSecret = "${cfg.customDir}/conf/oauth2_jwt_secret";
|
|
|
|
oldLfsJwtSecret = "${cfg.customDir}/conf/jwt_secret"; # old file for LFS_JWT_SECRET
|
|
|
|
lfsJwtSecret = "${cfg.customDir}/conf/lfs_jwt_secret"; # new file for LFS_JWT_SECRET
|
|
|
|
internalToken = "${cfg.customDir}/conf/internal_token";
|
2022-04-27 09:35:20 +00:00
|
|
|
replaceSecretBin = "${pkgs.replace-secret}/bin/replace-secret";
|
2020-04-24 23:36:52 +00:00
|
|
|
in ''
|
2023-04-29 16:46:19 +00:00
|
|
|
# copy custom configuration and generate random secrets if needed
|
2022-08-21 13:32:41 +00:00
|
|
|
${optionalString (!cfg.useWizard) ''
|
2021-05-03 20:48:10 +00:00
|
|
|
function gitea_setup {
|
2023-04-29 16:46:19 +00:00
|
|
|
cp -f '${configFile}' '${runConfig}'
|
2021-05-03 20:48:10 +00:00
|
|
|
|
2023-04-29 16:46:19 +00:00
|
|
|
if [ ! -s '${secretKey}' ]; then
|
|
|
|
${exe} generate secret SECRET_KEY > '${secretKey}'
|
2021-05-03 20:48:10 +00:00
|
|
|
fi
|
|
|
|
|
|
|
|
# Migrate LFS_JWT_SECRET filename
|
2023-04-29 16:46:19 +00:00
|
|
|
if [[ -s '${oldLfsJwtSecret}' && ! -s '${lfsJwtSecret}' ]]; then
|
|
|
|
mv '${oldLfsJwtSecret}' '${lfsJwtSecret}'
|
2021-05-03 20:48:10 +00:00
|
|
|
fi
|
|
|
|
|
2023-04-29 16:46:19 +00:00
|
|
|
if [ ! -s '${oauth2JwtSecret}' ]; then
|
|
|
|
${exe} generate secret JWT_SECRET > '${oauth2JwtSecret}'
|
2021-05-03 20:48:10 +00:00
|
|
|
fi
|
|
|
|
|
2023-04-29 16:46:19 +00:00
|
|
|
${lib.optionalString cfg.lfs.enable ''
|
|
|
|
if [ ! -s '${lfsJwtSecret}' ]; then
|
|
|
|
${exe} generate secret LFS_JWT_SECRET > '${lfsJwtSecret}'
|
2021-05-03 20:48:10 +00:00
|
|
|
fi
|
2023-04-29 16:46:19 +00:00
|
|
|
''}
|
2021-05-03 20:48:10 +00:00
|
|
|
|
2023-04-29 16:46:19 +00:00
|
|
|
if [ ! -s '${internalToken}' ]; then
|
|
|
|
${exe} generate secret INTERNAL_TOKEN > '${internalToken}'
|
2021-05-03 20:48:10 +00:00
|
|
|
fi
|
|
|
|
|
2022-04-27 09:35:20 +00:00
|
|
|
chmod u+w '${runConfig}'
|
|
|
|
${replaceSecretBin} '#secretkey#' '${secretKey}' '${runConfig}'
|
|
|
|
${replaceSecretBin} '#dbpass#' '${cfg.database.passwordFile}' '${runConfig}'
|
|
|
|
${replaceSecretBin} '#oauth2jwtsecret#' '${oauth2JwtSecret}' '${runConfig}'
|
|
|
|
${replaceSecretBin} '#internaltoken#' '${internalToken}' '${runConfig}'
|
|
|
|
|
2023-04-29 16:46:19 +00:00
|
|
|
${lib.optionalString cfg.lfs.enable ''
|
|
|
|
${replaceSecretBin} '#lfsjwtsecret#' '${lfsJwtSecret}' '${runConfig}'
|
|
|
|
''}
|
|
|
|
|
2024-01-02 11:29:13 +00:00
|
|
|
${lib.optionalString (cfg.camoHmacKeyFile != null) ''
|
|
|
|
${replaceSecretBin} '#hmackey#' '${cfg.camoHmacKeyFile}' '${runConfig}'
|
|
|
|
''}
|
|
|
|
|
2022-04-27 09:35:20 +00:00
|
|
|
${lib.optionalString (cfg.mailerPasswordFile != null) ''
|
|
|
|
${replaceSecretBin} '#mailerpass#' '${cfg.mailerPasswordFile}' '${runConfig}'
|
2021-05-03 20:48:10 +00:00
|
|
|
''}
|
2023-10-09 19:29:22 +00:00
|
|
|
|
|
|
|
${lib.optionalString (cfg.metricsTokenFile != null) ''
|
|
|
|
${replaceSecretBin} '#metricstoken#' '${cfg.metricsTokenFile}' '${runConfig}'
|
|
|
|
''}
|
2022-04-27 09:35:20 +00:00
|
|
|
chmod u-w '${runConfig}'
|
2021-05-03 20:48:10 +00:00
|
|
|
}
|
|
|
|
(umask 027; gitea_setup)
|
2020-04-24 23:36:52 +00:00
|
|
|
''}
|
|
|
|
|
2021-08-08 23:34:03 +00:00
|
|
|
# run migrations/init the database
|
2023-03-04 12:14:45 +00:00
|
|
|
${exe} migrate
|
2021-08-08 23:34:03 +00:00
|
|
|
|
2020-04-24 23:36:52 +00:00
|
|
|
# update all hooks' binary paths
|
2023-03-04 12:14:45 +00:00
|
|
|
${exe} admin regenerate hooks
|
2020-04-24 23:36:52 +00:00
|
|
|
|
|
|
|
# update command option in authorized_keys
|
|
|
|
if [ -r ${cfg.stateDir}/.ssh/authorized_keys ]
|
|
|
|
then
|
2023-03-04 12:14:45 +00:00
|
|
|
${exe} admin regenerate keys
|
2020-04-24 23:36:52 +00:00
|
|
|
fi
|
|
|
|
'';
|
|
|
|
|
|
|
|
serviceConfig = {
|
|
|
|
Type = "simple";
|
|
|
|
User = cfg.user;
|
2023-04-29 16:46:19 +00:00
|
|
|
Group = cfg.group;
|
2020-04-24 23:36:52 +00:00
|
|
|
WorkingDirectory = cfg.stateDir;
|
2023-03-04 12:14:45 +00:00
|
|
|
ExecStart = "${exe} web --pid /run/gitea/gitea.pid";
|
2020-04-24 23:36:52 +00:00
|
|
|
Restart = "always";
|
2020-08-20 17:08:02 +00:00
|
|
|
# Runtime directory and mode
|
|
|
|
RuntimeDirectory = "gitea";
|
2023-08-04 22:07:22 +00:00
|
|
|
RuntimeDirectoryMode = "0755";
|
2023-07-15 17:15:38 +00:00
|
|
|
# Proc filesystem
|
|
|
|
ProcSubset = "pid";
|
|
|
|
ProtectProc = "invisible";
|
2020-08-20 17:08:02 +00:00
|
|
|
# Access write directories
|
2023-04-29 16:46:19 +00:00
|
|
|
ReadWritePaths = [ cfg.customDir cfg.dump.backupDir cfg.repositoryRoot cfg.stateDir cfg.lfs.contentDir ];
|
2020-08-20 17:08:02 +00:00
|
|
|
UMask = "0027";
|
|
|
|
# Capabilities
|
|
|
|
CapabilityBoundingSet = "";
|
|
|
|
# Security
|
|
|
|
NoNewPrivileges = true;
|
|
|
|
# Sandboxing
|
|
|
|
ProtectSystem = "strict";
|
2020-04-24 23:36:52 +00:00
|
|
|
ProtectHome = true;
|
2020-08-20 17:08:02 +00:00
|
|
|
PrivateTmp = true;
|
2020-04-24 23:36:52 +00:00
|
|
|
PrivateDevices = true;
|
2020-08-20 17:08:02 +00:00
|
|
|
PrivateUsers = true;
|
|
|
|
ProtectHostname = true;
|
|
|
|
ProtectClock = true;
|
2020-04-24 23:36:52 +00:00
|
|
|
ProtectKernelTunables = true;
|
|
|
|
ProtectKernelModules = true;
|
2020-08-20 17:08:02 +00:00
|
|
|
ProtectKernelLogs = true;
|
2020-04-24 23:36:52 +00:00
|
|
|
ProtectControlGroups = true;
|
2023-07-15 17:15:38 +00:00
|
|
|
RestrictAddressFamilies = [ "AF_UNIX" "AF_INET" "AF_INET6" ];
|
|
|
|
RestrictNamespaces = true;
|
2020-04-24 23:36:52 +00:00
|
|
|
LockPersonality = true;
|
2020-08-20 17:08:02 +00:00
|
|
|
MemoryDenyWriteExecute = true;
|
2020-04-24 23:36:52 +00:00
|
|
|
RestrictRealtime = true;
|
2020-08-20 17:08:02 +00:00
|
|
|
RestrictSUIDSGID = true;
|
2023-07-15 17:15:38 +00:00
|
|
|
RemoveIPC = true;
|
2020-04-24 23:36:52 +00:00
|
|
|
PrivateMounts = true;
|
2020-08-20 17:08:02 +00:00
|
|
|
# System Call Filtering
|
2020-04-24 23:36:52 +00:00
|
|
|
SystemCallArchitectures = "native";
|
2023-07-15 17:15:38 +00:00
|
|
|
SystemCallFilter = [ "~@cpu-emulation @debug @keyring @mount @obsolete @privileged @setuid" "setrlimit" ];
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
environment = {
|
|
|
|
USER = cfg.user;
|
|
|
|
HOME = cfg.stateDir;
|
|
|
|
GITEA_WORK_DIR = cfg.stateDir;
|
2023-04-29 16:46:19 +00:00
|
|
|
GITEA_CUSTOM = cfg.customDir;
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
users.users = mkIf (cfg.user == "gitea") {
|
|
|
|
gitea = {
|
|
|
|
description = "Gitea Service";
|
|
|
|
home = cfg.stateDir;
|
|
|
|
useDefaultShell = true;
|
2023-04-29 16:46:19 +00:00
|
|
|
group = cfg.group;
|
2020-04-24 23:36:52 +00:00
|
|
|
isSystemUser = true;
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
2023-04-29 16:46:19 +00:00
|
|
|
users.groups = mkIf (cfg.group == "gitea") {
|
|
|
|
gitea = {};
|
|
|
|
};
|
2020-04-24 23:36:52 +00:00
|
|
|
|
2020-05-15 21:57:56 +00:00
|
|
|
warnings =
|
2021-02-05 17:12:51 +00:00
|
|
|
optional (cfg.database.password != "") "config.services.gitea.database.password will be stored as plaintext in the Nix store. Use database.passwordFile instead." ++
|
2020-05-15 21:57:56 +00:00
|
|
|
optional (cfg.extraConfig != null) ''
|
|
|
|
services.gitea.`extraConfig` is deprecated, please use services.gitea.`settings`.
|
|
|
|
'';
|
2020-04-24 23:36:52 +00:00
|
|
|
|
|
|
|
# Create database passwordFile default when password is configured.
|
|
|
|
services.gitea.database.passwordFile =
|
2022-08-21 13:32:41 +00:00
|
|
|
mkDefault (toString (pkgs.writeTextFile {
|
2020-04-24 23:36:52 +00:00
|
|
|
name = "gitea-database-password";
|
|
|
|
text = cfg.database.password;
|
2022-08-21 13:32:41 +00:00
|
|
|
}));
|
2020-04-24 23:36:52 +00:00
|
|
|
|
|
|
|
systemd.services.gitea-dump = mkIf cfg.dump.enable {
|
|
|
|
description = "gitea dump";
|
|
|
|
after = [ "gitea.service" ];
|
2023-03-04 12:14:45 +00:00
|
|
|
path = [ cfg.package ];
|
2020-04-24 23:36:52 +00:00
|
|
|
|
|
|
|
environment = {
|
|
|
|
USER = cfg.user;
|
|
|
|
HOME = cfg.stateDir;
|
|
|
|
GITEA_WORK_DIR = cfg.stateDir;
|
2023-08-10 07:59:29 +00:00
|
|
|
GITEA_CUSTOM = cfg.customDir;
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
serviceConfig = {
|
|
|
|
Type = "oneshot";
|
|
|
|
User = cfg.user;
|
2023-03-04 12:14:45 +00:00
|
|
|
ExecStart = "${exe} dump --type ${cfg.dump.type}" + optionalString (cfg.dump.file != null) " --file ${cfg.dump.file}";
|
2020-08-20 17:08:02 +00:00
|
|
|
WorkingDirectory = cfg.dump.backupDir;
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
systemd.timers.gitea-dump = mkIf cfg.dump.enable {
|
|
|
|
description = "Update timer for gitea-dump";
|
|
|
|
partOf = [ "gitea-dump.service" ];
|
|
|
|
wantedBy = [ "timers.target" ];
|
|
|
|
timerConfig.OnCalendar = cfg.dump.interval;
|
|
|
|
};
|
|
|
|
};
|
2023-03-04 12:14:45 +00:00
|
|
|
meta.maintainers = with lib.maintainers; [ srhb ma27 thehedgeh0g ];
|
2020-04-24 23:36:52 +00:00
|
|
|
}
|