How to Host Your Own Joplin Server: A Step-by-Step Guide

Mladen Radivojevic

Mladen Radivojevic

— 3 min read
How to Host Your Own Joplin Server: A Step-by-Step Guide
Notes

In today's digital age, managing information effectively is crucial. From fleeting thoughts to detailed research, note-taking has become an essential part of our daily productivity. While many tools and services are available, hosting your own Joplin server gives you complete control over your data and enhances privacy. Here's how you can set up a Joplin server, whether it's on your home lab, EC2 instance, or any other hosting provider.

Why Self-Host Joplin?

Joplin is an open-source note-taking app that combines rich features with flexibility. Here are some of the key reasons to self-host Joplin:

  • Complete Control: Full ownership of your data.
  • Customization: Tailor the setup to your specific needs, including plugins and configurations.
  • Privacy: Your notes remain private and secure on your own infrastructure.
  • Offline Access: Ensure uninterrupted productivity by syncing locally.

Prerequisites

Before starting, ensure the following are in place:

  1. A server (e.g., a home lab machine, AWS EC2 instance, DigitalOcean droplet, etc.).
  2. A domain name (optional but recommended for easier access).
  3. Docker and Docker Compose installed on your server.

Step 1: Prepare Your Environment

Update Your System: 

sudo apt update && sudo apt upgrade -y

 For CentOS/RedHat-based systems:

 sudo yum update -y

Install Docker:

Follow the official Docker installation guide for your operating system: Install Docker.

Install Docker Compose:

sudo curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

sudo chmod +x /usr/local/bin/docker-compose

Verify Installations:

docker --version
docker-compose --version

Step 2: Set Up Joplin Server with Docker Compose

Create a Project Directory: 

mkdir -p ~/joplin-server && cd ~/joplin-server

Create a docker-compose.yml File: 

services:
  db:
    image: postgres:14
    container_name: joplin_postgres
    restart: always
    environment:
      POSTGRES_DB: joplin
      POSTGRES_USER: joplin
      POSTGRES_PASSWORD: yourpassword
    volumes:
      - postgres_data:/var/lib/postgresql/data

  app:
    image: joplin/server:latest
    container_name: joplin_server
    restart: always
    depends_on:
      - db
    ports:
      - "22300:22300"
    environment:
      APP_PORT: 22300
      DB_CLIENT: pg
      POSTGRES_PASSWORD: yourpassword
      POSTGRES_DATABASE: joplin
      POSTGRES_USER: joplin
      POSTGRES_PORT: 5432
      POSTGRES_HOST: db

volumes:
  postgres_data:

Start the Containers: 

docker-compose up -d

Verify the Setup: Ensure both the joplin_postgres and joplin_server containers are running: 

docker ps

To access the Joplin server with a domain name, configure a reverse proxy with Nginx.

Install Nginx:

 sudo apt install nginx -y

Create an Nginx Configuration File: 

sudo nano /etc/nginx/sites-available/joplin

 Add the following: 

server {
    listen 80;
    server_name yourdomain.com;

    location / {
        proxy_pass http://localhost:22300;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
}

Enable the Configuration:

sudo ln -s /etc/nginx/sites-available/joplin /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl restart nginx

Secure the Connection with Certbot:

Install Certbot and obtain an SSL certificate: 

sudo apt install certbot python3-certbot-nginx -y
sudo certbot --nginx -d yourdomain.com

Step 4: Configure Joplin Clients

  1. Download the Joplin desktop or mobile app from the official website.
  2. Open the Synchronization settings and select "Joplin Server" as the sync target.
  3. Enter the server URL (e.g., https://yourdomain.com) and your credentials.
  4. Test synchronization to ensure everything is working correctly.

Step 5: Maintain Your Server

Monitor Containers: 

docker logs -f joplin_server

Update Images: Periodically pull the latest Joplin Server image and restart: 

docker-compose pull
docker-compose up -d

Backup Data: Regularly back up the Postgres data: 

docker exec -t joplin_postgres pg_dumpall -c -U joplin > backup.sql

Conclusion

Hosting your own Joplin server gives you control over your notes. Whether you're a student, professional, or someone passionate about organizing thoughts securely, this setup ensures privacy, customization, and reliability. Start your journey with Joplin today and take charge of your digital notes!

Read more