mirror of
https://github.com/joplin-vieweb/joplin-vieweb.git
synced 2024-12-12 17:30:55 +01:00
Merge commit '61d6526ea1ad7f6589deaaf90c23a3d91aa50710' into dev
# Conflicts: # README.md # docker-compose-joplin-only.yml # docker-compose.yml
This commit is contained in:
Nicolas Guillot
commit
e7e2a629ad
163
README.md
163
README.md
@ -1,2 +1,163 @@
|
||||
# joplin-vieweb
|
||||
A web viewer for Joplin app
|
||||
A simple web viewer for [Joplin](https://joplinapp.org/) notes.
|
||||
*If it's useful for you, you may consider to [](https://www.paypal.com/donate/?business=T4U6TRV3PKYMY&no_recurring=0&item_name=Thanks+for+your+support+to+Joplin-Vieweb.%0AI+hope+you+find+it+useful.¤cy_code=EUR)*
|
||||
|
||||
## Purpose
|
||||
I'm going to use [Joplin](https://joplinapp.org/) as a notes application.
|
||||
It's a long time I wanted for something like Joplin: opensource, not coupled to a web giant, and without infinite storage: storage has a price, we should pay for it.
|
||||
|
||||
Joplin-vieweb purpose is to provide an **online view of my Joplin notes**.
|
||||
It's running on a "Django server", running beside [Joplin terminal app](https://joplinapp.org/terminal/).
|
||||
|
||||
## Screenshot
|
||||
|
||||
|
||||
## Contact
|
||||
I you want to discuss, ask, suggest... Please:
|
||||
- Input [an issue](https://github.com/joplin-vieweb/joplin-vieweb/issues), or
|
||||
- start [a discussion on github](https://github.com/joplin-vieweb/joplin-vieweb/discussions), or
|
||||
- post [on discord](https://discord.gg/akkn2y8vEg)
|
||||
|
||||
## Features and not(-yet?) features
|
||||
### Yes it does ❤
|
||||
- Protect joplin-vieweb access by login (see [here](https://github.com/joplin-vieweb/joplin-vieweb/releases/tag/v2.0.3) how to logout)
|
||||
- Display notebooks, and notes
|
||||
- images
|
||||
- attachments
|
||||
- code syntax highlight
|
||||
- Add a table of content if note contains headers
|
||||
- Display tags, and notes linked.
|
||||
- Joplin sync:
|
||||
- 
|
||||
- Background periodic joplin sync
|
||||
- Manual trigged sync, with notebooks and tag refresh
|
||||
- Supported target: nextcloud, Joplin server
|
||||
- Public link if note has ***public*** tag
|
||||
|
||||
- Option to number (or not) header in notes:
|
||||
|
||||
- Tag edition: add / remove / create tags in notes:
|
||||
|
||||
Once tags edited, a little reminder not to forget to synchronize Joplin:
|
||||
|
||||
- Checkbox list changes can be saved to notes.
|
||||
- 
|
||||
- Note edition / deletion, with support of image paste, and image / attachment drag&drop.
|
||||
|
||||
|
||||
|
||||
|
||||
- Note creation
|
||||
|
||||
- Notebook edition: create / rename / delete
|
||||
|
||||
- Notes history: list of the latest notes consulted, to be able to open them quickly, or pin them:
|
||||
|
||||
- Tabs in notes (not displayed in joplin applications). Syntax here.
|
||||
|
||||
- Hyperlink preview in notes, on mouse hover:
|
||||
|
||||
- Render KaTeX:
|
||||
|
||||
|
||||
### No it doesn't (yet?) 💔
|
||||
- Sort notebooks nor notes
|
||||
- Move note or notebook from one notebook to another.
|
||||
- No specific handling for todos.
|
||||
- Search for notes or tags
|
||||
|
||||
# Installation / configuration instructions
|
||||
```diff
|
||||
! Only linux systems are supported
|
||||
! Only arm64 and amd64 architectures
|
||||
! For raspberry users (I am): use 64 bits OS
|
||||
```
|
||||
## Installation
|
||||
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](https://github.com/joplin-vieweb/joplin-vieweb/blob/main/docker-compose-joplin-only.yml). Have a look to [the containers](#components).
|
||||
If your server is apache2, have a look to [this apache configuration procedure](https://github.com/joplin-vieweb/joplin-vieweb/wiki/Install-joplin-vieweb-on-a-local-web-server,-and-access-it-externally-from-a-subdomain-through-apache2).
|
||||
|
||||
* 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:
|
||||
* ORIGINS: write the domain and/or IP address (only those origins are allowed to access joplin-vieweb)
|
||||
Exemple:
|
||||
```yaml
|
||||
x-common-variables: &common-variables
|
||||
ORIGINS: "'http://localhost:8080', 'http://192.168.21.1:8080'"
|
||||
```
|
||||
or
|
||||
```yaml
|
||||
x-common-variables: &common-variables
|
||||
ORIGINS: "'https://your_domain.com', 'https://12.34.56.78'"
|
||||
CERT_DOMAIN: your_domain.com
|
||||
CERT_MAIL: you@zaclys.net
|
||||
```
|
||||
* 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.
|
||||
* If you don't use nginx and certbot container (if you use docker-compose-joplin-only.yml):
|
||||
* Change \<PORT-TO-YOUR-PROXY\> to fit your proxy setup.
|
||||
* And "run"
|
||||
```bash
|
||||
sudo systemctl enable docker
|
||||
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
|
||||
```
|
||||
|
||||
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 pull
|
||||
sudo docker-compose up
|
||||
```
|
||||
|
||||
## Configuration and usage
|
||||
```diff
|
||||
! Users configuration is done from this url: https://your_domain.com/admin/
|
||||
! Usage url, to access joplin notes: https://your_domain.com/joplin
|
||||
```
|
||||
### Users
|
||||
First you must change admin password:
|
||||
* login to https://your_domain.com/admin/ (login: admin / password: admin)
|
||||
|
||||
* Change the admin password:
|
||||
|
||||
* If you want to login to joplin-vieweb with another login than admin: create a user:
|
||||
|
||||
* Now you can logout and visit https://your_domain.com/joplin
|
||||
|
||||
* Login with admin or your newly created user:
|
||||
|
||||
|
||||
### Synchronisation
|
||||
You should configure a synchronisation to secure your notes:
|
||||
|
||||
|
||||
1️⃣ Click the settings tab
|
||||
2️⃣ Input synchronisation data (only next cloud and joplin server are 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:
|
||||
|
||||
|
||||
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)
|
||||
|
||||
### Joplin
|
||||
You can now access your notebooks: https://your_domain/joplin (⚠ don't forget the /joplin ⚠)
|
||||
|
||||
# Components
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
version: '3.4'
|
||||
|
||||
x-common-variables: &common-variables
|
||||
ORIGINS: "'localhost', '192.168.21.1'"
|
||||
ORIGINS: "'http://localhost', 'http://192.168.21.1'"
|
||||
|
||||
services:
|
||||
django-joplin-vieweb:
|
||||
build: django-joplin-vieweb
|
||||
image: gri38/django-joplin-vieweb:latest
|
||||
depends_on:
|
||||
- joplin-terminal-xapi
|
||||
environment:
|
||||
@ -14,22 +14,22 @@ services:
|
||||
ports:
|
||||
- <PORT-TO-YOUR-PROXY>:8000
|
||||
volumes:
|
||||
- joplin-only:/root/.config/joplin:ro
|
||||
- joplin-only-vieweb:/root/.config/joplin-vieweb
|
||||
- joplin:/root/.config/joplin:ro
|
||||
- joplin-vieweb:/root/.config/joplin-vieweb
|
||||
networks:
|
||||
- joplin-only-net
|
||||
- joplin-net
|
||||
|
||||
joplin-terminal-xapi:
|
||||
build: joplin-terminal-xapi
|
||||
image: gri38/joplin-terminal-xapi:latest
|
||||
restart: unless-stopped
|
||||
volumes:
|
||||
- joplin-only:/root/.config/joplin
|
||||
- joplin:/root/.config/joplin
|
||||
networks:
|
||||
- joplin-only-net
|
||||
- joplin-net
|
||||
|
||||
volumes:
|
||||
joplin-only:
|
||||
joplin-only-vieweb:
|
||||
joplin:
|
||||
joplin-vieweb:
|
||||
|
||||
networks:
|
||||
joplin-only-net: {}
|
||||
joplin-net: {}
|
||||
|
||||
@ -1,17 +1,13 @@
|
||||
version: '3.4'
|
||||
|
||||
x-common-variables: &common-variables
|
||||
ORIGINS: "'my.domain.com', '12.34.56.78'"
|
||||
CERT_DOMAIN: my.domain.com
|
||||
CERT_MAIL: name@zaclys.net
|
||||
ORIGINS: "'https://your_domain.com', 'https://12.34.56.78'"
|
||||
CERT_DOMAIN: your_domain.com
|
||||
CERT_MAIL: you@zaclys.net
|
||||
|
||||
services:
|
||||
django-joplin-vieweb:
|
||||
# image: django-joplin-vieweb
|
||||
build: ./django-joplin-vieweb
|
||||
# command: ["/bin/sh"]
|
||||
#stdin_open: true
|
||||
#tty: true
|
||||
image: gri38/django-joplin-vieweb:latest
|
||||
depends_on:
|
||||
- joplin-terminal-xapi
|
||||
environment:
|
||||
@ -25,7 +21,7 @@ services:
|
||||
- joplin-net
|
||||
|
||||
joplin-terminal-xapi:
|
||||
build: joplin-terminal-xapi
|
||||
image: gri38/joplin-terminal-xapi:latest
|
||||
restart: unless-stopped
|
||||
volumes:
|
||||
- joplin:/root/.config/joplin
|
||||
@ -33,13 +29,10 @@ services:
|
||||
- joplin-net
|
||||
|
||||
joplin-vieweb-certbot:
|
||||
build: ./joplin-vieweb-certbot
|
||||
image: gri38/joplin-vieweb-certbot:latest
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
<<: *common-variables
|
||||
# command: ["/bin/bash"]
|
||||
# stdin_open: true
|
||||
# tty: true
|
||||
depends_on:
|
||||
- joplin-vieweb-nginx
|
||||
volumes:
|
||||
@ -47,11 +40,8 @@ services:
|
||||
- certbot_conf:/etc/letsencrypt/:rw
|
||||
|
||||
joplin-vieweb-nginx:
|
||||
build: ./joplin-vieweb-nginx
|
||||
image: gri38/joplin-vieweb-nginx:latest
|
||||
restart: unless-stopped
|
||||
# command: ["/bin/sh"]
|
||||
# stdin_open: true
|
||||
# tty: true
|
||||
ports:
|
||||
- 80:80
|
||||
- 443:443
|
||||
|
||||
Loading…
Reference in New Issue
Block a user