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

Update README.md

Browse Source
This commit is contained in:
Nicolas Guillot 2022-04-25 23:08:40 +02:00 committed by GitHub
parent ec7ae9dc32
commit 9260f9902b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -3,6 +3,25 @@ A web viewer for Joplin app
# Please wait until it's ready... it should be quite soon.
# 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.
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.
* 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.
* And "run".
```bash
cd ~
mkdir joplin-vieweb
cd joplin-vieweb
wget https://raw.githubusercontent.com/joplin-vieweb/joplin-vieweb/main/docker-compose.yml
vi docker-compose.yml # edit the x-common-variables 3 variables)
sudo docker-compose up
```
## Systemd your docker-compose.
Todo
# Components
![image](https://user-images.githubusercontent.com/26554495/161628724-11b17aab-c3cf-4def-8159-dc2bebd11d22.png)