diff options
Diffstat (limited to 'nixos/modules/services/misc/etebase-server.nix')
-rw-r--r-- | nixos/modules/services/misc/etebase-server.nix | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/nixos/modules/services/misc/etebase-server.nix b/nixos/modules/services/misc/etebase-server.nix index cb99364aa1a..24be9e8e269 100644 --- a/nixos/modules/services/misc/etebase-server.nix +++ b/nixos/modules/services/misc/etebase-server.nix @@ -36,12 +36,12 @@ in type = types.bool; default = false; example = true; - description = '' + description = lib.mdDoc '' Whether to enable the Etebase server. Once enabled you need to create an admin user by invoking the - shell command <literal>etebase-server createsuperuser</literal> with - the user specified by the <literal>user</literal> option or a superuser. + shell command `etebase-server createsuperuser` with + the user specified by the `user` option or a superuser. Then you can login and create accounts on your-etebase-server.com/admin ''; }; @@ -49,19 +49,19 @@ in dataDir = mkOption { type = types.str; default = "/var/lib/etebase-server"; - description = "Directory to store the Etebase server data."; + description = lib.mdDoc "Directory to store the Etebase server data."; }; port = mkOption { type = with types; nullOr port; default = 8001; - description = "Port to listen on."; + description = lib.mdDoc "Port to listen on."; }; openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to open ports in the firewall for the server. ''; }; @@ -69,7 +69,7 @@ in unixSocket = mkOption { type = with types; nullOr str; default = null; - description = "The path to the socket to bind to."; + description = lib.mdDoc "The path to the socket to bind to."; example = "/run/etebase-server/etebase-server.sock"; }; @@ -82,14 +82,14 @@ in debug = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to set django's DEBUG flag. ''; }; secret_file = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' The path to a file containing the secret used as django's SECRET_KEY. ''; @@ -98,13 +98,13 @@ in type = types.str; default = "${cfg.dataDir}/static"; defaultText = literalExpression ''"''${config.services.etebase-server.dataDir}/static"''; - description = "The directory for static files."; + description = lib.mdDoc "The directory for static files."; }; media_root = mkOption { type = types.str; default = "${cfg.dataDir}/media"; defaultText = literalExpression ''"''${config.services.etebase-server.dataDir}/media"''; - description = "The media directory."; + description = lib.mdDoc "The media directory."; }; }; allowed_hosts = { @@ -112,7 +112,7 @@ in type = types.str; default = "0.0.0.0"; example = "localhost"; - description = '' + description = lib.mdDoc '' The main host that is allowed access. ''; }; @@ -121,13 +121,13 @@ in engine = mkOption { type = types.enum [ "django.db.backends.sqlite3" "django.db.backends.postgresql" ]; default = "django.db.backends.sqlite3"; - description = "The database engine to use."; + description = lib.mdDoc "The database engine to use."; }; name = mkOption { type = types.str; default = "${cfg.dataDir}/db.sqlite3"; defaultText = literalExpression ''"''${config.services.etebase-server.dataDir}/db.sqlite3"''; - description = "The database name."; + description = lib.mdDoc "The database name."; }; }; }; @@ -153,7 +153,7 @@ in user = mkOption { type = types.str; default = defaultUser; - description = "User under which Etebase server runs."; + description = lib.mdDoc "User under which Etebase server runs."; }; }; }; |