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.md

Browse Source
This commit is contained in:
Nicolas Guillot 2022-04-29 12:52:10 +02:00 committed by GitHub
parent ee26a44fee
commit a403b842ac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 47 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@ -3,15 +3,29 @@ 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 / configuration instructions
```diff
! Only linux systems are supported
! Only arm64 and amd64 architectures
! For raspberry users (I am): use 64 bits OS
```
## Installation
</span>
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. 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*). Have a look to [the containers](#components).
* 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)* * Prerequisites: your linux system has docker and docker-compose installed
* Edit the 3 variables (x-common-variables block) at the top of docker-compose file. * Enable docker service at system startup
* And "run". * 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:
* ORIGINS: write the domain and/or IP address (only those origins are allowed to access joplin-vieweb)
* 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.
* And "run"
```bash ```bash
sudo systemctl enable docker
cd ~ cd ~
mkdir joplin-vieweb mkdir joplin-vieweb
cd joplin-vieweb cd joplin-vieweb
@ -19,9 +33,33 @@ wget https://raw.githubusercontent.com/joplin-vieweb/joplin-vieweb/main/docker-c
vi docker-compose.yml # edit the x-common-variables (3 variables) vi docker-compose.yml # edit the x-common-variables (3 variables)
sudo docker-compose up sudo docker-compose up
``` ```
## Systemd your docker-compose.
Todo Congratulation, the server is running. If the system reboots, the server will start automatically (since we enabled docker.service at startup and the services in odcker-compose are set as "restart")
## Upgrade
When a new version is available, simply go to your docker-compose file:
```bash
sudo docker-compose down
sudo docker-compose up
```
## Configuration
You should configure a synchronisation to secure your notes:
![image](https://user-images.githubusercontent.com/26554495/165929289-9a4e0855-e408-45c3-bc98-f9e9fb8b31cb.png)
1️⃣ Click the settings tab
2️⃣ Input synchronisation data (only next cloud is supported for now, if you would like other services, ask in a conversation)
3️⃣ Test
4️⃣ If test result is OK: save
If your cloud already contains joplin content, do a synchronisation:
![image](https://user-images.githubusercontent.com/26554495/165929859-af4f308c-704c-4afa-9c25-5c1f237b79f4.png)
1️⃣ Click the synchronisation tab
2️⃣ click the sync button
3️⃣ Wait for the sync to finish (it may take a long time depending on your cloud content)
# Components # Components
![image](https://user-images.githubusercontent.com/26554495/161628724-11b17aab-c3cf-4def-8159-dc2bebd11d22.png) ![image](https://user-images.githubusercontent.com/26554495/165928456-731c2f4d-0280-4d95-a26c-1edf3020bb35.png)