commit fa54eeea5c23f3dc826d1e6cd9d6dd29b48b1937 · pyrox.dev/nixpkgs

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

···

       72
       72
        
       

     

       73
       73
        
       - [LibreNMS](https://www.librenms.org), a auto-discovering PHP/MySQL/SNMP based network monitoring. Available as [services.librenms](#opt-services.librenms.enable).

     

       74
       74
        
       

     

       75
       75
       +
       - [Livebook](https://livebook.dev/), an interactive notebook with support for Elixir, graphs, machine learning, and more.

     

       76
       76
       +
       

     

       75
       77
        
       - [sitespeed-io](https://sitespeed.io), a tool that can generate metrics (timings, diagnostics) for websites. Available as [services.sitespeed-io](#opt-services.sitespeed-io.enable).

     

       76
       78
        
       

     

       77
       79
        
       - [stalwart-mail](https://stalw.art), an all-in-one email server (SMTP, IMAP, JMAP). Available as [services.stalwart-mail](#opt-services.stalwart-mail.enable).

nixos/modules/module-list.nix

···

       485
       485
        
         ./services/development/hoogle.nix

     

       486
       486
        
         ./services/development/jupyter/default.nix

     

       487
       487
        
         ./services/development/jupyterhub/default.nix

     

       488
       488
       +
         ./services/development/livebook.nix

     

       488
       489
        
         ./services/development/lorri.nix

     

       489
       490
        
         ./services/development/rstudio-server/default.nix

     

       490
       491
        
         ./services/development/zammad.nix

+39

nixos/modules/services/development/livebook.md

···

       1
       1
       +
       # Livebook {#module-services-livebook}

     

       2
       2
       +
       

     

       3
       3
       +
       [Livebook](https://livebook.dev/) is a web application for writing

     

       4
       4
       +
       interactive and collaborative code notebooks.

     

       5
       5
       +
       

     

       6
       6
       +
       ## Basic Usage {#module-services-livebook-basic-usage}

     

       7
       7
       +
       

     

       8
       8
       +
       Enabling the `livebook` service creates a user

     

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

     

       10
       10
       +
       which runs the server.

     

       11
       11
       +
       

     

       12
       12
       +
       ```

     

       13
       13
       +
       { ... }:

     

       14
       14
       +
       

     

       15
       15
       +
       {

     

       16
       16
       +
         services.livebook = {

     

       17
       17
       +
           enableUserService = true;

     

       18
       18
       +
           port = 20123;

     

       19
       19
       +
           # See note below about security

     

       20
       20
       +
           environmentFile = pkgs.writeText "livebook.env" ''

     

       21
       21
       +
             LIVEBOOK_PASSWORD = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";

     

       22
       22
       +
           '';

     

       23
       23
       +
         };

     

       24
       24
       +
       }

     

       25
       25
       +
       ```

     

       26
       26
       +
       

     

       27
       27
       +
       ::: {.note}

     

       28
       28
       +
       

     

       29
       29
       +
       The Livebook server has the ability to run any command as the user it

     

       30
       30
       +
       is running under, so securing access to it with a password is highly

     

       31
       31
       +
       recommended.

     

       32
       32
       +
       

     

       33
       33
       +
       Putting the password in the Nix configuration like above is an easy

     

       34
       34
       +
       way to get started but it is not recommended in the real world because

     

       35
       35
       +
       the `livebook.env` file will be added to the world-readable Nix store.

     

       36
       36
       +
       A better approach would be to put the password in some secure

     

       37
       37
       +
       user-readable location and set `environmentFile = /home/user/secure/livebook.env`.

     

       38
       38
       +
       

     

       39
       39
       +
       :::

+90

nixos/modules/services/development/livebook.nix

···

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

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       let

     

       5
       5
       +
         cfg = config.services.livebook;

     

       6
       6
       +
       in

     

       7
       7
       +
       {

     

       8
       8
       +
         options.services.livebook = {

     

       9
       9
       +
           # Since livebook doesn't have a granular permission system (a user

     

       10
       10
       +
           # either has access to all the data or none at all), the decision

     

       11
       11
       +
           # was made to run this as a user service.  If that changes in the

     

       12
       12
       +
           # future, this can be changed to a system service.

     

       13
       13
       +
           enableUserService = mkEnableOption "a user service for Livebook";

     

       14
       14
       +
       

     

       15
       15
       +
           environmentFile = mkOption {

     

       16
       16
       +
             type = types.path;

     

       17
       17
       +
             description = lib.mdDoc ''

     

       18
       18
       +
               Environment file as defined in {manpage}`systemd.exec(5)` passed to the service.

     

       19
       19
       +
       

     

       20
       20
       +
               This must contain at least `LIVEBOOK_PASSWORD` or

     

       21
       21
       +
               `LIVEBOOK_TOKEN_ENABLED=false`.  See `livebook server --help`

     

       22
       22
       +
               for other options.'';

     

       23
       23
       +
           };

     

       24
       24
       +
       

     

       25
       25
       +
           erlang_node_short_name = mkOption {

     

       26
       26
       +
             type = with types; nullOr str;

     

       27
       27
       +
             default = null;

     

       28
       28
       +
             example = "livebook";

     

       29
       29
       +
             description = "A short name for the distributed node.";

     

       30
       30
       +
           };

     

       31
       31
       +
       

     

       32
       32
       +
           erlang_node_name = mkOption {

     

       33
       33
       +
             type = with types; nullOr str;

     

       34
       34
       +
             default = null;

     

       35
       35
       +
             example = "livebook@127.0.0.1";

     

       36
       36
       +
             description = "The name for the app distributed node.";

     

       37
       37
       +
           };

     

       38
       38
       +
       

     

       39
       39
       +
           port = mkOption {

     

       40
       40
       +
             type = types.port;

     

       41
       41
       +
             default = 8080;

     

       42
       42
       +
             description = "The port to start the web application on.";

     

       43
       43
       +
           };

     

       44
       44
       +
       

     

       45
       45
       +
           address = mkOption {

     

       46
       46
       +
             type = types.str;

     

       47
       47
       +
             default = "127.0.0.1";

     

       48
       48
       +
             description = lib.mdDoc ''

     

       49
       49
       +
               The address to start the web application on.  Must be a valid IPv4 or

     

       50
       50
       +
               IPv6 address.

     

       51
       51
       +
             '';

     

       52
       52
       +
           };

     

       53
       53
       +
       

     

       54
       54
       +
           options = mkOption {

     

       55
       55
       +
             type = with types; attrsOf str;

     

       56
       56
       +
             default = { };

     

       57
       57
       +
             description = lib.mdDoc ''

     

       58
       58
       +
               Additional options to pass as command-line arguments to the server.

     

       59
       59
       +
             '';

     

       60
       60
       +
             example = literalExpression ''

     

       61
       61
       +
               {

     

       62
       62
       +
                 cookie = "a value shared by all nodes in this cluster";

     

       63
       63
       +
               }

     

       64
       64
       +
             '';

     

       65
       65
       +
           };

     

       66
       66
       +
         };

     

       67
       67
       +
       

     

       68
       68
       +
         config = mkIf cfg.enableUserService {

     

       69
       69
       +
           systemd.user.services.livebook = {

     

       70
       70
       +
             serviceConfig = {

     

       71
       71
       +
               Restart = "always";

     

       72
       72
       +
               EnvironmentFile = cfg.environmentFile;

     

       73
       73
       +
               ExecStart =

     

       74
       74
       +
                 let

     

       75
       75
       +
                   args = lib.cli.toGNUCommandLineShell { } ({

     

       76
       76
       +
                     inherit (cfg) port;

     

       77
       77
       +
                     ip = cfg.address;

     

       78
       78
       +
                     name = cfg.erlang_node_name;

     

       79
       79
       +
                     sname = cfg.erlang_node_short_name;

     

       80
       80
       +
                   } // cfg.options);

     

       81
       81
       +
                 in

     

       82
       82
       +
                 "${pkgs.livebook}/bin/livebook server ${args}";

     

       83
       83
       +
             };

     

       84
       84
       +
             path = [ pkgs.bash ];

     

       85
       85
       +
             wantedBy = [ "default.target" ];

     

       86
       86
       +
           };

     

       87
       87
       +
         };

     

       88
       88
       +
       

     

       89
       89
       +
         meta.doc = ./livebook.md;

     

       90
       90
       +
       }

nixos/tests/all-tests.nix

···

       371
       371
        
         honk = runTest ./honk.nix;

     

       372
       372
        
         installed-tests = pkgs.recurseIntoAttrs (handleTest ./installed-tests {});

     

       373
       373
        
         invidious = handleTest ./invidious.nix {};

     

       374
       374
       +
         livebook-service = handleTest ./livebook-service.nix {};

     

       374
       375
        
         oci-containers = handleTestOn ["aarch64-linux" "x86_64-linux"] ./oci-containers.nix {};

     

       375
       376
        
         odoo = handleTest ./odoo.nix {};

     

       376
       377
        
         odoo15 = handleTest ./odoo.nix { package = pkgs.odoo15; };

+43

nixos/tests/livebook-service.nix

···

       1
       1
       +
       import ./make-test-python.nix ({ lib, pkgs, ... }: {

     

       2
       2
       +
         name = "livebook-service";

     

       3
       3
       +
       

     

       4
       4
       +
         nodes = {

     

       5
       5
       +
           machine = { config, pkgs, ... }: {

     

       6
       6
       +
             imports = [

     

       7
       7
       +
               ./common/user-account.nix

     

       8
       8
       +
             ];

     

       9
       9
       +
       

     

       10
       10
       +
             services.livebook = {

     

       11
       11
       +
               enableUserService = true;

     

       12
       12
       +
               port = 20123;

     

       13
       13
       +
               environmentFile = pkgs.writeText "livebook.env" ''

     

       14
       14
       +
                 LIVEBOOK_PASSWORD = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";

     

       15
       15
       +
               '';

     

       16
       16
       +
               options = {

     

       17
       17
       +
                 cookie = "chocolate chip";

     

       18
       18
       +
               };

     

       19
       19
       +
             };

     

       20
       20
       +
           };

     

       21
       21
       +
         };

     

       22
       22
       +
       

     

       23
       23
       +
         testScript = { nodes, ... }:

     

       24
       24
       +
           let

     

       25
       25
       +
             user = nodes.machine.config.users.users.alice;

     

       26
       26
       +
             sudo = lib.concatStringsSep " " [

     

       27
       27
       +
               "XDG_RUNTIME_DIR=/run/user/${toString user.uid}"

     

       28
       28
       +
               "sudo"

     

       29
       29
       +
               "--preserve-env=XDG_RUNTIME_DIR"

     

       30
       30
       +
               "-u"

     

       31
       31
       +
               "alice"

     

       32
       32
       +
             ];

     

       33
       33
       +
           in

     

       34
       34
       +
           ''

     

       35
       35
       +
             machine.wait_for_unit("multi-user.target")

     

       36
       36
       +
       

     

       37
       37
       +
             machine.succeed("loginctl enable-linger alice")

     

       38
       38
       +
             machine.wait_until_succeeds("${sudo} systemctl --user is-active livebook.service")

     

       39
       39
       +
             machine.wait_for_open_port(20123)

     

       40
       40
       +
       

     

       41
       41
       +
             machine.succeed("curl -L localhost:20123 | grep 'Type password'")

     

       42
       42
       +
           '';

     

       43
       43
       +
       })

+5 -1

pkgs/servers/web-apps/livebook/default.nix

···

       1
       1
       -
       { lib, beamPackages, makeWrapper, rebar3, elixir, erlang, fetchFromGitHub }:

     

       1
       1
       +
       { lib, beamPackages, makeWrapper, rebar3, elixir, erlang, fetchFromGitHub, nixosTests }:

     

       2
       2
        
       beamPackages.mixRelease rec {

     

       3
       3
        
         pname = "livebook";

     

       4
       4
        
         version = "0.11.3";

     
···

       31
       31
        
             --prefix PATH : ${lib.makeBinPath [ elixir ]} \

     

       32
       32
        
             --set MIX_REBAR3 ${rebar3}/bin/rebar3

     

       33
       33
        
         '';

     

       34
       34
       +
       

     

       35
       35
       +
         passthru.tests = {

     

       36
       36
       +
           livebook-service = nixosTests.livebook-service;

     

       37
       37
       +
         };

     

       34
       38
        
       

     

       35
       39
        
         meta = with lib; {

     

       36
       40
        
           license = licenses.asl20;