Guide for Joplin-Server on Raspberry Pi

seraph · 2024-03-04T15:57:20.391Z

@MrKanister Thanks for your tutorial, however I seem to fail at some point

I needed to change all http-urls to h2tp, I am not allowed to post links.

I want to host joplin locally on my raspi4 and expose via nginx proxy and let's ecrypt certificate.
Joplin should be available on this domain
h2tps://subdomain.domain.tld:1234

Network setup will be like this
Router Port 1234➡2345 nginx listening➡proxy to joplin port 22300

I was able to get almost everything up and running. But opening h2tps://subdomain.domain.tld:1234/login will give me a bare html page with no css images etc. loaded.

sample h2tps://subdomain.domain.tld:1234/login
bare html page (

All urls in html sourcecode lead to http-url, no https and missing outside port 1234. e.g.
h2tp://subdomain.domain.tld/images/icons/server/icon-180.png

whereas this url severs the image perfectly:
h2tps://subdomain.domain.tld:1234/images/icons/server/icon-180.png

So it appears joplin is hardcoding the url by itself unable to handle outside port 1234 or https proxing, what did I configure wrong?
Do I have to rewrite all urls in nginx?
Does Joplin require outside port in APP_BASE_URL?
Can Joplin even handle different ports?

docker-compose

version: '3.5'
volumes:
joplin-db:
joplin-data:
joplin-nginx:
joplin-nginxlogs:
letsencrypt:
external: true

services:
db:
restart: unless-stopped
container_name: joplin-db
image: postgres:latest
ports:
- "5432:5432"
volumes:
- joplin-db:/var/lib/postgresql/data
environment:
- POSTGRES_PASSWORD=SECRET
- POSTGRES_USER=joplin
- POSTGRES_DB=joplin
app:
container_name: joplin-core
environment:
- APP_BASE_URL=h2tp://subdomain.domain.tld
- APP_PORT=22300
- POSTGRES_PASSWORD=SECRET
- POSTGRES_DATABASE=joplin
- POSTGRES_USER=joplin
- POSTGRES_PORT=5432
- POSTGRES_HOST=db
- DB_CLIENT=pg
- MAILER_ENABLED=1
- MAILER_HOST=SECRET
- MAILER_PORT=587
- MAILER_SECURITY=starttls
- MAILER_AUTH_USER=SECRET
- MAILER_AUTH_PASSWORD=SECRET
- MAILER_NOREPLY_NAME=SECRET
- MAILER_NOREPLY_EMAIL=SECRET
restart: unless-stopped
image: etechonomy/joplin-server:latest
ports:
- "22300:22300"
depends_on:
- db

web:
    image: nginx:1.24.0
    container_name: joplin-nginx
    restart: always
    ports:
      - "2345:2345"
    links:
      - app
    volumes:
      - joplin-nginx:/etc/nginx
      - letsencrypt:/etc/letsencrypt:ro
      - joplin-nginxlogs:/var/logs

nginx-config

server {
listen 2345 ssl http2;
server_name subdomain.domain.tld;

        ssl_certificate /etc/letsencrypt/live/SECRET.pem;
        ssl_certificate_key /etc/letsencrypt/live/SECRET.pem;

        location / {
            proxy_pass h2tp://joplin-core:22300;
            proxy_buffering off;
            proxy_set_header X-Forwarded-Host $host;
            proxy_set_header Host $host;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header X-Forwarded-Proto $scheme;
            proxy_set_header X-Real-IP $remote_addr;
            }
    }

MrKanister · 2024-03-05T12:12:13.341Z

Phew, very specific use case!

seraph:

But opening h2tps://subdomain.domain.tld:1234/login will give me a bare html page with no css images etc. loaded.

Indeed this often is an indicator for an incorrect APP_BASE_URL. I'd try to add the outside port to it.

seraph:

Can Joplin even handle different ports

Yes, I think so, see this post: Guide for Joplin-Server on Raspberry Pi - #42 by MrKanister.

seraph:

So it appears joplin is hardcoding the url by itself unable to handle outside port 1234

I don't think so, see the link above. You could possibly verify this by adding the port to the APP_BASE_URL and checking in the developer tools of your browser where the network requests are being sent to.

I think your desired behaviour should be possible, but I can't tell you exactly whether and where there is currently an error.

(Be aware, that certbot needs port 80 (and maybe 443) open on the pi for it's challenges if you are using it for the certificate on the pi.)

seraph · 2024-03-05T17:15:24.091Z

I am using this setup for almost all my docker containers and they all work fine. E.g. nextcloud, influxdb, unifi, grafana..

I just verified, adding the external port does not work

APP_BASE_URL=h2tp://subdomain.domain.tld:1234

It seems the port is now actually part of the base url and does not match the passed url in http-header:

h2tp://subdomain.domain.tld:1234 <> h2tps://subdomain.domain.tld

Opening h2tps://subdomain.domain.tld:1234 will lead to:

Invalid origin: h2tps://subdomain.domain.tld

Since this message is send as plain-text there is no url, link, image or similar that is loaded after said message.

Thanks for the note regarding let's encrypt. I am handling certbot in another container that has port 80 forwarded, that works just fine

seraph · 2024-03-05T17:44:19.280Z

@MrKanister Thanks for the sparring, I figured it out!

All I needed is to trick joplin into getting the correct url passed in the forwarding header from nginx.
Nginx will now forward to port 22300 with a header containing 1234 as url.

nginx config:

proxy_set_header Host $host:1234;

joplin base url

APP_BASE_URL=h2tp://subdomain.domain.tld:1234

Network setup will be like this
Router Port 1234➡2345 nginx listening➡proxy to joplin port 22300

Working configuration

docker-compose

version: '3.5'
volumes:
joplin-db:
joplin-data:
joplin-nginx:
joplin-nginxlogs:
letsencrypt:
external: true

services:
db:
restart: unless-stopped
container_name: joplin-db
image: postgres:latest
ports:
- "5432:5432"
volumes:
- joplin-db:/var/lib/postgresql/data
environment:
- POSTGRES_PASSWORD=SECRET
- POSTGRES_USER=joplin
- POSTGRES_DB=joplin
app:
container_name: joplin-core
environment:
- APP_BASE_URL=h2tp://subdomain.domain.tld:1234
- APP_PORT=22300
- POSTGRES_PASSWORD=SECRET
- POSTGRES_DATABASE=joplin
- POSTGRES_USER=joplin
- POSTGRES_PORT=5432
- POSTGRES_HOST=db
- DB_CLIENT=pg
- MAILER_ENABLED=1
- MAILER_HOST=SECRET
- MAILER_PORT=587
- MAILER_SECURITY=starttls
- MAILER_AUTH_USER=SECRET
- MAILER_AUTH_PASSWORD=SECRET
- MAILER_NOREPLY_NAME=SECRET
- MAILER_NOREPLY_EMAIL=SECRET
restart: unless-stopped
image: etechonomy/joplin-server:latest
ports:
- "22300:22300"
depends_on:
- db

web:
    image: nginx:1.24.0
    container_name: joplin-nginx
    restart: always
    ports:
      - "2345:2345"
    links:
      - app
    volumes:
      - joplin-nginx:/etc/nginx
      - letsencrypt:/etc/letsencrypt:ro
      - joplin-nginxlogs:/var/logs

nginx-config

server {
listen 2345 ssl http2;
server_name subdomain.domain.tld;

        ssl_certificate /etc/letsencrypt/live/SECRET.pem;
        ssl_certificate_key /etc/letsencrypt/live/SECRET.pem;

        location / {
            proxy_pass http://joplin-core:22300;
            proxy_buffering off;
            proxy_set_header X-Forwarded-Host $host;
            proxy_set_header Host $host:1234;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header X-Forwarded-Proto $scheme;
            proxy_set_header X-Real-IP $remote_addr;
            }
    }

doobes · 2024-04-24T13:29:35.744Z

Hi there,

Sorry to be so late to the party.

When following the initial post, and running:

sudo docker compose up -d

I'm told that the version is obsolete.

Any thoughts?

thanks

chris

MrKanister · 2024-04-24T17:58:38.907Z

Which version is obsolete? Please post the output you get as a code block (like this: ``` output ```)

dpoulton · 2024-04-24T21:31:46.677Z

doobes:

I'm told that the version is obsolete.

I believe it says that "version" is obsolete.

The docker-compose file no longer requires the line version: '3'. You can ignore it or just delete the line.

GitHub - Version top-level element (obsolete)

doobes · 2024-04-25T12:44:30.378Z

Awesome.

Okay, that hurdle cleared, onto the next:

my docker-compose.yaml looks like this:

services:
db:
restart: unless-stopped
image: postgres:latest
ports:
- "5432:5432"
volumes:
- /data/joplin-data:/var/lib/postgresql/data
environment:
- POSTGRES_PASSWORD=xxxx
- POSTGRES_USER=joplin
- POSTGRES_DB=joplin
app:
environment:
- APP_BASE_URL=https://xxxxxxx/joplin
- APP_PORT=22300
- POSTGRES_PASSWORD=xxxxx
- POSTGRES_DATABASE=joplin
- POSTGRES_USER=joplin
- POSTGRES_PORT=5432
- POSTGRES_HOST=db
- DB_CLIENT=pg
restart: unless-stopped
image: etechonomy/joplin-server:latest
ports:
- "22300:22300"
depends_on:
- db

This is what I get when I run sudo docker compose up -d

pi@raspberrypi:~ $ sudo docker compose up -d
WARN[0000] The "LhqkfzeR" variable is not set. Defaulting to a blank string.
WARN[0000] The "tv" variable is not set. Defaulting to a blank string.
WARN[0000] The "LhqkfzeR" variable is not set. Defaulting to a blank string.
WARN[0000] The "tv" variable is not set. Defaulting to a blank string.
[+] Running 0/2
⠧ db Pulling 0.6s
⠧ app Pulling 0.6s
no matching manifest for linux/arm/v8 in the manifest list entries

And this takes mere moments, not a long while.

Thanks

doobes · 2024-04-25T12:45:47.990Z

sorry for the formatting.

dpoulton · 2024-04-25T17:02:51.863Z

doobes:

WARN[0000] The "LhqkfzeR" variable is not set. Defaulting to a blank string.
WARN[0000] The "tv" variable is not set. Defaulting to a blank string.
WARN[0000] The "LhqkfzeR" variable is not set. Defaulting to a blank string.
WARN[0000] The "tv" variable is not set. Defaulting to a blank string.

This suggests to me that docker is looking for externally stored environment variables but you have not obviously specified any in your compose file. It's a long shot but is your postgres password something like ${LhqkfzeR}${tv} ???

dpoulton · 2024-04-25T18:49:10.801Z

doobes:

no matching manifest for linux/arm/v8 in the manifest list entries

Also in the error it says arm. Are you trying to install Joplin Server on 32-bit RasPiOS? Joplin Server is a 64-bit application and needs a 64-bit OS to download / run the linux/arm64/v8 image.

doobes · 2024-04-25T19:23:30.692Z

image610×509 10.9 KB

Says here it's Arm 64 bit

en.wikipedia.org

AArch64

AArch64 or ARM64 is the 64-bit extension of the ARM architecture family. It was first introduced with the Armv8-A architecture, and had many extension updates. Announced in October 2011, ARMv8-A represents a fundamental change to the ARM architecture. It adds an optional 64-bit architecture, named "AArch64", and the associated new "A64" instruction set. AArch64 provides user-space compatibility with the existing 32-bit architecture ("AArch32" / ARMv7-A), and instruction set ("A32"). The 16-32...

dpoulton · 2024-04-25T19:31:57.427Z

That says the processor is 64-bit.

Try typing the command getconf LONG_BIT and see if the result is 32 or 64.

doobes · 2024-04-25T19:33:42.486Z

Aha.

Crapolla

Thanks

dpoulton · 2024-04-25T19:38:14.302Z

And the warnings?

Guide for Joplin-Server on Raspberry Pi Development

This suggests to me that docker is looking for externally stored environment variables but you have not obviously specified any in your compose file. It's a long shot but is your postgres password something like ${LhqkfzeR}${tv} ???

doobes · 2024-04-25T20:19:58.056Z

dpoulton:

Well, might have been something similar

Changed completely just for fun.

It's churning away as we speak.

'nuther silly assed question while that's doing it's thing

Item 6 mentions a Webserver, but says little else about it. Why, how, etc, etc, I mean it's easy enough to install one, but configuration is a whole new thing.

Thanks

dpoulton · 2024-04-25T20:47:01.997Z

doobes:

Item 6 mentions a Webserver, but says little else about it. Why, how, etc, etc, I mean it's easy enough to install one, but configuration is a whole new thing

Actually it says quite a bit and includes config information. The sections expand depending on the reverse proxy you have / want to use.

The reverse proxy accepts and handles the https (port 443) requests and deals with the encryption certificates on behalf of the Joplin server. It then forwards the traffic to the Joplin Server docker container on port 22300.

doobes · 2024-04-25T21:02:23.991Z

doh

you are correct

thanks

doobes · 2024-04-28T20:24:14.637Z

Well, making progress, I think.

I went through the Apache install.

At the end when I typed "sudo apachectl -k graceful" , it said:

AH00558: apache2: Could not reliably determine the server's fully qualified domain name, using 127.0.1.1. Set the 'ServerName' directive globally to suppress this message

Anyway, if I enter in https://mywebsitename/joplin, I get the initial login page.

I changed my creds my correct e-mail and a new password and it says it will e-mail a confirmation.

But it doesn't . No e-mail.

Going back to https://mywebsitename/joplin/home, I'm told "A confirmation email has been sent to your new address. Please follow the link in that email to confirm. Your email will only be updated after that."

Without the e-mail I'm kinda dead in the water.

Thoughts?

Thanks

MrKanister · 2024-04-28T20:45:51.487Z

Hi,

doobes:

Could not reliably determine the server's fully qualified domain name

You can safely ignore this warning or look it up on the web.

doobes:

No e-mail.

To get the E-Mail actually sent, you would have to configure the E-Mail settings in the docker-compose file. Please look up the instructions on how to do this in the forum via the search. If you don't want to setup this, you can also login as the admin, go to "Admin", "Emails", look up the desired E-Mail and click the link. This is how I do it, as I am the only user on the instance and I didn't want to configure the E-Mail config.