App Store template
Joplin Server icon

Joplin Server

Open-source note synchronization server for Joplin clients, teams, publishing, and sharing.

Launch in your Sealos workspace.

SourceDeploy guide Website
Joplin Server template preview
Template previewFull screenshot
Template deployments
13 on Sealos
Deployment
Your own instance
Category
Tools

About this template

Overview

Joplin Server is the open-source synchronization backend for Joplin notes, users, sharing, and publishing. This template deploys Joplin Server 3.7.1 with PostgreSQL and HTTPS ingress on Sealos Cloud.

From the documentation

Joplin Server stores note metadata, note contents, attachments, users, sessions, shares, and publishing state for Joplin desktop and mobile clients. It provides the admin web UI and sync API on the same HTTP service.

How to deploy Joplin Server

  1. Choose Deploy now to start Joplin Server in your Sealos workspace.
  2. Sign in to Sealos and review the template configuration in your workspace.
  3. Launch the template, then inspect the application status and resource cards in Canvas.

Resources to plan for

Start with the resources defined by the Joplin Server template. Review CPU, memory, persistent storage, and network allocations for every service in Canvas. Capacity needs depend on your data and workload; monitor usage as they grow.

Template configuration and setup

Access after deployment

Use the application URL or connection details shown in Canvas. Follow the deployment guide for first-time account setup or client configuration, and keep generated credentials available for that step.

Hosting and billing

Sealos monthly plans include compute, memory, storage, and traffic. Size your plan for all deployed services. Software licenses and external AI or API services may have separate terms and charges. Confirm the applicable plan and optional charges in Cost Center.

Compare Sealos resource plans
Read full documentationCollapse documentation

For current cloud charges, refer to Sealos plan pricing. Upstream documentation may reference earlier billing models.

Deploy and Host Joplin Server on Sealos

Joplin Server is the open-source synchronization backend for Joplin notes, users, sharing, and publishing. This template deploys Joplin Server 3.7.1 with PostgreSQL and HTTPS ingress on Sealos Cloud.

Joplin Screenshot

About Hosting Joplin Server

Joplin Server stores note metadata, note contents, attachments, users, sessions, shares, and publishing state for Joplin desktop and mobile clients. It provides the admin web UI and sync API on the same HTTP service.

This Sealos template provisions a PostgreSQL cluster, a database initialization job that creates the joplin database, the Joplin Server container, HTTPS ingress, and an App launcher entry. The template follows the official server profile from the Joplin Docker Compose example and uses an external PostgreSQL database.

Common Use Cases

  • Personal Note Sync: Sync notes and resources across Joplin desktop and mobile clients.
  • Team Note Hosting: Create users and manage team note synchronization from one server.
  • Self-Hosted Publishing: Host shared notes and published content from your own workspace.
  • Private Knowledge Base: Keep note data inside a controlled Sealos environment.

Dependencies for Joplin Server Hosting

The Sealos template includes all required runtime dependencies: Joplin Server, PostgreSQL, a database init job, Service, Ingress, and App launcher entry.

Deployment Dependencies

Implementation Details

Architecture Components
  • Joplin Server: Runs the web UI and sync API on port 22300
  • PostgreSQL: Stores users, notes, item metadata, sessions, and sync state
  • Database Init Job: Creates the joplin database before the app starts
  • Ingress: Exposes the server over HTTPS with APP_BASE_URL aligned to the Sealos URL
Resource Allocation
ComponentCPU RequestCPU LimitMemory RequestMemory Limit
Joplin Server20m200m25Mi256Mi
PostgreSQL50m500m51Mi512Mi
Configuration

Joplin Server is configured with DB_CLIENT=pg, the Sealos public APP_BASE_URL, and PostgreSQL credentials from KubeBlocks-managed secrets. The container health probes use TCP checks because Joplin enforces origin checks on HTTP requests.

License Information

Joplin is licensed under the AGPL-3.0 License. This template follows the licensing policy of the Sealos templates repository.

Why Deploy Joplin Server on Sealos?

Sealos is an AI-assisted Cloud Operating System built on Kubernetes that simplifies deployment and operations. By deploying Joplin Server on Sealos, you get:

  • One-Click Deployment: Launch Joplin Server with PostgreSQL and HTTPS from one template page.
  • Managed PostgreSQL: Store note sync data in a managed KubeBlocks PostgreSQL cluster.
  • Public Sync URL: Use the generated HTTPS URL as the Joplin sync target.
  • Simple Operations: Adjust resources and inspect logs from the Sealos Canvas.

Deployment Guide

  1. Open the Joplin template and click Deploy Now.
  2. Review the generated parameters in the popup dialog and deploy.
  3. Wait for PostgreSQL, the init job, and Joplin Server to become ready.
  4. Open the generated URL and sign in with the default admin account:
    • Email: admin@localhost
    • Password: admin
  5. Open the profile menu and change the admin password. Then create a sync user for regular Joplin clients.

Configuration

Use the Joplin admin UI to create users and manage accounts. Use Sealos Canvas to adjust CPU, memory, hostname, or database storage.

In a Joplin client, set the sync target to Joplin Server and use the generated Sealos HTTPS URL.

Scaling

This template is designed for a single Joplin Server instance. Start by increasing CPU and memory on the Deployment when sync traffic grows. Increase PostgreSQL storage as note data and attachments grow.

Troubleshooting

Issue: Login uses default credentials

  • Cause: Joplin Server creates admin@localhost / admin on first launch.
  • Solution: Sign in once and immediately change the admin password.

Issue: Sync client cannot connect

  • Cause: The client sync URL or user credentials are incorrect.
  • Solution: Set the sync URL to the generated Sealos HTTPS URL and use a created Joplin user account.

Additional Resources

License

This Sealos template follows the licensing policy of the templates repository. Joplin itself is licensed under AGPL-3.0.

From launch to everyday operations

Why deploy
on Sealos

A shorter path from an app you want to an app you can run. Sealos brings deployment and ongoing operations into one place.

  1. One-click deployment

    Start with a ready-made template. Review its configuration and launch from the Sealos console.

  2. Managed Kubernetes

    Run on managed infrastructure with built-in workload scheduling and recovery.

  3. Automatic HTTPS

    Give your application a public HTTPS endpoint with certificates managed for you.

  4. Persistent storage

    Keep application data on persistent volumes across container restarts.

  5. Room to grow

    Adjust CPU, memory, and replicas from the console as your workload changes.

One template. Connected resources.

You Get the Whole Stack

Sealos provisions the resources defined by your template and brings them together in your workspace.

  • App Service

    Container workloads with configurable CPU, memory, and replicas.

  • Public HTTPS URL

    An address for your app, with managed TLS certificates.

  • Database

    A database provisioned alongside your app when the template calls for one.

  • Persistent Volume

    Storage for the files and data your application needs to keep.

  • Environment Variables

    Application settings and secrets configured in one place.

  • Logs & Metrics

    Inspect container logs and resource usage from the console.

Resources and their configuration vary by template. Review the deployment form for this app’s exact setup.

Related templates

Explore more production-ready templates.

More