Joplin

Github | Website | Forums

Joplin is a free, open source note taking and to-do application, which can handle a large number of notes organised into notebooks. The notes are searchable, can be copied, tagged and modified either from the applications directly or from your own text editor. The notes are in Markdown format.

# This is a sample docker-compose file that can be used to run Joplin Server
# along with a PostgreSQL server.
#
# Update the following fields in the stanza below:
#
# POSTGRES_USER
# POSTGRES_PASSWORD
# APP_BASE_URL
#
# APP_BASE_URL: This is the base public URL where the service will be running.
#	- If Joplin Server needs to be accessible over the internet, configure APP_BASE_URL as follows: https://example.com/joplin. 
#	- If Joplin Server does not need to be accessible over the internet, set the APP_BASE_URL to your server's hostname. 
#     For Example: http://[hostname]:22300. The base URL can include the port.
# APP_PORT: The local port on which the Docker container will listen. 
#	- This would typically be mapped to port to 443 (TLS) with a reverse proxy.
#	- If Joplin Server does not need to be accessible over the internet, the port can be mapped to 22300.

version: '3'

services:
    db:
        image: postgres:16
        volumes:
            - ./Joplin/data/postgres:/var/lib/postgresql/data
        ports:
            - "5432:5432"
        restart: unless-stopped
        environment:
            - POSTGRES_PASSWORD=PASSWORD
            - POSTGRES_USER=joplin
            - POSTGRES_DB=joplindb
    app:
        image: joplin/server:latest
        depends_on:
            - db
        ports:
            - "22300:22300"
        restart: unless-stopped
        environment:
            - APP_PORT=22300
            - APP_BASE_URL=http://192.168.1.103:22300
            - DB_CLIENT=pg
            - POSTGRES_PASSWORD=PASSWORD
            - POSTGRES_DATABASE=joplindb
            - POSTGRES_USER=joplin
            - POSTGRES_PORT=5432
            - POSTGRES_HOST=db
            - MAILER_ENABLED=1
            - MAILER_HOST=ssl0.ovh.net
            - MAILER_PORT=465
            - MAILER_SECURE=ssl
            - MAILER_AUTH_USER=a@s.com
            - MAILER_AUTH_PASSWORD=mailerpassword
            - MAILER_NOREPLY_NAME=Joplin
            - MAILER_NOREPLY_EMAIL=a@s.com

Some of the .env variables are:

MAILER_ENABLED= Enables the mailing system - 1 is ON 0 is OFF
MAILER_HOST= SMTP server address
MAILER_PORT= SMTP server port
MAILER_SECURITY= SMTP server security method - none or tls or starttls (Server 2.7.4 and above)
MAILER_AUTH_USER= Login username for the SMTP server
MAILER_AUTH_PASSWORD= Login password for the SMTP server
MAILER_NOREPLY_NAME= Display name for mail sent by the server
MAILER_NOREPLY_EMAIL= Sender email address for mail sent by the server
SIGNUP_ENABLED= Enables site visitors to sign up from the server login page - 1 is ON 0 is OFF (I have not used this since before Joplin Cloud went "Live")
TERMS_ENABLED= Enables the login page terms and conditions link - 1 is ON 0 is OFF (I have not used this as anything other than "OFF" since before Joplin Cloud went "Live")
ACCOUNT_TYPES_ENABLED= Enables the admin to set user accounts as Default, Basic or Pro with their associated usage limits / sharing features - 1 is ON 0 is OFF