Back to all templates
Joplin Server logo

Joplin Server

Application512MB+ RAM

Sync server for Joplin note-taking app with end-to-end encryption

notessyncencryptedmarkdown

Deploy Joplin Server in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select Joplin Server

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy Joplin Server on a VPS with Server Compass

Use the Joplin Server template in Server Compass to deploy a self-hosted Joplin sync server with PostgreSQL on your VPS, then verify the Joplin Server web UI in a browser.

About 7 minutesBrowser verified
1
Step 1

Open the server Apps tab

Select your VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating a Joplin Server app
2
Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template
3
Step 3

Search for Joplin Server

Use the template picker search to find Joplin Server in the Server Compass template catalog.

Searching for Joplin Server in the Server Compass template picker
4
Step 4

Select the Joplin Server template

Choose the Joplin Server template. Server Compass fills the Joplin Server image, host port, generated database secret and persistent PostgreSQL volume.

Joplin Server template selected in Server Compass
5
Step 5

Review the Joplin Server settings

Confirm the app name and compose services. In this run, the app was named joplin-demo and used host port 22300.

Reviewing Joplin Server project settings and compose services
6
Step 6

Deploy Joplin Server

Review the generated environment values, confirm the port is available, and click Deploy Now.

Reviewing Joplin Server environment variables and port before deployment
7
Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the Joplin Server image, starts the container, and verifies the stack.

Server Compass deploying the Joplin Server template on the VPS
8
Step 8

Confirm Joplin Server is running

After deployment finishes, return to the Apps tab and confirm the Joplin Server app is marked Running with its application URL available.

Joplin Server template running in the Server Compass Apps tab
9
Step 9

Open Joplin Server in the browser

Open the application URL in a browser. The Joplin Server web UI confirms the site is reachable.

The deployed Joplin Server web UI loaded in a browser

After Joplin Server Opens

  • Sign in with the default Joplin Server admin account and change its password before production use.
  • Configure HTTPS, user accounts, and Joplin desktop or mobile sync clients before production use.
  • Add a domain and HTTPS before exposing the Joplin Server admin UI to users.
  • Back up the Joplin Server PostgreSQL volume before relying on it for production sync.

Verified Result

The Joplin Server web UI loaded successfully in a browser.

Joplin Server deployment questions

What does the Joplin Server template deploy?

It deploys Joplin Server with PostgreSQL backing services plus persistent database volumes.

Which port did the tutorial use?

The tutorial used host port 22300, which maps to the Joplin Server web server on container port 22300.

Why does the guide stop at the first-run web UI?

The tutorial verifies the clean first-run web UI because real users, sync clients, notes, and access rules depend on the production server.

Should this become a blog post?

No. The deployment guide should live on the Joplin Server template detail page and be linked from the reusable template deployment docs page.

Why Self-Host Joplin Server?

Joplin Server provides sync infrastructure for the Joplin note-taking app, enabling end-to-end encrypted synchronization across all your devices. Self-hosting the sync server means your encrypted notes only touch infrastructure you control — not Joplin Cloud, Dropbox, or any third party.

End-to-end encrypted note sync across desktop, mobile, and web
Your encrypted notes never touch third-party sync services
Markdown-based notes with rich editing and attachments
Share notebooks with team members on your server
No cloud sync subscription fees — unlimited devices and notes

Joplin Server vs Alternatives

Joplin Server vs Joplin Cloud

Joplin Cloud charges a monthly subscription. Self-hosting is a one-time setup with no recurring fees for unlimited sync.

Joplin Server vs Obsidian Sync

Obsidian Sync is proprietary and paid. Self-hosted Joplin Server gives you full control over sync infrastructure.

Joplin Server vs Standard Notes

Standard Notes is simpler but less feature-rich. Joplin supports plugins, web clipper, and rich markdown editing.

Why Deploy Joplin Server with Server Compass?

Server Compass deploys Joplin Server with PostgreSQL for reliable sync data storage. Just point your Joplin desktop and mobile apps at your server URL and sync is ready.

Download Server Compass

After Deployment

After deploying Joplin Server with Server Compass, complete these steps to finish setup

1

Create admin account

2

Configure Joplin desktop/mobile clients to sync

3

Enable end-to-end encryption

Need help? Check out our documentation for detailed guides.

Joplin Server FAQ

Common questions about self-hosting Joplin Server

How do I deploy Joplin Server with Server Compass?

Simply download Server Compass, connect to your VPS, and select Joplin Server from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for Joplin Server?

Joplin Server requires a minimum of 512MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing Joplin Server data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Joplin Server backup and restore procedures.

How do I update Joplin Server to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Joplin Server image will be pulled and deployed with zero downtime.

Is Joplin Server free to self-host?

Joplin Server is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Ready to Self-Host Joplin Server?

Download Server Compass and deploy Joplin Server to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass