extern/joplin-vieweb
1
0
Fork 0
mirror of https://github.com/joplin-vieweb/joplin-vieweb.git synced 2024-12-13 09:51:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

update readme and docker compose files with JOPLIN_LOGIN_REQUIRED

Browse Source
This commit is contained in:
gri38 2024-02-04 19:24:59 +01:00
parent d3ef37ad10
commit 8b07bdeca1
3 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -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 * Prerequisites: your linux system has docker and docker-compose installed
* Enable docker service at system startup * 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)* * 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) * ORIGINS: write the domain and/or IP address (only those origins are allowed to access joplin-vieweb)
Exemple: Exemple:
```yaml ```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_DOMAIN: your_domain.com
CERT_MAIL: you@zaclys.net 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: * 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_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. * CERT_MAIL: a mail needed by let's encrypt.

1
docker-compose-joplin-only.yml
View File

@ -2,6 +2,7 @@ version: '3.4'
x-common-variables: &common-variables x-common-variables: &common-variables
ORIGINS: "'http://localhost', 'http://192.168.21.1'" ORIGINS: "'http://localhost', 'http://192.168.21.1'"
JOPLIN_LOGIN_REQUIRED: True
services: services:
django-joplin-vieweb: django-joplin-vieweb:

1
docker-compose.yml
View File

@ -2,6 +2,7 @@ version: '3.4'
x-common-variables: &common-variables x-common-variables: &common-variables
ORIGINS: "'https://your_domain.com', 'https://12.34.56.78'" ORIGINS: "'https://your_domain.com', 'https://12.34.56.78'"
JOPLIN_LOGIN_REQUIRED: True
CERT_DOMAIN: your_domain.com CERT_DOMAIN: your_domain.com
CERT_MAIL: you@zaclys.net CERT_MAIL: you@zaclys.net