depot/third_party/nixpkgs/nixos/modules/services/development/livebook.md
Default email 60f07311b9 Project import generated by Copybara.
GitOrigin-RevId: f8e2ebd66d097614d51a56a755450d4ae1632df1
2024-02-06 17:22:34 -08:00

1.7 KiB

Livebook

Livebook is a web application for writing interactive and collaborative code notebooks.

Basic Usage

Enabling the livebook service creates a user systemd unit which runs the server.

{ ... }:

{
  services.livebook = {
    enableUserService = true;
    environment = {
      LIVEBOOK_PORT = 20123;
      LIVEBOOK_PASSWORD = "mypassword";
    };
    # See note below about security
    environmentFile = "/var/lib/livebook.env";
  };
}

::: {.note}

The Livebook server has the ability to run any command as the user it is running under, so securing access to it with a password is highly recommended.

Putting the password in the Nix configuration like above is an easy way to get started but it is not recommended in the real world because the resulting environment variables can be read by unprivileged users. A better approach would be to put the password in some secure user-readable location and set environmentFile = /home/user/secure/livebook.env.

:::

The Livebook documentation lists all the applicable environment variables. It is recommended to at least set LIVEBOOK_PASSWORD or LIVEBOOK_TOKEN_ENABLED=false.

Extra dependencies

By default, the Livebook service is run with minimum dependencies, but some features require additional packages. For example, the machine learning Kinos require gcc and gnumake. To add these, use extraPackages:

services.livebook.extraPackages = with pkgs; [ gcc gnumake ];