commit 897d5670a3da4166ad87b115770ad7d587d7238d · pyrox.dev/nixpkgs

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

···

       202
        
       

     

       203
        
         - `nomad_1_4` has been removed, as it is now unsupported upstream.

     

       204
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       205
        
       ## Other Notable Changes {#sec-release-24.05-notable-changes}

     

       206
        
       

     

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

···

       202
        
       

     

       203
        
         - `nomad_1_4` has been removed, as it is now unsupported upstream.

     

       204
        
       

     

       205
       +
       - The `livebook` package is now built as a `mix release` instead of an `escript`.

     

       206
       +
         This means that configuration now has to be done using [environment variables](https://hexdocs.pm/livebook/readme.html#environment-variables) instead of command line arguments.

     

       207
       +
         This has the further implication that the `livebook` service configuration has changed:

     

       208
       +
       

     

       209
       +
         - The `erlang_node_short_name`, `erlang_node_name`, `port` and `options` configuration parameters are gone, and have been replaced with an `environment` parameter.

     

       210
       +
           Use the appropriate [environment variables](https://hexdocs.pm/livebook/readme.html#environment-variables) inside `environment` to configure the service instead.

     

       211
       +
       

     

       212
        
       ## Other Notable Changes {#sec-release-24.05-notable-changes}

     

       213
        
       

     

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

+15 -9

nixos/modules/services/development/livebook.md

···

       15
        
       {

     

       16
        
         services.livebook = {

     

       17
        
           enableUserService = true;

     

       18
       -
           port = 20123;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       19
        
           # See note below about security

     

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

     

       21
       -
             LIVEBOOK_PASSWORD = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

     

       22
       -
           '';

     

       23
        
         };

     

       24
        
       }

     

       25
        
       ```

     
···

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

     

       31
        
       recommended.

     

       32
        
       

     

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

     

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

     

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

     

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

     

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

     

       38
        
       

     

       39
        
       :::

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       40
        
       

     

       41
        
       ### Extra dependencies {#module-services-livebook-extra-dependencies}

     

       42

···

       15
        
       {

     

       16
        
         services.livebook = {

     

       17
        
           enableUserService = true;

     

       18
       +
           environment = {

     

       19
       +
             LIVEBOOK_PORT = 20123;

     

       20
       +
             LIVEBOOK_PASSWORD = "mypassword";

     

       21
       +
           };

     

       22
        
           # See note below about security

     

       23
       +
           environmentFile = "/var/lib/livebook.env";

     

       0
        
       
     

       0
        
       
     

       24
        
         };

     

       25
        
       }

     

       26
        
       ```

     
···

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

     

       32
        
       recommended.

     

       33
        
       

     

       34
       +
       Putting the password in the Nix configuration like above is an easy way to get

     

       35
       +
       started but it is not recommended in the real world because the resulting

     

       36
       +
       environment variables can be read by unprivileged users.  A better approach

     

       37
       +
       would be to put the password in some secure user-readable location and set

     

       38
       +
       `environmentFile = /home/user/secure/livebook.env`.

     

       39
        
       

     

       40
        
       :::

     

       41
       +
       

     

       42
       +
       The [Livebook

     

       43
       +
       documentation](https://hexdocs.pm/livebook/readme.html#environment-variables)

     

       44
       +
       lists all the applicable environment variables. It is recommended to at least

     

       45
       +
       set `LIVEBOOK_PASSWORD` or `LIVEBOOK_TOKEN_ENABLED=false`.

     

       46
        
       

     

       47
        
       ### Extra dependencies {#module-services-livebook-extra-dependencies}

     

       48

+50 -50

nixos/modules/services/development/livebook.nix

···

       14
        
       

     

       15
        
           package = mkPackageOption pkgs "livebook" { };

     

       16
        
       

     

       17
       -
           environmentFile = mkOption {

     

       18
       -
             type = types.path;

     

       0
        
       
     

       19
        
             description = lib.mdDoc ''

     

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

     

       21
        
       

     

       22
       -
               This must contain at least `LIVEBOOK_PASSWORD` or

     

       23
       -
               `LIVEBOOK_TOKEN_ENABLED=false`.  See `livebook server --help`

     

       24
       -
               for other options.'';

     

       25
       -
           };

     

       26
       -
       

     

       27
       -
           erlang_node_short_name = mkOption {

     

       28
       -
             type = with types; nullOr str;

     

       29
       -
             default = null;

     

       30
       -
             example = "livebook";

     

       31
       -
             description = "A short name for the distributed node.";

     

       32
       -
           };

     

       33
       -
       

     

       34
       -
           erlang_node_name = mkOption {

     

       35
       -
             type = with types; nullOr str;

     

       36
       -
             default = null;

     

       37
       -
             example = "livebook@127.0.0.1";

     

       38
       -
             description = "The name for the app distributed node.";

     

       39
       -
           };

     

       40
        
       

     

       41
       -
           port = mkOption {

     

       42
       -
             type = types.port;

     

       43
       -
             default = 8080;

     

       44
       -
             description = "The port to start the web application on.";

     

       45
       -
           };

     

       0
        
       
     

       0
        
       
     

       46
        
       

     

       47
       -
           address = mkOption {

     

       48
       -
             type = types.str;

     

       49
       -
             default = "127.0.0.1";

     

       50
       -
             description = lib.mdDoc ''

     

       51
       -
               The address to start the web application on.  Must be a valid IPv4 or

     

       52
       -
               IPv6 address.

     

       53
        
             '';

     

       54
       -
           };

     

       55
        
       

     

       56
       -
           options = mkOption {

     

       57
       -
             type = with types; attrsOf str;

     

       58
       -
             default = { };

     

       59
       -
             description = lib.mdDoc ''

     

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

     

       61
       -
             '';

     

       62
        
             example = literalExpression ''

     

       63
        
               {

     

       64
       -
                 cookie = "a value shared by all nodes in this cluster";

     

       65
        
               }

     

       66
        
             '';

     

       67
        
           };

     

       68
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       69
        
           extraPackages = mkOption {

     

       70
        
             type = with types; listOf package;

     

       71
        
             default = [ ];

     
···

       81
        
             serviceConfig = {

     

       82
        
               Restart = "always";

     

       83
        
               EnvironmentFile = cfg.environmentFile;

     

       84
       -
               ExecStart =

     

       85
       -
                 let

     

       86
       -
                   args = lib.cli.toGNUCommandLineShell { } ({

     

       87
       -
                     inherit (cfg) port;

     

       88
       -
                     ip = cfg.address;

     

       89
       -
                     name = cfg.erlang_node_name;

     

       90
       -
                     sname = cfg.erlang_node_short_name;

     

       91
       -
                   } // cfg.options);

     

       92
       -
                 in

     

       93
       -
                   "${cfg.package}/bin/livebook server ${args}";

     

       94
        
             };

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       95
        
             path = [ pkgs.bash ] ++ cfg.extraPackages;

     

       96
        
             wantedBy = [ "default.target" ];

     

       97
        
           };

···

       14
        
       

     

       15
        
           package = mkPackageOption pkgs "livebook" { };

     

       16
        
       

     

       17
       +
           environment = mkOption {

     

       18
       +
             type = with types; attrsOf (nullOr (oneOf [ bool int str ]));

     

       19
       +
             default = { };

     

       20
        
             description = lib.mdDoc ''

     

       21
       +
               Environment variables to set.

     

       22
        
       

     

       23
       +
               Livebook is configured through the use of environment variables. The

     

       24
       +
               available configuration options can be found in the [Livebook

     

       25
       +
               documentation](https://hexdocs.pm/livebook/readme.html#environment-variables).

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       26
        
       

     

       27
       +
               Note that all environment variables set through this configuration

     

       28
       +
               parameter will be readable by anyone with access to the host

     

       29
       +
               machine. Therefore, sensitive information like {env}`LIVEBOOK_PASSWORD`

     

       30
       +
               or {env}`LIVEBOOK_COOKIE` should never be set using this configuration

     

       31
       +
               option, but should instead use

     

       32
       +
               [](#opt-services.livebook.environmentFile). See the documentation for

     

       33
       +
               that option for more information.

     

       34
        
       

     

       35
       +
               Any environment variables specified in the

     

       36
       +
               [](#opt-services.livebook.environmentFile) will supersede environment

     

       37
       +
               variables specified in this option.

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       38
        
             '';

     

       0
        
       
     

       39
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       40
        
             example = literalExpression ''

     

       41
        
               {

     

       42
       +
                 LIVEBOOK_PORT = 8080;

     

       43
        
               }

     

       44
        
             '';

     

       45
        
           };

     

       46
        
       

     

       47
       +
           environmentFile = mkOption {

     

       48
       +
             type = with types; nullOr types.path;

     

       49
       +
             default = null;

     

       50
       +
             description = lib.mdDoc ''

     

       51
       +
               Additional dnvironment file as defined in {manpage}`systemd.exec(5)`.

     

       52
       +
       

     

       53
       +
               Secrets like {env}`LIVEBOOK_PASSWORD` (which is used to specify the

     

       54
       +
               password needed to access the livebook site) or {env}`LIVEBOOK_COOKIE`

     

       55
       +
               (which is used to specify the

     

       56
       +
               [cookie](https://www.erlang.org/doc/reference_manual/distributed.html#security)

     

       57
       +
               used to connect to the running Elixir system) may be passed to the

     

       58
       +
               service without making them readable to everyone with access to

     

       59
       +
               systemctl by using this configuration parameter.

     

       60
       +
       

     

       61
       +
               Note that this file needs to be available on the host on which

     

       62
       +
               `livebook` is running.

     

       63
       +
       

     

       64
       +
               For security purposes, this file should contain at least

     

       65
       +
               {env}`LIVEBOOK_PASSWORD` or {env}`LIVEBOOK_TOKEN_ENABLED=false`.

     

       66
       +
       

     

       67
       +
               See the [Livebook

     

       68
       +
               documentation](https://hexdocs.pm/livebook/readme.html#environment-variables)

     

       69
       +
               and the [](#opt-services.livebook.environment) configuration parameter

     

       70
       +
               for further options.

     

       71
       +
             '';

     

       72
       +
             example = "/var/lib/livebook.env";

     

       73
       +
           };

     

       74
       +
       

     

       75
        
           extraPackages = mkOption {

     

       76
        
             type = with types; listOf package;

     

       77
        
             default = [ ];

     
···

       87
        
             serviceConfig = {

     

       88
        
               Restart = "always";

     

       89
        
               EnvironmentFile = cfg.environmentFile;

     

       90
       +
               ExecStart = "${cfg.package}/bin/livebook start";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       91
        
             };

     

       92
       +
             environment = mapAttrs (name: value:

     

       93
       +
               if isBool value then boolToString value else toString value)

     

       94
       +
               cfg.environment;

     

       95
        
             path = [ pkgs.bash ] ++ cfg.extraPackages;

     

       96
        
             wantedBy = [ "default.target" ];

     

       97
        
           };

+6 -4

nixos/tests/livebook-service.nix

···

       9
        
       

     

       10
        
             services.livebook = {

     

       11
        
               enableUserService = true;

     

       12
       -
               port = 20123;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

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

     

       14
        
                 LIVEBOOK_PASSWORD = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

     

       15
        
               '';

     

       16
       -
               options = {

     

       17
       -
                 cookie = "chocolate chip";

     

       18
       -
               };

     

       19
        
             };

     

       20
        
           };

     

       21
        
         };

···

       9
        
       

     

       10
        
             services.livebook = {

     

       11
        
               enableUserService = true;

     

       12
       +
               environment = {

     

       13
       +
                 LIVEBOOK_PORT = 20123;

     

       14
       +
                 LIVEBOOK_COOKIE = "chocolate chip";

     

       15
       +
                 LIVEBOOK_TOKEN_ENABLED = true;

     

       16
       +
       

     

       17
       +
               };

     

       18
        
               environmentFile = pkgs.writeText "livebook.env" ''

     

       19
        
                 LIVEBOOK_PASSWORD = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

     

       20
        
               '';

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       21
        
             };

     

       22
        
           };

     

       23
        
         };

+3 -7

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

···

       22
        
           hash = "sha256-dyKhrbb7vazBV6LFERtGHLQXEx29vTgn074mY4fsHy4=";

     

       23
        
         };

     

       24
        
       

     

       25
       -
         installPhase = ''

     

       26
       -
           mix escript.build

     

       27
       -
           mkdir -p $out/bin

     

       28
       -
           mv ./livebook $out/bin

     

       29
       -
       

     

       30
        
           wrapProgram $out/bin/livebook \

     

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

     

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

     

       33
       -
         '';

     

       34
        
       

     

       35
        
         passthru.tests = {

     

       36
        
           livebook-service = nixosTests.livebook-service;

···

       22
        
           hash = "sha256-dyKhrbb7vazBV6LFERtGHLQXEx29vTgn074mY4fsHy4=";

     

       23
        
         };

     

       24
        
       

     

       25
       +
         postInstall = ''

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       26
        
           wrapProgram $out/bin/livebook \

     

       27
       +
             --prefix PATH : ${lib.makeBinPath [ elixir erlang ]} \

     

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

     

       29
       +
           '';

     

       30
        
       

     

       31
        
         passthru.tests = {

     

       32
        
           livebook-service = nixosTests.livebook-service;