Joplin is an open source note-taking app. Capture your thoughts and securely access them from any device.
Module id: Joplin. Images are pinned in build-images.sh and updated through reviewed changes.
add-module ghcr.io/geniusdynamics/joplinserver:latest 1The command returns the instance id, for example Joplin1. Use the id NS8 returns.
api-cli run configure-module --agent module/Joplin1 --data - <<'EOF'
{
"host": "joplinserver.example.org",
"http2https": true,
"lets_encrypt": false
}
EOF| Parameter | Required | Type | Description |
|---|---|---|---|
host |
yes | string | Host name for the application, like 'joplin.domain.org' |
lets_encrypt |
yes | boolean | Request a valid Let's Encrypt certificate. |
http2https |
yes | boolean | Redirect all the HTTP requests to HTTPS |
get-configuration returns: host, lets_encrypt, http2https.
| Image | Version |
|---|---|
docker.io/postgres |
16.16 |
docker.io/joplin/server |
3.4.3 |
- Reserves 1 TCP port(s) on the node. The web application is published through Traefik on the configured host name.
- Runs rootless.
- Declares these NS8 authorizations:
traefik@node:routeadm.
The following paths are included in the NS8 backup (imageroot/etc/state-include.conf):
volume/postgres-datastate/joplin.pg_dumpstate/database.envstate/app.envstate/joplin-db.env
joplin-pgsql.servicejoplin-server.servicejoplin.service
api-cli run get-configuration --agent module/Joplin1api-cli run update-module --data '{"module_url":"ghcr.io/geniusdynamics/joplinserver:latest","instances":["Joplin1"],"force":true}'
remove-module --no-preserve Joplin1Continuous integration:
Publish imagesbuilds the module image on every push.Test moduleinstalls the image on a QEMU NS8 node and runs the Robot Framework suite intests/. It runs afterPublish imagessucceeds ondevand onmain.Build API JSON Schema docsand the security scan run alongside.
The suite installs the module, configures a host name, checks that the web application answers through Traefik, takes UI screenshots and removes the module.
Run it locally with the NS8 standard infrastructure described in the ns8-github-actions README.
Application documentation: https://joplinapp.org/help/
GPL-3.0-or-later. See LICENSE.