flosoft / docker-joplin-server

Joplin Server docker image

docker-joplin-server

A Docker Image to run Joplin Server.

You can find more information about Joplin on their website or Github.

Environment Variables

Please note the change of JOPLIN_BASE_URL and JOPLIN_PORT to the new APP_ environment variables from version 1.6.4 to 1.7!

Environment Variable	Required	Example Value	Description
APP_BASE_URL	Yes	https://joplin.your.domain	The URL where your Joplin Instance will be served from
APP_PORT	Yes	22300	The port on which your Joplin instance will be running
DB_CLIENT	No	pg	Use pg for postgres.
POSTGRES_PASSWORD	No	joplin	Postgres DB password
POSTGRES_DATABASE	No	joplin	Postgres DB name
POSTGRES_USER	No	joplin	Postgres Username
POSTGRES_PORT	No	5432	Postgres DB port
POSTGRES_HOST	No	db	Postgres DB Host

Usage

I would recommend using a frontend webserver to run Joplin over HTTPS.

Generic docker-compose.yml

This is a barebones docker-compose example. It is recommended to use a webserver in front of the instance to run it over HTTPS. See the example below using Traefik.

version: '3'
services:
    app:
        environment:
            - APP_BASE_URL=http://joplin.yourdomain.tld:22300
            - APP_PORT=22300
            - POSTGRES_PASSWORD=joplin
            - POSTGRES_DATABASE=joplin
            - POSTGRES_USER=joplin 
            - POSTGRES_PORT=5432 
            - POSTGRES_HOST=db
            - DB_CLIENT=pg
        restart: unless-stopped
        image: florider89/joplin-server:latest
        ports:
            - "22300:22300"
    db:
        restart: unless-stopped
        image: postgres:13.1
        ports:
            - "5432:5432"
        volumes:
            - /foo/bar/joplin-data:/var/lib/postgresql/data
        environment:
            - POSTGRES_PASSWORD=joplin
            - POSTGRES_USER=joplin
            - POSTGRES_DB=joplin

Traefik docker-compose.yml

The following docker-compose.yml will make Joplin Server run and apply the labels to expose itself to Traefik.

Note that there are 2 networks in the example below, one to talk to traefik (traefik_default) and one between the Joplin Server and the Database, ensuring that these hosts are not exposed.

You may need to double check the entrypoint name (websecure) and certresolver (lewildcardresolver) to match your Traefik configuration.

version: '3'

services:
    app:
        environment:
            - APP_BASE_URL=https://joplin.yourdomain.tld
            - APP_PORT=22300
            - POSTGRES_PASSWORD=joplin
            - POSTGRES_DATABASE=joplin
            - POSTGRES_USER=joplin
            - POSTGRES_PORT=5432
            - POSTGRES_HOST=db
            - DB_CLIENT=pg
        restart: unless-stopped
        image: florider89/joplin-server:latest
        networks:
            - internal
            - traefik_default
        labels:
            - "traefik.enable=true"
            - "traefik.http.routers.joplin.rule=Host(`joplin.yourdomain.tld`)"
            - "traefik.http.routers.joplin.entrypoints=websecure"
            - "traefik.http.routers.joplin.tls=true"
            - "traefik.http.routers.joplin.tls.certresolver=lewildcardresolver"
            - "traefik.http.middlewares.sslheader.headers.customrequestheaders.X-Forwarded-Proto = http"
            - "traefik.http.routers.joplin.service=joplin-server"
            - "traefik.http.services.joplin-server.loadbalancer.passhostheader=true"
            - "traefik.http.services.joplin-server.loadbalancer.server.port=22300"
            - "traefik.docker.network=traefik_default"
    db:
        restart: unless-stopped
        image: postgres:13.1
        networks:
            - internal
        volumes:
            - /foo/bar/joplin-data:/var/lib/postgresql/data
        environment:
            - POSTGRES_PASSWORD=joplin
            - POSTGRES_USER=joplin
            - POSTGRES_DB=joplin
networks:
  internal:
    internal: true
  traefik_default:
    external: true

Tags

Currently there is only one version as there is no release yet for the server.

latest: Latest server release as per recommended Dockerfile.

