Self-host Livebook with Levelrail

Interactive and collaborative code notebooks for Elixir with a built in package manager and visualizations. A generated password protects the editor.

  • Authorlivebook-dev
  • LicenceApache-2.0
  • Memory512 MiB
  • Services1

How to self-host Livebook

  1. Pull the images

    One image is pulled on your server.

    Show images
    • ghcr.io/livebook-dev/livebook:0.19.10
  2. Create the app

    One service starts in a single Compose app, with 1 named volume mount for your data, on port 8080.

  3. Fill in the secrets

    1 secret is generated and stored encrypted, 1 setting is preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

After the first start

  • Sign in with the generated password shown in the deployment variables. Notebooks run code in this container, so keep the address private.

Livebook requirements

Memory
About 512 MiB
Architectures
amd64 unknown, arm64 unknown
Ports
8080
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
Apache-2.0, permissive license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Livebook. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the Livebook docs page.

Deploy Livebook your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy Livebook from the CLI

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain livebook=app.example.com.

levelrail-cli templates install livebook --name my-livebook

Deploy Livebook with the API

Create a token in the dashboard first. Name, env and domains are the request fields.

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/livebook/install \
  -d '{
    "name": "my-livebook"
  }'

Livebook configuration

Livebook services

ServiceImagePortsVolumes
livebook ghcr.io/livebook-dev/livebook:0.19.10 8080 data -> /data

Livebook environment variables

VariableServiceValue
LIVEBOOK_IP livebook Preset by the template
LIVEBOOK_PASSWORD livebook Generated at deploy

Ports and volumes

Ports
8080
Volumes
1 named mount: data -> /data

Livebook FAQ

How much memory does Livebook need?

The catalog lists about 512 MiB of memory for Livebook.

Does Livebook run on arm64?

For Livebook, arm64 support is not confirmed; amd64 is unknown.

What licence is Livebook under?

Livebook is licensed under Apache-2.0, which is permissive, with few conditions on reuse.

Does Livebook need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which ports does Livebook use?

Livebook listens on port 8080 inside the stack.

Where does Livebook keep its data?

In a named volume: data mounted at /data.

Can I deploy Livebook on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for Livebook, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image ghcr.io/livebook-dev/livebook:0.19.10 is what you deploy there.

levelrail-cli templates install livebook --name my-livebook