I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons

If this add-on saves you time or makes your setup easier, I would be very grateful for your support!

Addon informations

Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!

About

Joplin Server is a free, open source note taking and to-do synchronization application, which can handle a large number of notes organized into notebooks. With this server you can sync all your notes across all your devices. Joplin supports end-to-end encryption, markdown editing, web clipper extensions, and synchronization with various cloud services.

This addon is based on the docker image from etechonomy.

Thanks to @poudenes for helping with the development!

Configuration

Webui can be found at <your-ip>:22300.

Options

Option	Type	Default	Description
`APP_BASE_URL`	str	`http://your_domain:port`	Base public URL where the service will be running
`data_location`	str	`/config/addons_config/joplin`	Path where Joplin data is stored
`DB_CLIENT`	str		Database client type (e.g., `pg` for PostgreSQL)
`POSTGRES_HOST`	str		PostgreSQL server hostname
`POSTGRES_PORT`	int		PostgreSQL server port
`POSTGRES_DATABASE`	str		PostgreSQL database name
`POSTGRES_USER`	str		PostgreSQL username
`POSTGRES_PASSWORD`	str		PostgreSQL password
`MAILER_ENABLED`	int		Enable email service (1=true, 0=false)
`MAILER_HOST`	str		SMTP server hostname
`MAILER_PORT`	int		SMTP server port
`MAILER_SECURITY`	str		SMTP security (none, tls, starttls)
`MAILER_AUTH_USER`	str		SMTP authentication username
`MAILER_AUTH_PASSWORD`	str		SMTP authentication password
`MAILER_NOREPLY_NAME`	str		Email sender name
`MAILER_NOREPLY_EMAIL`	str		Email sender address

Example Configuration

APP_BASE_URL: "http://192.168.1.100:22300"
data_location: "/config/addons_config/joplin"
DB_CLIENT: "pg"
POSTGRES_HOST: "core-mariadb"
POSTGRES_PORT: 3306
POSTGRES_DATABASE: "joplin"
POSTGRES_USER: "joplin"
POSTGRES_PASSWORD: "secure_password"
MAILER_ENABLED: 1
MAILER_HOST: "smtp.gmail.com"
MAILER_PORT: 587
MAILER_SECURITY: "starttls"
MAILER_AUTH_USER: "your-email@gmail.com"
MAILER_AUTH_PASSWORD: "your-app-password"
MAILER_NOREPLY_NAME: "Joplin Server"
MAILER_NOREPLY_EMAIL: "noreply@yourdomain.com"

Database Setup

Joplin Server uses SQLite by default, but for production use, PostgreSQL is recommended:

Install and configure a PostgreSQL addon (e.g., MariaDB addon)
Create a database and user for Joplin
Configure the PostgreSQL options in the Joplin addon
Restart the addon

Make sure the provided database and user exist as the server will not create them automatically.

Email Configuration

To enable email functionality for user registration and notifications:

Configure your SMTP server details
Set MAILER_ENABLED to 1
Provide authentication credentials
Test the configuration by registering a new user

Custom Scripts and Environment Variables

This addon supports custom scripts and environment variables through the addon_config mapping:

Custom scripts: See Running Custom Scripts in Addons
env_vars option: Use the add-on env_vars option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.

Add my Hass.io add-ons repository to your Hass.io instance.
Install this add-on.
Click the Save button to store your configuration.
Start the add-on.
Check the logs of the add-on to see if everything went well.
Navigate to the web interface to complete the initial setup.

Setup Steps

Initial Setup: After starting the addon, navigate to the web interface
Create Admin Account: Create your first admin user account
Configure Synchronization: Set up your Joplin clients to sync with the server
Optional Database: Consider switching to PostgreSQL for better performance
Email Service: Configure email service for user management features

Support

Create an issue on GitHub.