commit c0bd900632d2d896830897de888a9387b92df3b8 · pyrox.dev/nixpkgs

nixos/doc/manual/from_md/release-notes/rl-2111.section.xml

···

       65
       65
        
                 be able to access programmers supported by flashrom.

     

       66
       66
        
               </para>

     

       67
       67
        
             </listitem>

     

       68
       68
       +
             <listitem>

     

       69
       69
       +
               <para>

     

       70
       70
       +
                 <link xlink:href="https://vikunja.io">vikunja</link>, a to-do

     

       71
       71
       +
                 list app. Available as

     

       72
       72
       +
                 <link linkend="opt-services.vikunja.enable">services.vikunja</link>.

     

       73
       73
       +
               </para>

     

       74
       74
       +
             </listitem>

     

       68
       75
        
           </itemizedlist>

     

       69
       76
        
         </section>

     

       70
       77
        
         <section xml:id="sec-release-21.11-incompatibilities">

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

···

       20
       20
        
       

     

       21
       21
        
       - Users of flashrom should migrate to [programs.flashrom.enable](options.html#opt-programs.flashrom.enable) and add themselves to the `flashrom` group to be able to access programmers supported by flashrom.

     

       22
       22
        
       

     

       23
       23
       +
       - [vikunja](https://vikunja.io), a to-do list app. Available as [services.vikunja](#opt-services.vikunja.enable).

     

       24
       24
       +
       

     

       23
       25
        
       ## Backward Incompatibilities {#sec-release-21.11-incompatibilities}

     

       24
       26
        
       

     

       25
       27
        
       - The `staticjinja` package has been upgraded from 1.0.4 to 3.0.1

nixos/modules/module-list.nix

···

       968
       968
        
         ./services/web-apps/trilium.nix

     

       969
       969
        
         ./services/web-apps/selfoss.nix

     

       970
       970
        
         ./services/web-apps/shiori.nix

     

       971
       971
       +
         ./services/web-apps/vikunja.nix

     

       971
       972
        
         ./services/web-apps/virtlyst.nix

     

       972
       973
        
         ./services/web-apps/wiki-js.nix

     

       973
       974
        
         ./services/web-apps/whitebophir.nix

+145

nixos/modules/services/web-apps/vikunja.nix

···

       1
       1
       +
       { pkgs, lib, config, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       

     

       5
       5
       +
       let

     

       6
       6
       +
         cfg = config.services.vikunja;

     

       7
       7
       +
         format = pkgs.formats.yaml {};

     

       8
       8
       +
         configFile = format.generate "config.yaml" cfg.settings;

     

       9
       9
       +
         useMysql = cfg.database.type == "mysql";

     

       10
       10
       +
         usePostgresql = cfg.database.type == "postgres";

     

       11
       11
       +
       in {

     

       12
       12
       +
         options.services.vikunja = with lib; {

     

       13
       13
       +
           enable = mkEnableOption "vikunja service";

     

       14
       14
       +
           package-api = mkOption {

     

       15
       15
       +
             default = pkgs.vikunja-api;

     

       16
       16
       +
             type = types.package;

     

       17
       17
       +
             defaultText = "pkgs.vikunja-api";

     

       18
       18
       +
             description = "vikunja-api derivation to use.";

     

       19
       19
       +
           };

     

       20
       20
       +
           package-frontend = mkOption {

     

       21
       21
       +
             default = pkgs.vikunja-frontend;

     

       22
       22
       +
             type = types.package;

     

       23
       23
       +
             defaultText = "pkgs.vikunja-frontend";

     

       24
       24
       +
             description = "vikunja-frontend derivation to use.";

     

       25
       25
       +
           };

     

       26
       26
       +
           environmentFiles = mkOption {

     

       27
       27
       +
             type = types.listOf types.path;

     

       28
       28
       +
             default = [ ];

     

       29
       29
       +
             description = ''

     

       30
       30
       +
               List of environment files set in the vikunja systemd service.

     

       31
       31
       +
               For example passwords should be set in one of these files.

     

       32
       32
       +
             '';

     

       33
       33
       +
           };

     

       34
       34
       +
           setupNginx = mkOption {

     

       35
       35
       +
             type = types.bool;

     

       36
       36
       +
             default = config.services.nginx.enable;

     

       37
       37
       +
             defaultText = "config.services.nginx.enable";

     

       38
       38
       +
             description = ''

     

       39
       39
       +
               Whether to setup NGINX.

     

       40
       40
       +
               Further nginx configuration can be done by changing

     

       41
       41
       +
               <option>services.nginx.virtualHosts.&lt;frontendHostname&gt;</option>.

     

       42
       42
       +
               This does not enable TLS or ACME by default. To enable this, set the

     

       43
       43
       +
               <option>services.nginx.virtualHosts.&lt;frontendHostname&gt;.enableACME</option> to

     

       44
       44
       +
               <literal>true</literal> and if appropriate do the same for

     

       45
       45
       +
               <option>services.nginx.virtualHosts.&lt;frontendHostname&gt;.forceSSL</option>.

     

       46
       46
       +
             '';

     

       47
       47
       +
           };

     

       48
       48
       +
           frontendScheme = mkOption {

     

       49
       49
       +
             type = types.enum [ "http" "https" ];

     

       50
       50
       +
             description = ''

     

       51
       51
       +
               Whether the site is available via http or https.

     

       52
       52
       +
               This does not configure https or ACME in nginx!

     

       53
       53
       +
             '';

     

       54
       54
       +
           };

     

       55
       55
       +
           frontendHostname = mkOption {

     

       56
       56
       +
             type = types.str;

     

       57
       57
       +
             description = "The Hostname under which the frontend is running.";

     

       58
       58
       +
           };

     

       59
       59
       +
       

     

       60
       60
       +
           settings = mkOption {

     

       61
       61
       +
             type = format.type;

     

       62
       62
       +
             default = {};

     

       63
       63
       +
             description = ''

     

       64
       64
       +
               Vikunja configuration. Refer to

     

       65
       65
       +
               <link xlink:href="https://vikunja.io/docs/config-options/"/>

     

       66
       66
       +
               for details on supported values.

     

       67
       67
       +
               '';

     

       68
       68
       +
           };

     

       69
       69
       +
           database = {

     

       70
       70
       +
             type = mkOption {

     

       71
       71
       +
               type = types.enum [ "sqlite" "mysql" "postgres" ];

     

       72
       72
       +
               example = "postgres";

     

       73
       73
       +
               default = "sqlite";

     

       74
       74
       +
               description = "Database engine to use.";

     

       75
       75
       +
             };

     

       76
       76
       +
             host = mkOption {

     

       77
       77
       +
               type = types.str;

     

       78
       78
       +
               default = "localhost";

     

       79
       79
       +
               description = "Database host address. Can also be a socket.";

     

       80
       80
       +
             };

     

       81
       81
       +
             user = mkOption {

     

       82
       82
       +
               type = types.str;

     

       83
       83
       +
               default = "vikunja";

     

       84
       84
       +
               description = "Database user.";

     

       85
       85
       +
             };

     

       86
       86
       +
             database = mkOption {

     

       87
       87
       +
               type = types.str;

     

       88
       88
       +
               default = "vikunja";

     

       89
       89
       +
               description = "Database name.";

     

       90
       90
       +
             };

     

       91
       91
       +
             path = mkOption {

     

       92
       92
       +
               type = types.str;

     

       93
       93
       +
               default = "/var/lib/vikunja/vikunja.db";

     

       94
       94
       +
               description = "Path to the sqlite3 database file.";

     

       95
       95
       +
             };

     

       96
       96
       +
           };

     

       97
       97
       +
         };

     

       98
       98
       +
         config = lib.mkIf cfg.enable {

     

       99
       99
       +
           services.vikunja.settings = {

     

       100
       100
       +
             database = {

     

       101
       101
       +
               inherit (cfg.database) type host user database path;

     

       102
       102
       +
             };

     

       103
       103
       +
             service = {

     

       104
       104
       +
               frontendurl = "${cfg.frontendScheme}://${cfg.frontendHostname}/";

     

       105
       105
       +
             };

     

       106
       106
       +
             files = {

     

       107
       107
       +
               basepath = "/var/lib/vikunja/files";

     

       108
       108
       +
             };

     

       109
       109
       +
           };

     

       110
       110
       +
       

     

       111
       111
       +
           systemd.services.vikunja-api = {

     

       112
       112
       +
             description = "vikunja-api";

     

       113
       113
       +
             after = [ "network.target" ] ++ lib.optional usePostgresql "postgresql.service" ++ lib.optional useMysql "mysql.service";

     

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

     

       115
       115
       +
             path = [ cfg.package-api ];

     

       116
       116
       +
             restartTriggers = [ configFile ];

     

       117
       117
       +
       

     

       118
       118
       +
             serviceConfig = {

     

       119
       119
       +
               Type = "simple";

     

       120
       120
       +
               DynamicUser = true;

     

       121
       121
       +
               StateDirectory = "vikunja";

     

       122
       122
       +
               ExecStart = "${cfg.package-api}/bin/vikunja";

     

       123
       123
       +
               Restart = "always";

     

       124
       124
       +
               EnvironmentFile = cfg.environmentFiles;

     

       125
       125
       +
             };

     

       126
       126
       +
           };

     

       127
       127
       +
       

     

       128
       128
       +
           services.nginx.virtualHosts."${cfg.frontendHostname}" = mkIf cfg.setupNginx {

     

       129
       129
       +
             locations = {

     

       130
       130
       +
               "/" = {

     

       131
       131
       +
                 root = cfg.package-frontend;

     

       132
       132
       +
                 tryFiles = "try_files $uri $uri/ /";

     

       133
       133
       +
               };

     

       134
       134
       +
               "~* ^/(api|dav|\\.well-known)/" = {

     

       135
       135
       +
                 proxyPass = "http://localhost:3456";

     

       136
       136
       +
                 extraConfig = ''

     

       137
       137
       +
                   client_max_body_size 20M;

     

       138
       138
       +
                 '';

     

       139
       139
       +
               };

     

       140
       140
       +
             };

     

       141
       141
       +
           };

     

       142
       142
       +
       

     

       143
       143
       +
           environment.etc."vikunja/config.yaml".source = configFile;

     

       144
       144
       +
         };

     

       145
       145
       +
       }