{"id":1493,"date":"2025-04-06T19:31:07","date_gmt":"2025-04-06T19:31:07","guid":{"rendered":"https:\/\/www.labiol.xyz\/?p=1493"},"modified":"2025-04-06T19:31:07","modified_gmt":"2025-04-06T19:31:07","slug":"nginx-configuration-for-joplin-note-taking-app","status":"publish","type":"post","link":"https:\/\/www.labiol.xyz\/index.php\/2025\/04\/06\/nginx-configuration-for-joplin-note-taking-app\/","title":{"rendered":"Nginx configuration for joplin note taking app"},"content":{"rendered":"\n

Introduction<\/h2>\n\n\n\n

Joplin may not be the most perfect note-taking application, but it is open-source, well-known, has a long release history, works on multiple operating systems, and supports plugins. It\u2019s not perfect, but it\u2019s good enough and highly usable. In case of this type of application, it is important to have an easy way to do export to migrate to another application (which is quite rare) and import using various format. It is possible that author, in the future, can change license or scope of free tier where next tier level price is not easy to accept. <\/p>\n\n\n\n

In case of Joplin, there is possibility to export your notes to the following format:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Where it is possible to do import from formates as presented below. <\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Spoiler, Import from some applications can be very difficult (like OneNote) or surprisedly easy like Apple Notes (where convert application can do export to md files).<\/p>\n\n\n\n

Joplin has two ways how you can create notes, using MarkDown (md) or\/and (wyswyg) editor. md editor has also live view version. Both use autosave. In addition for mobile app, Joplin can use draw mode, and pen can be used in separated mode.<\/p>\n\n\n\n

Another very useful function is synchronisation between many devices. By default it is possible to use Joplin cloud services which is the most optimised transfer option. Another few supported option contains tested by me Dropbox and Microsoft OneDrive (check below). Few self hosted options are also possible, including WebDav which was inspiration to that article. <\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

It is possible encrypt data on the destination. <\/p>\n\n\n\n

Nginx preparation as webdav.<\/h2>\n\n\n\n

I have prepared needed configuration using lxc and debian 11. Lxc container itself has debian 12 image version. <\/p>\n\n\n\n

Inside lxc container install required software:<\/p>\n\n\n\n

apt install libnginx-mod-http-dav-ext apache2-utils nginx-full nginx-extra nginx-core<\/code><\/pre>\n\n\n\n
and all the other required software you like.<\/p>\n\n\n\n
apache2-utils is not expected in that set but it is required for htpasswd binary. <\/p>\n\n\n\n
Create target directory, like “\/webdav” and set required permissions<\/p>\n\n\n\n
 mkdir -p \/webdav\/client_temp\n chown -R www-data:www-data \/webdav\n sudo chmod -R 755 \/webdav<\/code><\/pre><\/div>\n\n\n\n
Check if the nginx has plugin:<\/p>\n\n\n\n
nginx -V 2>&1 | grep -o with-http_dav_module<\/code><\/pre><\/div>\n\n\n\n
Create password file and user:<\/p>\n\n\n\n
htpasswd -c \/etc\/nginx\/.htpasswd user<\/code><\/pre><\/div>\n\n\n\n
Generate certificates:<\/p>\n\n\n\n
openssl req -x509 -nodes -days 3650 -newkey rsa:2048 -keyout \/etc\/ssl\/private\/nginx-selfsigned.key -out \/etc\/ssl\/certs\/nginx-selfsigned.crt<\/code><\/pre><\/div>\n\n\n\n
Copy ctl content of the file and set permissions:<\/p>\n\n\n\n
cat \/etc\/ssl\/certs\/nginx-selfsigned.crt\nchmod 660 \/etc\/ssl\/private\/nginx-selfsigned.key \nchmod 644 \/etc\/ssl\/certs\/nginx-selfsigned.crt <\/code><\/pre><\/div>\n\n\n\n
Create required config in \/etc\/nginx\/sites-enabled\/default<\/p>\n\n\n\n
server {\n\tlisten 80 default_server;\n\tlisten [::]:80 default_server;\n\tserver_name _;\n\treturn 301 https:\/\/$host$request_uri;\n}\n\nserver {\n\tlisten 443 ssl;\n\tserver_name 192.168.22.35;\n\tssl_certificate \/etc\/ssl\/certs\/nginx-selfsigned.crt;\n\tssl_certificate_key \/etc\/ssl\/private\/nginx-selfsigned.key;\n\troot \/webdav;\n\n\tlocation \/webdav\/ {\n\t\troot \/webdav;\n\t\tclient_body_temp_path \/webdav\/client_temp;\n\t\tdav_methods PUT DELETE MKCOL COPY MOVE;\n\t\tdav_ext_methods PROPFIND OPTIONS LOCK UNLOCK;\n\t\tcreate_full_put_path on;\n\t\tdav_access user:rw group:rw all:r;\n     \tauth_basic "Restricted Access";\n\t\tauth_basic_user_file \/etc\/nginx\/.htpasswd;\n\t\tautoindex on;\n\t}\n\taccess_log \/var\/log\/nginx\/webdav_access.log;\n\terror_log \/var\/log\/nginx\/webdav_error.log;\n}\n<\/code><\/pre><\/div>\n\n\n\n
Check your configuration with command:<\/p>\n\n\n\n
nginx -t<\/code><\/pre><\/div>\n\n\n\n
Restart nginx<\/p>\n\n\n\n
systemctl restart nginx\nsystemctl status nginx<\/code><\/pre><\/div>\n\n\n\n
Joplin configuration<\/h2>\n\n\n\n
Copy certificate to local file where Joplin is running. <\/p>\n\n\n\n
Example of the configuration:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n
File joplin-webdav.crt contains certificate file.<\/p>\n\n\n\n
Also in case you’re using self-signed certificate (as specified in this article) set “Ignore TLS certificate errors”.<\/p>\n\n\n\n
In addition use Encryption to not store files on plain text files.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Conclusions<\/h2>\n\n\n\n
Joplin is not a perfect note-taking tool, but it is good enough. Since it is opensource with planty of export\/import options. It is software I can definitely recommend. <\/p>\n\n\n\n
Known issues are around editor (wyswyg) which not always behave as expected (for example some html marks are visible when switching to md editor). <\/p>\n\n\n\n
Joplin iPad do not support self signed certificate (it is more how iPad iOS works).<\/p>\n","protected":false},"excerpt":{"rendered":"
Introduction Joplin may not be the most perfect note-taking application, but it is open-source, well-known, has a long release history, works on multiple operating systems, and supports plugins. It\u2019s not perfect, but it\u2019s good enough and highly usable. In case of this type of application, it is important to have … <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3,1],"tags":[52,8,53],"class_list":["post-1493","post","type-post","status-publish","format-standard","hentry","category-linux","category-uncategorized","tag-joplin","tag-linux","tag-webdav"],"_links":{"self":[{"href":"https:\/\/www.labiol.xyz\/index.php\/wp-json\/wp\/v2\/posts\/1493","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.labiol.xyz\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.labiol.xyz\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.labiol.xyz\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.labiol.xyz\/index.php\/wp-json\/wp\/v2\/comments?post=1493"}],"version-history":[{"count":8,"href":"https:\/\/www.labiol.xyz\/index.php\/wp-json\/wp\/v2\/posts\/1493\/revisions"}],"predecessor-version":[{"id":1508,"href":"https:\/\/www.labiol.xyz\/index.php\/wp-json\/wp\/v2\/posts\/1493\/revisions\/1508"}],"wp:attachment":[{"href":"https:\/\/www.labiol.xyz\/index.php\/wp-json\/wp\/v2\/media?parent=1493"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.labiol.xyz\/index.php\/wp-json\/wp\/v2\/categories?post=1493"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.labiol.xyz\/index.php\/wp-json\/wp\/v2\/tags?post=1493"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}