summary refs log tree commit diff
path: root/nixos/modules/services/misc/polaris.nix
diff options
context:
space:
mode:
authorgithub-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>2022-08-02 06:02:34 +0000
committerGitHub <noreply@github.com>2022-08-02 06:02:34 +0000
commit0f0010fda33b7082197495df475d02f64d7e5050 (patch)
treedeee10eaf5f1b24afc73804ae70aec24e6fcf2ce /nixos/modules/services/misc/polaris.nix
parentad090ff8671dcb957c0bafef4eba9d527d90d957 (diff)
parentd2042f91c1ad953825556be3ec2e53cf9a91fc77 (diff)
downloadnixpkgs-0f0010fda33b7082197495df475d02f64d7e5050.tar
nixpkgs-0f0010fda33b7082197495df475d02f64d7e5050.tar.gz
nixpkgs-0f0010fda33b7082197495df475d02f64d7e5050.tar.bz2
nixpkgs-0f0010fda33b7082197495df475d02f64d7e5050.tar.lz
nixpkgs-0f0010fda33b7082197495df475d02f64d7e5050.tar.xz
nixpkgs-0f0010fda33b7082197495df475d02f64d7e5050.tar.zst
nixpkgs-0f0010fda33b7082197495df475d02f64d7e5050.zip
Merge master into staging-next
Diffstat (limited to 'nixos/modules/services/misc/polaris.nix')
-rw-r--r--nixos/modules/services/misc/polaris.nix14
1 files changed, 7 insertions, 7 deletions
diff --git a/nixos/modules/services/misc/polaris.nix b/nixos/modules/services/misc/polaris.nix
index 68045af1528..b5f7f17e664 100644
--- a/nixos/modules/services/misc/polaris.nix
+++ b/nixos/modules/services/misc/polaris.nix
@@ -18,26 +18,26 @@ in
       user = mkOption {
         type = types.str;
         default = "polaris";
-        description = "User account under which Polaris runs.";
+        description = lib.mdDoc "User account under which Polaris runs.";
       };
 
       group = mkOption {
         type = types.str;
         default = "polaris";
-        description = "Group under which Polaris is run.";
+        description = lib.mdDoc "Group under which Polaris is run.";
       };
 
       extraGroups = mkOption {
         type = types.listOf types.str;
         default = [];
-        description = "Polaris' auxiliary groups.";
+        description = lib.mdDoc "Polaris' auxiliary groups.";
         example = literalExpression ''["media" "music"]'';
       };
 
       port = mkOption {
         type = types.port;
         default = 5050;
-        description = ''
+        description = lib.mdDoc ''
           The port which the Polaris REST api and web UI should listen to.
           Note: polaris is hardcoded to listen to the hostname "0.0.0.0".
         '';
@@ -46,10 +46,10 @@ in
       settings = mkOption {
         type = settingsFormat.type;
         default = {};
-        description = ''
+        description = lib.mdDoc ''
           Contents for the TOML Polaris config, applied each start.
           Although poorly documented, an example may be found here:
-          <link xlink:href="https://github.com/agersant/polaris/blob/374d0ca56fc0a466d797a4b252e2078607476797/test-data/config.toml">test-config.toml</link>
+          [test-config.toml](https://github.com/agersant/polaris/blob/374d0ca56fc0a466d797a4b252e2078607476797/test-data/config.toml)
         '';
         example = literalExpression ''
           {
@@ -73,7 +73,7 @@ in
       openFirewall = mkOption {
         type = types.bool;
         default = false;
-        description = ''
+        description = lib.mdDoc ''
           Open the configured port in the firewall.
         '';
       };