latest-alpine: EXPERIMENTAL builds using Alpine of latest release.

master[-alpine]: Images built testing CI / Image changes. Should not be used on systems you want to have a working instance of Joplin Server on. Currently V2 Beta - see notice at the top!

Contribute

Feel free to contribute to this Docker image on Github.

docker-joplin-server's Issues

Will the armv7 builds be back?

I tried updating my joplin docker image today but found out there was no armv7 build anymore. This is confirmed by the last checkin that removes the armv7 build. Will they be back? Hope so...

Getting Nodejs errors

Hello. I am running the latest image on Rpi64 bit image. The Database starts fine, but the app seems to get this error.

app_1  | Node.js[1]: ../src/util.cc:188:double node::GetCurrentTimeInMicroseconds(): Assertion `(0) == (uv_gettimeofday(&tv))' failed.
app_1  | Node.js[1]: ../src/util.cc:188:double node::GetCurrentTimeInMicroseconds(): Assertion `(0) == (uv_gettimeofday(&tv))' failed.
app_1  | Node.js[1]: ../src/util.cc:188:double node::GetCurrentTimeInMicroseconds(): Assertion `(0) == (uv_gettimeofday(&tv))' failed.
app_1  | Node.js[1]: ../src/util.cc:188:double node::GetCurrentTimeInMicroseconds(): Assertion `(0) == (uv_gettimeofday(&tv))' failed.
app_1  | Node.js[1]: ../src/util.cc:188:double node::GetCurrentTimeInMicroseconds(): Assertion `(0) == (uv_gettimeofday(&tv))' failed.
app_1  | Node.js[1]: ../src/util.cc:188:double node::GetCurrentTimeInMicroseconds(): Assertion `(0) == (uv_gettimeofday(&tv))' failed.
app_1  | Node.js[1]: ../src/util.cc:188:double node::GetCurrentTimeInMicroseconds(): Assertion `(0) == (uv_gettimeofday(&tv))' failed.
app_1  | Node.js[1]: ../src/util.cc:188:double node::GetCurrentTimeInMicroseconds(): Assertion `(0) == (uv_gettimeofday(&tv))' failed.
app_1  | Node.js[1]: ../src/util.cc:188:double node::GetCurrentTimeInMicroseconds(): Assertion `(0) == (uv_gettimeofday(&tv))' failed.
app_1  | Node.js[1]: ../src/util.cc:188:double node::GetCurrentTimeInMicroseconds(): Assertion `(0) == (uv_gettimeofday(&tv))' failed.
app_1  | Node.js[1]: ../src/util.cc:188:double node::GetCurrentTimeInMicroseconds(): Assertion `(0) == (uv_gettimeofday(&tv))' failed.
app_1  | Node.js[1]: ../src/util.cc:188:double node::GetCurrentTimeInMicroseconds(): Assertion `(0) == (uv_gettimeofday(&tv))' failed.
^CGracefully stopping... (press Ctrl+C again to force)

behind haproxy

Hey florian,

good work putting this together, was facing trouble hosting this app behind haproxy, facing issue with invalid origin and 503 error from proxy. also net-tools and other utilities are stripped from the image, can you please include them.

Not working anymore on Raspberry Pi 4

Hello,
I have been using your image since August 2021 and have had no problems. Suddenly nothing runs since yesterday. The container is always restarting and in the logs is always only:

joplin-app | standard_init_linux.go:228: exec user process caused: exec format error
This is my docker-compose file:

version: '3'

