Self-host Joplin Server (joplin) on a VPS
A self-hosted sync server for the Joplin note-taking app, keeping notes off third-party clouds.
levelrail-cli templates deploy joplin --name my-joplinSpecification
- Status
- Listed
- Category
- Productivity
- Services
- joplin, postgres
- Ports
- 22300
- Volumes
- 1
- Memory
- about 512 MiB
- arm64
- image published
- amd64
- image published
- Settings to fill in
- none
- License
- not yet recorded
About Joplin Server
A self-hosted sync server for the Joplin note-taking app, keeping notes off third-party clouds. Runs 2 containers (joplin, postgres), 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.
| Service | Image | Tag | Ports | Volumes |
|---|---|---|---|---|
| joplin | joplin/server | latest | 22300 | none |
| postgres | postgres | 16 | none | joplin_postgres_data -> /var/lib/postgresql/data |
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.
- Review. Image is not pinned to a version tag, so a redeploy can pull different code (joplin/server:latest).
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.
| Service | Variable | Value |
|---|---|---|
| joplin | APP_BASE_URL | Preset by the template |
| joplin | DB_CLIENT | Preset by the template |
| joplin | POSTGRES_DATABASE | Preset by the template |
| joplin | POSTGRES_HOST | Preset by the template |
| joplin | POSTGRES_PASSWORD | Generated at deploy |
| joplin | POSTGRES_PORT | Preset by the template |
| joplin | POSTGRES_USER | Preset by the template |
| postgres | POSTGRES_DB | Preset by the template |
| postgres | POSTGRES_PASSWORD | Generated at deploy |
| postgres | POSTGRES_USER | Preset by the template |
Install Joplin Server on a VPS
-
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 -
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 | shif the machine does not have it. See Getting started.levelrail-cli login --device -
Read the template
Shows the entry, including its full compose.yaml.
levelrail-cli templates get joplin -
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 --name my-joplin
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.
Docs and upstream
More in Productivity
- Joplin ServerA self-hosted sync target for the Joplin note-taking app, replacing Dropbox or OneDrive sync.
- KanboardA minimalist, keyboard-friendly kanban board for personal and team task tracking.
- KarakeepA self-hosted bookmark, note, and read-it-later manager with full-text search and tagging.
- IssoA lightweight self-hosted comment server for static sites with a small JavaScript embed. Comments live in a SQLite file on a volume.
- KimaiA self-hosted time tracking tool for freelancers and teams, with invoicing and reporting.
- KitchenOwlA shared grocery list, recipe and expense app for your household, with web and mobile clients.