Update README.md

This commit is contained in:
Nicolas Guillot 2022-04-25 23:09:33 +02:00 committed by GitHub
parent 9260f9902b
commit 75959392f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -4,11 +4,11 @@ A web viewer for Joplin app
# Please wait until it's ready... it should be quite soon. # Please wait until it's ready... it should be quite soon.
# Installation instruction # Installation instruction
Installation is done with docker-compose. The default docker-compose file installs a nginx server with certbot certificates mechanisms, ans listens to ports 80 and 443. Installation is done with docker-compose. The default docker-compose file installs a nginx server with certbot certificates mechanisms, and listens to ports 80 and 443.
If you have your own server, use docker-compose-joplin-only.yml (**todo**) If you have your own server, use docker-compose-joplin-only.yml (*todo*)
* Not-documented prerequisites: your linux system has docker and docker-compose installed. * Not-documented prerequisites: your linux system has docker and docker-compose installed.
* 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 og docker-compose file. * Edit the 3 variables (x-common-variables block) at the top og docker-compose file.
* And "run". * And "run".
```bash ```bash