From 8b07bdeca1d94cb96650cf986f839c88235e27ef Mon Sep 17 00:00:00 2001 From: gri38 Date: Sun, 4 Feb 2024 19:24:59 +0100 Subject: [PATCH] update readme and docker compose files with JOPLIN_LOGIN_REQUIRED --- README.md | 4 +++- docker-compose-joplin-only.yml | 1 + docker-compose.yml | 1 + 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b9679c5..d5dc201 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ If you have your own server, use [docker-compose-joplin-only.yml](https://github * Prerequisites: your linux system has docker and docker-compose installed * Enable docker service at system startup * Get docker-compose.yml *(either you clone this git repo, or you copy [the file](https://github.com/joplin-vieweb/joplin-vieweb/blob/main/docker-compose.yml) somewhere)* -* Edit the 3 variables (x-common-variables block) at the top of docker-compose file: +* Edit the 4 variables (x-common-variables block) at the top of docker-compose file: * ORIGINS: write the domain and/or IP address (only those origins are allowed to access joplin-vieweb) Exemple: ```yaml @@ -97,6 +97,8 @@ If you have your own server, use [docker-compose-joplin-only.yml](https://github CERT_DOMAIN: your_domain.com CERT_MAIL: you@zaclys.net ``` + * If you want to protect your notes access by requiring a login, set `JOPLIN_LOGIN_REQUIRED: True`. If you don't want the user to log in, set `JOPLIN_LOGIN_REQUIRED: False`. + * If you use nginx and certbot containers: * CERT_DOMAIN: your domain so let's encrypt can contact (IP address doesn't work: you need a domain) * CERT_MAIL: a mail needed by let's encrypt. diff --git a/docker-compose-joplin-only.yml b/docker-compose-joplin-only.yml index 258c6ce..9ef2a6d 100644 --- a/docker-compose-joplin-only.yml +++ b/docker-compose-joplin-only.yml @@ -2,6 +2,7 @@ version: '3.4' x-common-variables: &common-variables ORIGINS: "'http://localhost', 'http://192.168.21.1'" + JOPLIN_LOGIN_REQUIRED: True services: django-joplin-vieweb: diff --git a/docker-compose.yml b/docker-compose.yml index b7d3298..8494bbe 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -2,6 +2,7 @@ version: '3.4' x-common-variables: &common-variables ORIGINS: "'https://your_domain.com', 'https://12.34.56.78'" + JOPLIN_LOGIN_REQUIRED: True CERT_DOMAIN: your_domain.com CERT_MAIL: you@zaclys.net