services:
    joplin-app:
        image: florider89/joplin-server:latest
        container_name: joplin-app
        environment:
            - APP_BASE_URL=https://###
            - APP_PORT=22300
            - POSTGRES_PASSWORD=${POSTGRES_PWD}
            - POSTGRES_DATABASE=joplin
            - POSTGRES_USER=joplin
            - POSTGRES_PORT=5432
            - POSTGRES_HOST=joplin-db
            - DB_CLIENT=pg
        restart: unless-stopped
        networks:
            - default
            - traefik_proxy
        labels:
            - "traefik.enable=true"
            - "traefik.http.routers.joplin.rule=Host(`###`)"
            - "traefik.http.routers.joplin.entrypoints=websecure"
            - "traefik.http.routers.joplin.tls=true"
            - "traefik.http.routers.joplin.tls.certresolver=default"
            - "traefik.http.services.joplin-server.loadbalancer.server.port=22300"
            - "traefik.docker.network=traefik_proxy"

    joplin-db:
        restart: unless-stopped
        image: postgres:13
        container_name: joplin-db
        hostname: joplin-db
        volumes:
            - ./db:/var/lib/postgresql/data
        environment:
            - POSTGRES_PASSWORD=${POSTGRES_PWD}
            - POSTGRES_USER=joplin
            - POSTGRES_DB=joplin

networks:
  traefik_proxy:
    external: true

According to docker inspect I have image version 2.6.3 in use. Although my tag is set to latest, no updates come when I call pull.

