selfprivacy-nixos-config/selfprivacy-module.nix

161 lines
4.0 KiB
Nix
Raw Normal View History

{ lib, ... }:
2021-11-15 12:02:05 +02:00
with lib;
{
options.selfprivacy = {
# General server options
2021-11-15 12:02:05 +02:00
hostname = mkOption {
description = "The hostname of the server.";
type = types.nullOr types.str;
2021-11-15 12:02:05 +02:00
};
domain = mkOption {
description = ''
Domain used by the server
'';
type = types.nullOr types.str;
2021-11-15 12:02:05 +02:00
};
timezone = mkOption {
description = ''
Timezone used by the server
'';
type = types.nullOr types.str;
default = "Europe/Uzhgorod";
};
autoUpgrade = {
enable = mkOption {
description = "Enable auto-upgrade of the server.";
2023-11-18 03:40:57 +02:00
default = false;
type = types.nullOr types.bool;
};
allowReboot = mkOption {
description = "Allow the server to reboot during the upgrade.";
default = false;
type = types.nullOr types.bool;
};
};
2023-03-17 13:50:54 +02:00
stateVersion = mkOption {
description = ''
State version of the server
'';
2023-03-17 14:10:47 +02:00
type = types.str;
2023-03-17 13:50:54 +02:00
default = "22.11";
};
########################
# Server admin options #
########################
2021-11-15 12:02:05 +02:00
username = mkOption {
description = ''
Username that was defined at the initial setup process
'';
type = types.nullOr types.str;
2021-11-15 12:02:05 +02:00
};
hashedMasterPassword = mkOption {
description = ''
Hash of the password that was defined at the initial setup process
'';
type = types.nullOr types.str;
2021-11-15 12:02:05 +02:00
};
sshKeys = mkOption {
description = ''
SSH keys of the user that was defined at the initial setup process
'';
2021-11-29 21:17:37 +02:00
type = types.nullOr (types.listOf types.str);
default = [ ];
};
###############
# API options #
###############
2021-11-16 12:28:16 +02:00
api = {
2021-11-16 16:08:58 +02:00
enableSwagger = mkOption {
default = true;
description = ''
Enable Swagger UI
'';
type = types.bool;
};
2022-01-14 02:43:26 +02:00
skippedMigrations = mkOption {
default = [ ];
description = ''
List of migrations that should be skipped
'';
type = types.listOf types.str;
};
2021-11-16 12:28:16 +02:00
};
#############
# Secrets #
#############
dns = {
provider = mkOption {
description = "DNS provider that was defined at the initial setup process.";
type = types.nullOr types.str;
};
useStagingACME = mkOption {
description = "Use staging ACME server. Default is false";
type = types.nullOr types.bool;
default = false;
};
};
backup = {
2021-11-15 12:02:05 +02:00
bucket = mkOption {
description = "Bucket name used for userdata backups";
type = types.nullOr types.str;
default = "";
2021-11-15 12:02:05 +02:00
};
};
server = {
provider = mkOption {
description = "Server provider that was defined at the initial setup process.";
type = types.nullOr types.str;
};
2021-11-15 12:02:05 +02:00
};
#########
# SSH #
#########
2021-11-15 15:35:04 +02:00
ssh = {
enable = mkOption {
default = true;
type = types.nullOr types.bool;
};
rootKeys = mkOption {
description = ''
Root SSH authorized keys
2021-11-15 15:35:04 +02:00
'';
type = types.nullOr (types.listOf types.str);
default = [ "" ];
2021-11-15 15:35:04 +02:00
};
passwordAuthentication = mkOption {
description = ''
Password authentication for SSH
'';
default = false;
2021-11-15 15:35:04 +02:00
type = types.nullOr types.bool;
};
2021-11-15 12:02:05 +02:00
};
###########
# Users #
###########
2021-11-15 12:02:05 +02:00
users = mkOption {
description = ''
Users that will be created on the server
'';
2021-11-15 12:29:20 +02:00
type = types.nullOr (types.listOf (types.attrsOf types.anything));
default = [ ];
2021-11-15 12:02:05 +02:00
};
##############
# Volumes #
##############
volumes = mkOption {
description = ''
Volumes that will be created on the server
'';
type = types.nullOr (types.listOf (types.attrsOf types.anything));
default = [ ];
};
useBinds = mkOption {
type = types.nullOr types.bool;
default = false;
description = "Whether to bind-mount vmail and sieve folders";
};
2021-11-15 12:02:05 +02:00
};
}