nixos/mobilizon: migrate to mdDoc

Changed files
+18 -18
nixos
modules
services
web-apps
+18 -18
nixos/modules/services/web-apps/mobilizon.nix
···
options = {
services.mobilizon = {
enable = mkEnableOption
-
"Mobilizon federated organization and mobilization platform";
+
(lib.mdDoc "Mobilizon federated organization and mobilization platform");
nginx.enable = lib.mkOption {
type = lib.types.bool;
default = true;
-
description = ''
-
Whether an <literal>nginx</literal> virtual host should be
+
description = lib.mdDoc ''
+
Whether an Nginx virtual host should be
set up to serve Mobilizon.
'';
};
···
"Mobilizon.Web.Endpoint" = {
url.host = mkOption {
type = elixirTypes.str;
-
defaultText = literalExpression ''
+
defaultText = lib.literalMD ''
''${settings.":mobilizon".":instance".hostname}
'';
-
description = ''
+
description = lib.mdDoc ''
Your instance's hostname for generating URLs throughout the app
'';
};
···
port = mkOption {
type = elixirTypes.port;
default = 4000;
-
description = ''
+
description = lib.mdDoc ''
The port to run the server
'';
};
ip = mkOption {
type = elixirTypes.tuple;
default = settingsFormat.lib.mkTuple [ 0 0 0 0 0 0 0 1 ];
-
description = ''
+
description = lib.mdDoc ''
The IP address to listen on. Defaults to [::1] notated as a byte tuple.
'';
};
···
has_reverse_proxy = mkOption {
type = elixirTypes.bool;
default = true;
-
description = ''
+
description = lib.mdDoc ''
Whether you use a reverse proxy
'';
};
···
":instance" = {
name = mkOption {
type = elixirTypes.str;
-
description = ''
+
description = lib.mdDoc ''
The fallback instance name if not configured into the admin UI
'';
};
hostname = mkOption {
type = elixirTypes.str;
-
description = ''
+
description = lib.mdDoc ''
Your instance's hostname
'';
};
···
defaultText = literalExpression ''
noreply@''${settings.":mobilizon".":instance".hostname}
'';
-
description = ''
+
description = lib.mdDoc ''
The email for the From: header in emails
'';
};
···
defaultText = literalExpression ''
''${email_from}
'';
-
description = ''
+
description = lib.mdDoc ''
The email for the Reply-To: header in emails
'';
};
···
socket_dir = mkOption {
type = types.nullOr elixirTypes.str;
default = postgresqlSocketDir;
-
description = ''
+
description = lib.mdDoc ''
Path to the postgres socket directory.
Set this to null if you want to connect to a remote database.
···
If connecting to a remote database, please follow the
instructions on how to setup your database:
-
<link xlink:href="https://docs.joinmobilizon.org/administration/install/release/#database-setup"/>
+
<https://docs.joinmobilizon.org/administration/install/release/#database-setup>
'';
};
username = mkOption {
type = types.nullOr elixirTypes.str;
default = user;
-
description = ''
+
description = lib.mdDoc ''
User used to connect to the database
'';
};
···
database = mkOption {
type = types.nullOr elixirTypes.str;
default = "mobilizon_prod";
-
description = ''
+
description = lib.mdDoc ''
Name of the database
'';
};
···
};
default = { };
-
description = ''
+
description = lib.mdDoc ''
Mobilizon Elixir documentation, see
-
<link xlink:href="https://docs.joinmobilizon.org/administration/configure/reference/"/>
+
<https://docs.joinmobilizon.org/administration/configure/reference/>
for supported values.
'';
};