For the complete documentation index, see llms.txt. This page is also available as Markdown.

🐳Docker

Run your own Alby Hub using Docker or Docker Compose with persistent storage on your computer or server.

Docker is a good option if you already have a computer, home server, VPS, or other system where Docker is installed. It gives you full control over your Alby Hub deployment and keeps your Hub data on storage that you manage.

This guide walks you through creating persistent storage, starting Alby Hub with Docker Compose or a Docker command, opening your Hub in the browser, and updating it later.

Prerequisites

Before you begin, make sure you have:

  • A computer or server that can run continuously

  • Docker installed

  • Docker Compose installed if you plan to use the recommended Docker Compose method

  • Basic familiarity with running terminal commands

Recommended minimum resources:

  • Memory: 512 MB, with 1 GB recommended

  • Swap: 1 GB, with 2 GB recommended on smaller servers

  • Storage: At least 1 GB

  • Persistent storage using a Docker volume or bind mount. The examples in this guide already configure persistent storage.

You can check that Docker and Docker Compose are available using:

docker --version
docker compose version

The exact version numbers may be different depending on your system.

Step 1: Create a working folder for Alby Hub

Create a folder for your Alby Hub deployment:

The albyhub-data folder stores your Hub data outside the container so that it is preserved when the container is restarted or updated.

Do not delete this folder unless you intentionally want to remove your Alby Hub data.

Step 2: Add the Docker Compose file

Docker Compose is the recommended way to run Alby Hub because it keeps the container configuration in a file and makes future updates easier.

You can either download the official Docker Compose file or create it manually.

Option A: Download the Docker Compose file

Run:

If wget is not available, you can use:

Option B: Create the Docker Compose file manually

Create a new file:

Paste the following content:

Remove the # before "9735:9735" if you plan to use LDK as your Lightning backend.

You can also enable:

This restarts the Alby Hub container automatically when Docker or the host system restarts. You will still need to unlock your Hub manually unless auto-unlock is enabled in Alby Hub settings.

Save the file and exit.

In nano, press Ctrl + O, then Enter, then Ctrl + X.

Step 3: Start Alby Hub

Start Alby Hub in the background:

Depending on your Docker installation, you may need to run Docker commands with sudo:

Check that the container is running:

You can also view the logs:

If the logs are running without repeated errors, Alby Hub has started successfully.

Press Ctrl + C to stop following the logs. This does not stop Alby Hub.

Step 4: Open Alby Hub in your browser

If Docker is running on the same computer you are using, open:

If Docker is running on another computer or server, open:

For example:

If you are running Alby Hub on a remote server, make sure port 8080 is allowed through the server and hosting-provider firewall.

If you are using LDK, port 9735 must also be reachable from the internet for Lightning peer communication.

For better security, avoid exposing port 8080 publicly unless necessary. Consider restricting access to your own network, VPN, or IP address, or configuring HTTPS through a reverse proxy.

Step 5: Set up Alby Hub

Click Get Started and follow the setup flow inside Alby Hub.

During setup, save any important recovery or backup information shown by Alby Hub.

Your Hub data is stored in the albyhub-data folder, but you should still maintain your own backups so that you can recover or migrate your Hub later.

How to update Alby Hub with Docker Compose

Alby Hub will show an update banner inside the app when a new version is available.

When you see the update banner, open a terminal and go to your Alby Hub folder:

Pull the newest Alby Hub image:

Recreate the container using the new image:

Check that Alby Hub started cleanly:

Press Ctrl + C to stop following the logs.

Your Alby Hub data remains in the albyhub-data folder and is not removed when the container is recreated.

Alternative: Run Alby Hub with a Docker command

You can also run Alby Hub directly without Docker Compose.

First, create the persistent storage folder:

Then start Alby Hub:

If you plan to use LDK, also publish port 9735:

The ~/albyhub/albyhub-data folder stores your Hub data outside the container so that it is preserved when the container is stopped, removed, or updated.

Docker Compose is generally recommended because it makes the deployment configuration and update process easier to manage.

How to update Alby Hub when using docker run

If you started Alby Hub using the direct docker run command, first pull the newest image:

Stop and remove the existing container:

Then run the same docker run command again.

Removing the container does not remove the data stored in your bind-mounted folder. However, make sure you use the same -v storage path when creating the new container.

You only need to update when Alby Hub shows an update banner or when you know a new release is available.

Last updated

Was this helpful?