commit 8fe9c18ed3986a8e0f4e738db1ee7b82d30ce68b · pyrox.dev/nixpkgs

nixos/doc/manual/release-notes/rl-2405.section.md

···

       16
       16
        
       

     

       17
       17
        
       - [maubot](https://github.com/maubot/maubot), a plugin-based Matrix bot framework. Available as [services.maubot](#opt-services.maubot.enable).

     

       18
       18
        
       

     

       19
       19
       +
       - [Anki Sync Server](https://docs.ankiweb.net/sync-server.html), the official sync server built into recent versions of Anki. Available as [services.anki-sync-server](#opt-services.anki-sync-server.enable).

     

       20
       20
       +
       

     

       19
       21
        
       ## Backward Incompatibilities {#sec-release-24.05-incompatibilities}

     

       20
       22
        
       

     

       21
       23
        
       <!-- To avoid merge conflicts, consider adding your item at an arbitrary place in the list instead. -->

nixos/modules/module-list.nix

···

       635
       635
        
         ./services/misc/amazon-ssm-agent.nix

     

       636
       636
        
         ./services/misc/ananicy.nix

     

       637
       637
        
         ./services/misc/ankisyncd.nix

     

       638
       638
       +
         ./services/misc/anki-sync-server.nix

     

       638
       639
        
         ./services/misc/apache-kafka.nix

     

       639
       640
        
         ./services/misc/atuin.nix

     

       640
       641
        
         ./services/misc/autofs.nix

+68

nixos/modules/services/misc/anki-sync-server.md

···

       1
       1
       +
       # Anki Sync Server {#module-services-anki-sync-server}

     

       2
       2
       +
       

     

       3
       3
       +
       [Anki Sync Server](https://docs.ankiweb.net/sync-server.html) is the built-in

     

       4
       4
       +
       sync server, present in recent versions of Anki. Advanced users who cannot or

     

       5
       5
       +
       do not wish to use AnkiWeb can use this sync server instead of AnkiWeb.

     

       6
       6
       +
       

     

       7
       7
       +
       This module is compatible only with Anki versions >=2.1.66, due to [recent

     

       8
       8
       +
       enhancements to the Nix anki

     

       9
       9
       +
       package](https://github.com/NixOS/nixpkgs/commit/05727304f8815825565c944d012f20a9a096838a).

     

       10
       10
       +
       

     

       11
       11
       +
       ## Basic Usage {#module-services-anki-sync-server-basic-usage}

     

       12
       12
       +
       

     

       13
       13
       +
       By default, the module creates a

     

       14
       14
       +
       [`systemd`](https://www.freedesktop.org/wiki/Software/systemd/)

     

       15
       15
       +
       unit which runs the sync server with an isolated user using the systemd

     

       16
       16
       +
       `DynamicUser` option.

     

       17
       17
       +
       

     

       18
       18
       +
       This can be done by enabling the `anki-sync-server` service:

     

       19
       19
       +
       ```

     

       20
       20
       +
       { ... }:

     

       21
       21
       +
       

     

       22
       22
       +
       {

     

       23
       23
       +
         services.anki-sync-server.enable = true;

     

       24
       24
       +
       }

     

       25
       25
       +
       ```

     

       26
       26
       +
       

     

       27
       27
       +
       It is necessary to set at least one username-password pair under

     

       28
       28
       +
       {option}`services.anki-sync-server.users`. For example

     

       29
       29
       +
       

     

       30
       30
       +
       ```

     

       31
       31
       +
       {

     

       32
       32
       +
         services.anki-sync-server.users = [

     

       33
       33
       +
           {

     

       34
       34
       +
             username = "user";

     

       35
       35
       +
             passwordFile = /etc/anki-sync-server/user;

     

       36
       36
       +
           }

     

       37
       37
       +
         ];

     

       38
       38
       +
       }

     

       39
       39
       +
       ```

     

       40
       40
       +
       

     

       41
       41
       +
       Here, `passwordFile` is the path to a file containing just the password in

     

       42
       42
       +
       plaintext. Make sure to set permissions to make this file unreadable to any

     

       43
       43
       +
       user besides root.

     

       44
       44
       +
       

     

       45
       45
       +
       By default, the server listen address {option}`services.anki-sync-server.host`

     

       46
       46
       +
       is set to localhost, listening on port

     

       47
       47
       +
       {option}`services.anki-sync-server.port`, and does not open the firewall. This

     

       48
       48
       +
       is suitable for purely local testing, or to be used behind a reverse proxy. If

     

       49
       49
       +
       you want to expose the sync server directly to other computers (not recommended

     

       50
       50
       +
       in most circumstances, because the sync server doesn't use HTTPS), then set the

     

       51
       51
       +
       following options:

     

       52
       52
       +
       

     

       53
       53
       +
       ```

     

       54
       54
       +
       {

     

       55
       55
       +
         services.anki-sync-server.host = "0.0.0.0";

     

       56
       56
       +
         services.anki-sync-server.openFirewall = true;

     

       57
       57
       +
       }

     

       58
       58
       +
       ```

     

       59
       59
       +
       

     

       60
       60
       +
       

     

       61
       61
       +
       ## Alternatives {#module-services-anki-sync-server-alternatives}

     

       62
       62
       +
       

     

       63
       63
       +
       The [`ankisyncd` NixOS

     

       64
       64
       +
       module](https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/misc/ankisyncd.nix)

     

       65
       65
       +
       provides similar functionality, but using a third-party implementation,

     

       66
       66
       +
       [`anki-sync-server-rs`](https://github.com/ankicommunity/anki-sync-server-rs/).

     

       67
       67
       +
       According to that project's README, it is "no longer maintained", and not

     

       68
       68
       +
       recommended for Anki 2.1.64+.

+146

nixos/modules/services/misc/anki-sync-server.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         utils,

     

       6
       6
       +
         ...

     

       7
       7
       +
       }:

     

       8
       8
       +
       with lib; let

     

       9
       9
       +
         cfg = config.services.anki-sync-server;

     

       10
       10
       +
         name = "anki-sync-server";

     

       11
       11
       +
         specEscape = replaceStrings ["%"] ["%%"];

     

       12
       12
       +
         usersWithIndexes =

     

       13
       13
       +
           lists.imap1 (i: user: {

     

       14
       14
       +
             i = i;

     

       15
       15
       +
             user = user;

     

       16
       16
       +
           })

     

       17
       17
       +
           cfg.users;

     

       18
       18
       +
         usersWithIndexesFile = filter (x: x.user.passwordFile != null) usersWithIndexes;

     

       19
       19
       +
         usersWithIndexesNoFile = filter (x: x.user.passwordFile == null && x.user.password != null) usersWithIndexes;

     

       20
       20
       +
         anki-sync-server-run = pkgs.writeShellScriptBin "anki-sync-server-run" ''

     

       21
       21
       +
           # When services.anki-sync-server.users.passwordFile is set,

     

       22
       22
       +
           # each password file is passed as a systemd credential, which is mounted in

     

       23
       23
       +
           # a file system exposed to the service. Here we read the passwords from

     

       24
       24
       +
           # the credential files to pass them as environment variables to the Anki

     

       25
       25
       +
           # sync server.

     

       26
       26
       +
           ${

     

       27
       27
       +
             concatMapStringsSep

     

       28
       28
       +
             "\n"

     

       29
       29
       +
             (x: ''export SYNC_USER${toString x.i}=${escapeShellArg x.user.username}:"''$(cat "''${CREDENTIALS_DIRECTORY}/"${escapeShellArg x.user.username})"'')

     

       30
       30
       +
             usersWithIndexesFile

     

       31
       31
       +
           }

     

       32
       32
       +
           # For users where services.anki-sync-server.users.password isn't set,

     

       33
       33
       +
           # export passwords in environment variables in plaintext.

     

       34
       34
       +
           ${

     

       35
       35
       +
             concatMapStringsSep

     

       36
       36
       +
             "\n"

     

       37
       37
       +
             (x: ''export SYNC_USER${toString x.i}=${escapeShellArg x.user.username}:${escapeShellArg x.user.password}'')

     

       38
       38
       +
             usersWithIndexesNoFile

     

       39
       39
       +
           }

     

       40
       40
       +
           exec ${cfg.package}/bin/anki-sync-server

     

       41
       41
       +
         '';

     

       42
       42
       +
       in {

     

       43
       43
       +
         options.services.anki-sync-server = {

     

       44
       44
       +
           enable = mkEnableOption (lib.mdDoc "anki-sync-server");

     

       45
       45
       +
       

     

       46
       46
       +
           package = mkOption {

     

       47
       47
       +
             type = types.package;

     

       48
       48
       +
             default = pkgs.anki-sync-server;

     

       49
       49
       +
             defaultText = literalExpression "pkgs.anki-sync-server";

     

       50
       50
       +
             description = lib.mdDoc "The package to use for the anki-sync-server command.";

     

       51
       51
       +
           };

     

       52
       52
       +
       

     

       53
       53
       +
           address = mkOption {

     

       54
       54
       +
             type = types.str;

     

       55
       55
       +
             default = "::1";

     

       56
       56
       +
             description = lib.mdDoc ''

     

       57
       57
       +
               IP address anki-sync-server listens to.

     

       58
       58
       +
               Note host names are not resolved.

     

       59
       59
       +
             '';

     

       60
       60
       +
           };

     

       61
       61
       +
       

     

       62
       62
       +
           port = mkOption {

     

       63
       63
       +
             type = types.port;

     

       64
       64
       +
             default = 27701;

     

       65
       65
       +
             description = lib.mdDoc "port anki-sync-server listens to";

     

       66
       66
       +
           };

     

       67
       67
       +
       

     

       68
       68
       +
           openFirewall = mkOption {

     

       69
       69
       +
             default = false;

     

       70
       70
       +
             type = types.bool;

     

       71
       71
       +
             description = lib.mdDoc "Whether to open the firewall for the specified port.";

     

       72
       72
       +
           };

     

       73
       73
       +
       

     

       74
       74
       +
           users = mkOption {

     

       75
       75
       +
             type = with types;

     

       76
       76
       +
               listOf (submodule {

     

       77
       77
       +
                 options = {

     

       78
       78
       +
                   username = mkOption {

     

       79
       79
       +
                     type = str;

     

       80
       80
       +
                     description = lib.mdDoc "User name accepted by anki-sync-server.";

     

       81
       81
       +
                   };

     

       82
       82
       +
                   password = mkOption {

     

       83
       83
       +
                     type = nullOr str;

     

       84
       84
       +
                     default = null;

     

       85
       85
       +
                     description = lib.mdDoc ''

     

       86
       86
       +
                       Password accepted by anki-sync-server for the associated username.

     

       87
       87
       +
                       **WARNING**: This option is **not secure**. This password will

     

       88
       88
       +
                       be stored in *plaintext* and will be visible to *all users*.

     

       89
       89
       +
                       See {option}`services.anki-sync-server.users.passwordFile` for

     

       90
       90
       +
                       a more secure option.

     

       91
       91
       +
                     '';

     

       92
       92
       +
                   };

     

       93
       93
       +
                   passwordFile = mkOption {

     

       94
       94
       +
                     type = nullOr path;

     

       95
       95
       +
                     default = null;

     

       96
       96
       +
                     description = lib.mdDoc ''

     

       97
       97
       +
                       File containing the password accepted by anki-sync-server for

     

       98
       98
       +
                       the associated username.  Make sure to make readable only by

     

       99
       99
       +
                       root.

     

       100
       100
       +
                     '';

     

       101
       101
       +
                   };

     

       102
       102
       +
                 };

     

       103
       103
       +
               });

     

       104
       104
       +
             description = lib.mdDoc "List of user-password pairs to provide to the sync server.";

     

       105
       105
       +
           };

     

       106
       106
       +
         };

     

       107
       107
       +
       

     

       108
       108
       +
         config = mkIf cfg.enable {

     

       109
       109
       +
           assertions = [

     

       110
       110
       +
             {

     

       111
       111
       +
               assertion = (builtins.length usersWithIndexesFile) + (builtins.length usersWithIndexesNoFile) > 0;

     

       112
       112
       +
               message = "At least one username-password pair must be set.";

     

       113
       113
       +
             }

     

       114
       114
       +
           ];

     

       115
       115
       +
           networking.firewall.allowedTCPPorts = mkIf cfg.openFirewall [cfg.port];

     

       116
       116
       +
       

     

       117
       117
       +
           systemd.services.anki-sync-server = {

     

       118
       118
       +
             description = "anki-sync-server: Anki sync server built into Anki";

     

       119
       119
       +
             after = ["network.target"];

     

       120
       120
       +
             wantedBy = ["multi-user.target"];

     

       121
       121
       +
             path = [cfg.package];

     

       122
       122
       +
             environment = {

     

       123
       123
       +
               SYNC_BASE = "%S/%N";

     

       124
       124
       +
               SYNC_HOST = specEscape cfg.address;

     

       125
       125
       +
               SYNC_PORT = toString cfg.port;

     

       126
       126
       +
             };

     

       127
       127
       +
       

     

       128
       128
       +
             serviceConfig = {

     

       129
       129
       +
               Type = "simple";

     

       130
       130
       +
               DynamicUser = true;

     

       131
       131
       +
               StateDirectory = name;

     

       132
       132
       +
               ExecStart = "${anki-sync-server-run}/bin/anki-sync-server-run";

     

       133
       133
       +
               Restart = "always";

     

       134
       134
       +
               LoadCredential =

     

       135
       135
       +
                 map

     

       136
       136
       +
                 (x: "${specEscape x.user.username}:${specEscape (toString x.user.passwordFile)}")

     

       137
       137
       +
                 usersWithIndexesFile;

     

       138
       138
       +
             };

     

       139
       139
       +
           };

     

       140
       140
       +
         };

     

       141
       141
       +
       

     

       142
       142
       +
         meta = {

     

       143
       143
       +
           maintainers = with maintainers; [telotortium];

     

       144
       144
       +
           doc = ./anki-sync-server.md;

     

       145
       145
       +
         };

     

       146
       146
       +
       }