joplin-server v0.1.0

Apps

Joplin Server — the self-hosted sync backend for the Joplin note-taking apps: keep your notes, notebooks, and attachments in sync across desktop and mobile with end-to-end encryption, and share notebooks with others. Deployed as an all-in-one host-networked Nomad job: the Joplin Server app plus a PostgreSQL sidecar with a persistent database volume.

nomad-pack run joplin-server --registry nomploy

…or one line (add registry + run)

curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- joplin-server

Needs nomad-pack on PATH. The script only adds the nomploy registry and runs this pack.

Source ↗ Project ↗ ★ 56.5k ⚑ Report an issue

2 tasks http 22300db 5432 1 volume image joplin/server:latest tracks :latest image bumped today

Variables 13

values.hcl

Save as values.hcl, edit, then run:

nomad-pack run joplin-server -f values.hcl --registry nomploy

# The name of the Nomad job.
job_name = "joplin-server"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The Joplin Server container image. Pin a tag in production.
image = "joplin/server:latest"

# The PostgreSQL image for the bundled database.
postgres_image = "postgres:16-alpine"

# Host port for the Joplin Server web app (APP_PORT).
port = 22300

# Host port for the co-located PostgreSQL.
db_port = 5432

# Password for the Joplin PostgreSQL user.
db_password = "joplin"

# Public base URL Joplin Server is served at (APP_BASE_URL). Empty = http://localhost:<port>. Set this to your real host/domain — clients connect to it.
base_url = ""

# Named volume for PostgreSQL data (/var/lib/postgresql/data). Holds all synced notes.
db_data_volume = "joplin_db_data"

# Placement constraints. Pin to the node holding the volume. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# Resources for the Joplin Server app task.
resources = {
    cpu    = 500
    memory = 512
  }

# Resources for the PostgreSQL task.
postgres_resources = {
    cpu    = 300
    memory = 256
  }

Name	Type	Default	Description
job_name	string	"joplin-server"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"joplin/server:latest"	The Joplin Server container image. Pin a tag in production.
postgres_image	string	"postgres:16-alpine"	The PostgreSQL image for the bundled database.
port	number	22300	Host port for the Joplin Server web app (APP_PORT).
db_port	number	5432	Host port for the co-located PostgreSQL.
db_password key	string	"joplin"	Password for the Joplin PostgreSQL user.
base_url	string	""	Public base URL Joplin Server is served at (APP_BASE_URL). Empty = http://localhost:<port>. Set this to your real host/domain — clients connect to it.
db_data_volume	string	"joplin_db_data"	Named volume for PostgreSQL data (/var/lib/postgresql/data). Holds all synced notes.
constraints	list	[]	Placement constraints. Pin to the node holding the volume. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources	object	{ cpu = 500 memory = 512 }	Resources for the Joplin Server app task.
postgres_resources	object	{ cpu = 300 memory = 256 }	Resources for the PostgreSQL task.

Back up this pack

This pack stores data in one Docker named volume: joplin_db_data

⚠ This pack bundles a database. A cold copy of the volume can be inconsistent — for a reliable backup, dump the DB (pg_dump / mysqldump) or stop the job while backing up.

restic

# Run on the node hosting this pack. Point restic at your repo first:
#   export RESTIC_REPOSITORY="s3:https://<account>.r2.cloudflarestorage.com/<bucket>"
#   export RESTIC_PASSWORD="<repo-password>"
#   export AWS_ACCESS_KEY_ID=<key>  AWS_SECRET_ACCESS_KEY=<secret>
restic backup \
  /var/lib/docker/volumes/joplin_db_data/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/joplin_db_data/_data backup:<bucket>/joplin_db_data

Paths assume the default Docker volume location (/var/lib/docker/volumes). Restore by stopping the job, restoring files into the same volume, and re-running the pack.

Readme

joplin-server

Joplin Server — the self-hosted sync backend for the Joplin note-taking apps. Keep notes, notebooks, tags, and attachments in sync across desktop and mobile, with end-to-end encryption and notebook sharing between users — all on your own infrastructure.

All-in-one host-networked Nomad job: the Joplin Server app plus a PostgreSQL sidecar. Database migrations run automatically on boot.

Deploy

nomad-pack registry add nomploy https://github.com/Nomploy/nomad-packs
nomad-pack run joplin-server --registry=nomploy

Configure

Variable	Default	Description
`port`	`22300`	Web app port (`APP_PORT`).
`base_url`	`""` → `http://localhost:<port>`	`APP_BASE_URL` — set to your real domain; clients sync against it.
`db_password`	`joplin`	PostgreSQL password.
`db_port`	`5432`	Host port for the bundled PostgreSQL.
`db_data_volume`	`joplin_db_data`	`/var/lib/postgresql/data` — all synced notes.
`image`	`joplin/server:latest`	App image. Pin a tag in production.
`resources` / `postgres_resources`	see `variables.hcl`	Per-task resources.

Log in to the admin panel at http://<node-ip>:22300 with admin@localhost / admin and change the password immediately. In the Joplin apps, choose the Joplin Server sync target and enter your base_url plus your account email/password. Set base_url correctly — clients rely on it. Serves plain HTTP — front it with a reverse proxy for TLS. Pin the job to the node holding the volume with constraints.