Self-host Joplin Server (joplin-server) on a VPS

A self-hosted sync target for the Joplin note-taking app, replacing Dropbox or OneDrive sync.

levelrail-cli templates deploy joplin-server --name my-joplin-server

Specification

Status
Listed
Category
Productivity
Services
db, joplin
Ports
22300
Volumes
1
Memory
about 256 MiB
arm64
image published
amd64
image published
Settings to fill in
none
License
not yet recorded

About Joplin Server

A self-hosted sync target for the Joplin note-taking app, replacing Dropbox or OneDrive sync. Runs 2 containers (db, joplin), with joplin listening on port 22300; data is kept in named volumes.

What it deploys

Joplin Server runs as 2 services in a single Compose app, listening on port 22300, with 1 named volume mount.

ServiceImageTagPortsVolumes
db postgres 16 none joplin_db_data -> /var/lib/postgresql/data
joplin joplin/server 3.7.2 22300 none

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Listed. It is in the catalog. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 22300 directly on the host, so open them in the VPS firewall only if you want that.

Settings and environment

You do not have to fill in anything. 2 secrets are generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
dbPOSTGRES_DBPreset by the template
dbPOSTGRES_PASSWORDGenerated at deploy
dbPOSTGRES_USERPreset by the template
joplinAPP_BASE_URLPreset by the template
joplinDB_CLIENTPreset by the template
joplinPOSTGRES_DATABASEPreset by the template
joplinPOSTGRES_HOSTPreset by the template
joplinPOSTGRES_PASSWORDGenerated at deploy
joplinPOSTGRES_USERPreset by the template

Install Joplin Server on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get joplin-server
  4. Deploy it

    This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.

    levelrail-cli templates deploy joplin-server --name my-joplin-server

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Joplin Server.

More in Productivity

All Productivity templates