OS: RaspianOS 64-Bit (Debian GNU/Linux 10 (buster) Docker version: 20.10.12 Docker-compose version: 1.29.2
If you need more information, please ask for it. I will try to add it then.

Thanks in advance!

Kind regards,
Bjoern

User of PostgreSQL database

Dear @flosoft ,

Thank you for providing this super neat repository 🚀

I've a (probably very easy) question regarding the configuration: when running docker top joplinserver-app-1, I can see that the Joplin app itself runs under my user account:

UID                 PID                 PPID                C                   STIME               TTY                 TIME                CMD
myuser              1482907             1482876             0                   17:35               ?                   00:00:00            tini -- yarn start-prod
myuser              1482971             1482907             0                   17:35               ?                   00:00:01            node /opt/yarn-v1.22.19/bin/yarn.js start-prod
myuser              1483056             1482971             0                   17:35               ?                   00:00:00            /bin/sh -c pm2 kill && pm2 start --no-daemon --exp-backoff-restart-delay=1000 dist/app.js
myuser              1483103             1483056             0                   17:35               ?                   00:00:02            /usr/local/bin/node /home/joplin/packages/server/node_modules/.bin/pm2 start --no-daemon --exp-backoff-restart-delay=1000 dist/app.js
myuser              1483116             1483103             3                   17:35               ?                   00:00:21            node /home/joplin/packages/server/dist/app.js

But running docker top joplinserver-db-1 reveals that Joplin's database is running under a totally different user:

UID                 PID                 PPID                C                   STIME               TTY                 TIME                CMD
openhab             1482900             1482853             0                   17:35               ?                   00:00:00            postgres
openhab             1483046             1482900             0                   17:35               ?                   00:00:00            postgres: checkpointer
openhab             1483047             1482900             0                   17:35               ?                   00:00:00            postgres: background writer
openhab             1483048             1482900             0                   17:35               ?                   00:00:00            postgres: walwriter
openhab             1483049             1482900             0                   17:35               ?                   00:00:00            postgres: autovacuum launcher
openhab             1483050             1482900             0                   17:35               ?                   00:00:00            postgres: stats collector
openhab             1483051             1482900             0                   17:35               ?                   00:00:00            postgres: logical replication launcher
openhab             1483182             1482900             0                   17:35               ?                   00:00:00            postgres: joplinServer joplinServerDb 172.19.0.3(40768) idle
openhab             1483885             1482900             0                   17:38               ?                   00:00:00            postgres: joplinServer joplinServerDb 172.19.0.3(39222) idle

The user openhab exists on my Raspi and is used for my openHAB instance.

Do you have an idea why Joplin's database runs under a totally different account using your docker-compose.yml?

Thx and take care!

Connection to iphone app

I'm running into an issue using the mobile app. My setup is as follows:

I'm running docker-joplin-server on a Proxmox VM. I’m also running nginx-proxy-manager on the same docker stack. I point “joplin.custom.domain” to the ip address of the docker VM. I’ve set up the Joplin windows 10 app on two devices and used “http://joplin.custom.domain”. This has worked wonderfully and I’m very pleased. I do not have any ports open and am only using wireguard for remote access.

The issue I have is that when I put the same address into my iPhone app, it gives a connection error. I read somewhere that it requires https to work, but if I test using the IP of the VM (“http://192.168.10.102:22300”) it works. I suppose I could change:

• APP_BASE_URL=“https://192.168.10.102:22300”

Is there a way to make this work without using https or without setting the base url to the IP and port?

ARM file for Raspberry Pi 4

Hi 👋🏻
Thank you for your effort providing an ARM-based Joplin Docker image. When trying to pull florider89/joplin-server:latest on my Raspberry Pi 4, it fails with no matching manifest for linux/arm/v7 in the manifest list entries.
Could you also provide a Docker image for that platform?

Miss-spelling of BUILD_SEQUENTIAL instruction on line 45 of Dockerfile

I am very new to this. I was just reading your dockerfile and at line 45 it says "run BUILD_SEQUENCIAL=1 ....."
I believe that the instruction is spelt BUILD_SEQUENTIAL. But, I may be wrong. It could be that this spelling is either a different instruction to some other process I am unaware of. Or it could be that this spelling is accepted by the current version of Docker.
I am using your Docker compose for arm7 (Odroid XU4) that I am attempting to setup Joplin server on.
Apologies if I have raised an error that is incorrect.
David

gaceful fs certificate expired

hello,

i see to be gettingthis error while trying to build this into podman
here: https://github.com/compgeniuses/ns8-joplinserver/actions/runs/7621813787/job/20758795349

storing signatures
nodebuilder-joplin
Build static UI files with node...
yarn install v1.22.19
[1/4] Resolving packages...
[2/4] Fetching packages...
error An unexpected error occurred: "https://registry.npm.taobao.org/graceful-fs/download/graceful-fs-4.2.6.tgz: certificate has expired".
info If you think this is a bug, please open a bug report with the information provided in "/usr/src/ui/yarn-error.log".
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

Build of 3.14.1 failed

Hi,

it looks like the build for 3.14.1 wasn't successful with:

Error: buildx failed with: ERROR: failed to solve: process "/bin/sh -c BUILD_SEQUENCIAL=1 yarn install --inline-builds     && yarn cache clean     && rm -rf .yarn/berry" did not complete successfully: exit code: 1

see https://github.com/flosoft/docker-joplin-server/actions/runs/7239381985

EmailService: Service will be disabled because mailer config is not set or is explicitly disabled

I can't start joplin successfully, here is my error report and docker configuration, can you help me?

thank u very much!

stdout: 2022-06-23 01:17:29: App: Content driver: { type: 1 }
stdout: 2022-06-23 01:17:29: App: Content driver (fallback): null
stdout: 2022-06-23 01:17:29: App: Trying to connect to database...
stdout: 2022-06-23 01:17:30: App: Connection check: {
stdout: latestMigration: { name: '20220201151223_backup_items.js', done: true },
stdout: isCreated: true,
stdout: error: null
stdout: }
stdout: 2022-06-23 01:17:31: App: Auto-migrating database...
stdout: 2022-06-23 01:17:31: App: Latest migration: { name: '20220201151223_backup_items.js', done: true }
stdout: 2022-06-23 01:17:31: App: Performing main storage check...
stdout: 2022-06-23 01:17:31: App: Database storage is special and cannot be checked this way. If the connection to the database was successful then the storage driver should work too.
stdout: 2022-06-23 01:17:31: App: Starting services...
stdout: 2022-06-23 01:17:31: ShareService: Starting maintenance...
stdout: 2022-06-23 01:17:31: EmailService: Service will be disabled because mailer config is not set or is explicitly disabled
stdout: 2022-06-23 01:17:31: TaskService: Scheduling #1 (Delete expired tokens): 0 */6 * * *
stdout: 2022-06-23 01:17:31: TaskService: Scheduling #2 (Update total sizes): 0 * * * *
stdout: 2022-06-23 01:17:31: TaskService: Scheduling #3 (Process oversized accounts): 30 */2 * * *
stdout: 2022-06-23 01:17:31: TaskService: Scheduling #7 (Compress old changes): 0 0 */2 * *
stdout: 2022-06-23 01:17:31: TaskService: Scheduling #8 (Process user deletions): 0 */6 * * *
stdout: 2022-06-23 01:17:31: App: Call this for testing: curl http:/10.0.0.75/api/ping
stdout: 2022-06-23 01:17:31: ShareService: Maintenance completed in 24ms

The docker installation command I used：
docker run -d
--name joplin
-e APP_BASE_URL=http://xxx.xxx.xxx:22300
-e APP_PORT=22300
-e POSTGRES_PASSWORD=xxxxxxx
-e POSTGRES_DATABASE=joplin
-e POSTGRES_USER=postgres
-e POSTGRES_PORT=5432
-e POSTGRES_HOST=192.168.200.10
-e DB_CLIENT=pg
-e MAX_TIME_DRIFT=0
--restart unless-stopped
florider89/joplin-server:latest

Node 18 not used for final stage

Hi,

I noticed you are using node-18 only for build stage, but the final stage is still node-16. Is there a reason for that? I am unable to setup ARM building on my machine, so I cannot test it to create a PR.

docker-joplin-server/Dockerfile

Line 55 in df30d6a

FROM node:16-bullseye-slim

Thank you for the image for ARM!
Martin

Can't get it working properly

Hello,
I'm using this container with Nginx Proxy Manager over HTTPS.
I just installed this container with this docker-compose:

services:
app:
environment:
            - APP_BASE_URL=https://joplin.xxxx.ro
            - APP_PORT=22300
            - POSTGRES_PASSWORD=xxxxxxxxxxxxxxxxxxxxx
            - POSTGRES_DATABASE=joplin
            - POSTGRES_USER=joplin 
            - POSTGRES_PORT=5432 
            - POSTGRES_HOST=db
            - DB_CLIENT=pg
        restart: unless-stopped
        image: florider89/joplin-server:latest
        container_name: joplin-server
        ports:
            - "22300:22300"
    db:
        restart: unless-stopped
        image: postgres:13.1
        container_name: joplin-postgres
        ports:
            - "5432:5432"
        volumes:
            - /home/xxxxxxx/docker/joplin/data:/var/lib/postgresql/data
        environment:
            - POSTGRES_PASSWORD=xxxxxxxxxxxxxxxxxx
            - POSTGRES_USER=joplin
            - POSTGRES_DB=joplin

But I get this error and I can't get the sync working.

joplin-server | 2021-03-14 09:19:18: App: GET /css/fontawesome/webfonts/fa-solid-900.woff2
joplin-server | 2021-03-14 09:19:19: App: GET /api/files/root://locks:/children
joplin-server | 2021-03-14 09:19:19: App: GET /api/files/root://locks:/children
joplin-server | 2021-03-14 09:19:19: [error] App: 404: GET /api/files/root://locks:/children : file not found: "" on parent "Vd0ofUKewhTUFwEYLJKoraZBzpIpnK5F"
joplin-server | 2021-03-14 09:19:19: [error] App: 404: GET /api/files/root://locks:/children : file not found: "" on parent "Vd0ofUKewhTUFwEYLJKoraZBzpIpnK5F"
joplin-server | 2021-03-14 09:19:19: App: DELETE /api/files/root://locks/exclusive_desktop_3928687eccd84d0eb887119254874479.json:
joplin-server | 2021-03-14 09:19:19: App: GET /css/fontawesome/webfonts/fa-regular-400.woff2
joplin-server | 2021-03-14 09:19:21: App: GET /api/files/root://info.json:/content
joplin-server | 2021-03-14 09:19:21: [error] App: 404: GET /api/files/root://info.json:/content : file not found: "" on parent "Vd0ofUKewhTUFwEYLJKoraZBzpIpnK5F"
joplin-server | 2021-03-14 09:19:21: App: GET /api/files/root://.sync/version.txt:/content
joplin-server | 2021-03-14 09:19:21: [error] App: 404: GET /api/files/root://.sync/version.txt:/content : file not found: "" on parent "Vd0ofUKewhTUFwEYLJKoraZBzpIpnK5F"
joplin-server | 2021-03-14 09:19:21: App: GET /api/files/root://info.json:/content
joplin-server | 2021-03-14 09:19:21: [error] App: 404: GET /api/files/root://info.json:/content : file not found: "" on parent "Vd0ofUKewhTUFwEYLJKoraZBzpIpnK5F"
joplin-server | 2021-03-14 09:19:21: App: GET /api/files/root://.sync/version.txt:/content
joplin-server | 2021-03-14 09:19:21: [error] App: 404: GET /api/files/root://.sync/version.txt:/content : file not found: "" on parent "Vd0ofUKewhTUFwEYLJKoraZBzpIpnK5F"
joplin-server | 2021-03-14 09:19:21: App: POST /api/files/root:/:/children
joplin-server | 2021-03-14 09:19:21: [error] App: 409: POST /api/files/root:/:/children : Already a file with name "locks"
joplin-server | 2021-03-14 09:19:21: App: POST /api/files/root:/:/children
joplin-server | 2021-03-14 09:19:21: [error] App: 409: POST /api/files/root:/:/children : Already a file with name "temp"
joplin-server | 2021-03-14 09:19:21: App: GET /api/files/root://locks:/children
joplin-server | 2021-03-14 09:19:21: App: GET /api/files/root://locks:/children
joplin-server | 2021-03-14 09:19:21: [error] App: 404: GET /api/files/root://locks:/children : file not found: "" on parent "Vd0ofUKewhTUFwEYLJKoraZBzpIpnK5F"
joplin-server | 2021-03-14 09:19:21: [error] App: 404: GET /api/files/root://locks:/children : file not found: "" on parent "Vd0ofUKewhTUFwEYLJKoraZBzpIpnK5F"
joplin-server | 2021-03-14 09:19:25: App: GET /api/files/root://locks:/children
joplin-server | 2021-03-14 09:19:25: App: GET /api/files/root://locks:/children
joplin-server | 2021-03-14 09:19:25: [error] App: 404: GET /api/files/root://locks:/children : file not found: "" on parent "Vd0ofUKewhTUFwEYLJKoraZBzpIpnK5F"
joplin-server | 2021-03-14 09:19:25: [error] App: 404: GET /api/files/root://locks:/children : file not found: "" on parent "Vd0ofUKewhTUFwEYLJKoraZBzpIpnK5F"
joplin-server | 2021-03-14 09:19:32: App: GET /api/files/root://locks:/children
joplin-server | 2021-03-14 09:19:32: App: GET /api/files/root://locks:/children
joplin-server | 2021-03-14 09:19:32: [error] App: 404: GET /api/files/root://locks:/children : file not found: "" on parent "Vd0ofUKewhTUFwEYLJKoraZBzpIpnK5F"
joplin-server | 2021-03-14 09:19:32: [error] App: 404: GET /api/files/root://locks:/children : file not found: "" on parent "Vd0ofUKewhTUFwEYLJKoraZBzpIpnK5F"
joplin-server | 2021-03-14 09:19:42: App: GET /api/files/root://locks:/children
joplin-server | 2021-03-14 09:19:42: App: GET /api/files/root://locks:/children
joplin-server | 2021-03-14 09:19:43: [error] App: 404: GET /api/files/root://locks:/children : file not found: "" on parent "Vd0ofUKewhTUFwEYLJKoraZBzpIpnK5F"
joplin-server | 2021-03-14 09:19:43: [error] App: 404: GET /api/files/root://locks:/children : file not found: "" on parent "Vd0ofUKewhTUFwEYLJKoraZBzpIpnK5F"
joplin-server | 2021-03-14 09:19:43: App: DELETE /api/files/root://locks/exclusive_desktop_3928687eccd84d0eb887119254874479.json:

And this is the error for the linux desktop app and same for the android app.

Last error: Error: GET api/files/root://locks:/children: Unknown error (404): {"error":"file not found: \"\" on parent \"Vd0ofUKewhTUFwEYLJKoraZBzpIpnK5F\""}

I'm doing something wrong?

Thank you.

Help needed to get this running

This is a really simple and ignorant question. Bear with me, please.

I know how to clone this code or download it, but what must I do to get the server actually up and running? What files go where, and what commands actuate them?

(I'm running 64bit ubuntu server on a Pi 4 if that makes any difference)

Error

I used the default example docker-compose.yml on the main page and got this error;

Any suggestions?