You've already forked obsidian-livesync
mirror of
https://github.com/vrtmrz/obsidian-livesync.git
synced 2025-08-10 22:11:45 +02:00
246 lines
10 KiB
Markdown
246 lines
10 KiB
Markdown
# Setup a CouchDB server
|
|
|
|
## Table of Contents
|
|
|
|
- [Setup a CouchDB server](#setup-a-couchdb-server)
|
|
- [Table of Contents](#table-of-contents)
|
|
- [1. Prepare CouchDB](#1-prepare-couchdb)
|
|
- [A. Using Docker container](#a-using-docker-container)
|
|
- [1. Prepare](#1-prepare)
|
|
- [2. Run docker container](#2-run-docker-container)
|
|
- [B. Install CouchDB directly](#b-install-couchdb-directly)
|
|
- [2. Run couchdb-init.sh for initialise](#2-run-couchdb-initsh-for-initialise)
|
|
- [3. Expose CouchDB to the Internet](#3-expose-couchdb-to-the-internet)
|
|
- [4. Client Setup](#4-client-setup)
|
|
- [1. Generate the setup URI on a desktop device or server](#1-generate-the-setup-uri-on-a-desktop-device-or-server)
|
|
- [2. Setup Self-hosted LiveSync to Obsidian](#2-setup-self-hosted-livesync-to-obsidian)
|
|
- [Manual setup information](#manual-setup-information)
|
|
- [Setting up your domain](#setting-up-your-domain)
|
|
- [Reverse Proxies](#reverse-proxies)
|
|
- [Traefik](#traefik)
|
|
---
|
|
|
|
## 1. Prepare CouchDB
|
|
### A. Using Docker container
|
|
|
|
#### 1. Prepare
|
|
```bash
|
|
|
|
# Prepare environment variables.
|
|
export hostname=localhost:5984
|
|
export username=goojdasjdas #Please change as you like.
|
|
export password=kpkdasdosakpdsa #Please change as you like
|
|
|
|
# Prepare directories which save data and configurations.
|
|
mkdir couchdb-data
|
|
mkdir couchdb-etc
|
|
```
|
|
|
|
#### 2. Run docker container
|
|
|
|
1. Boot Check.
|
|
```
|
|
$ docker run --name couchdb-for-ols --rm -it -e COUCHDB_USER=${username} -e COUCHDB_PASSWORD=${password} -v ${PWD}/couchdb-data:/opt/couchdb/data -v ${PWD}/couchdb-etc:/opt/couchdb/etc/local.d -p 5984:5984 couchdb
|
|
```
|
|
If your container has been exited, please check the permission of couchdb-data, and couchdb-etc.
|
|
Once CouchDB run, these directories will be owned by uid:`5984`. Please chown it for you again.
|
|
|
|
2. Enable it in the background
|
|
```
|
|
$ docker run --name couchdb-for-ols -d --restart always -e COUCHDB_USER=${username} -e COUCHDB_PASSWORD=${password} -v ${PWD}/couchdb-data:/opt/couchdb/data -v ${PWD}/couchdb-etc:/opt/couchdb/etc/local.d -p 5984:5984 couchdb
|
|
```
|
|
If you prefer a compose file instead of docker run, here is the equivalent below:
|
|
```
|
|
services:
|
|
couchdb:
|
|
image: couchdb:latest
|
|
container_name: couchdb-for-ols
|
|
user: 1000:1000
|
|
environment:
|
|
- COUCHDB_USER=${username}
|
|
- COUCHDB_PASSWORD=${password}
|
|
volumes:
|
|
- ./couchdb-data:/opt/couchdb/data
|
|
- ./couchdb-etc:/opt/couchdb/etc/local.d
|
|
ports:
|
|
- 5984:5984
|
|
restart: unless-stopped
|
|
```
|
|
### B. Install CouchDB directly
|
|
Please refer to the [official document](https://docs.couchdb.org/en/stable/install/index.html). However, we do not have to configure it fully. Just the administrator needs to be configured.
|
|
|
|
## 2. Run couchdb-init.sh for initialise
|
|
```
|
|
curl -s https://raw.githubusercontent.com/vrtmrz/obsidian-livesync/main/utils/couchdb/couchdb-init.sh | bash
|
|
```
|
|
|
|
If it results like the following:
|
|
```
|
|
-- Configuring CouchDB by REST APIs... -->
|
|
{"ok":true}
|
|
""
|
|
""
|
|
""
|
|
""
|
|
""
|
|
""
|
|
""
|
|
""
|
|
""
|
|
<-- Configuring CouchDB by REST APIs Done!
|
|
```
|
|
|
|
Your CouchDB has been initialised successfully. If you want this manually, please read the script.
|
|
|
|
## 3. Expose CouchDB to the Internet
|
|
|
|
- You can skip this instruction if you using only in intranet and only with desktop devices.
|
|
- For mobile devices, Obsidian requires a valid SSL certificate. Usually, it needs exposing the internet.
|
|
|
|
Whatever solutions we can use. For simplicity, the following sample uses Cloudflare Zero Trust for testing.
|
|
|
|
```
|
|
cloudflared tunnel --url http://localhost:5984
|
|
```
|
|
|
|
You will then get the following output:
|
|
|
|
```
|
|
2024-02-14T10:35:25Z INF Thank you for trying Cloudflare Tunnel. Doing so, without a Cloudflare account, is a quick way to experiment and try it out. However, be aware that these account-less Tunnels have no uptime guarantee. If you intend to use Tunnels in production you should use a pre-created named tunnel by following: https://developers.cloudflare.com/cloudflare-one/connections/connect-apps
|
|
2024-02-14T10:35:25Z INF Requesting new quick Tunnel on trycloudflare.com...
|
|
2024-02-14T10:35:26Z INF +--------------------------------------------------------------------------------------------+
|
|
2024-02-14T10:35:26Z INF | Your quick Tunnel has been created! Visit it at (it may take some time to be reachable): |
|
|
2024-02-14T10:35:26Z INF | https://tiles-photograph-routine-groundwater.trycloudflare.com |
|
|
2024-02-14T10:35:26Z INF +--------------------------------------------------------------------------------------------+
|
|
:
|
|
:
|
|
:
|
|
```
|
|
Now `https://tiles-photograph-routine-groundwater.trycloudflare.com` is our server. Make it into the background once, please.
|
|
|
|
|
|
## 4. Client Setup
|
|
> [!TIP]
|
|
> Now manual configuration is not recommended for some reasons. However, if you want to do so, please use `Setup wizard`. The recommended extra configurations will be also set.
|
|
|
|
### 1. Generate the setup URI on a desktop device or server
|
|
```bash
|
|
export hostname=https://tiles-photograph-routine-groundwater.trycloudflare.com #Point to your vault
|
|
export database=obsidiannotes #Please change as you like
|
|
export passphrase=dfsapkdjaskdjasdas #Please change as you like
|
|
export username=johndoe
|
|
export password=abc123
|
|
deno run -A https://raw.githubusercontent.com/vrtmrz/obsidian-livesync/main/utils/flyio/generate_setupuri.ts
|
|
```
|
|
|
|
> [!TIP]
|
|
> What is the `passphrase`? Is it different from `uri_passphrase`?
|
|
> Yes, the `passphrase` we have exported now is for an End-to-End Encryption passphrase.
|
|
> And, `uri_passphrase` that used in the `generate_setupuri.ts` is a different one; for decrypting Set-up URI at using that.
|
|
> Why: I (vorotamoroz) think that the passphrase of the Setup-URI should be different from the E2EE passphrase to prevent exposure caused by operational errors or the possibility of evil in our environment. On top of that, I believe that it is desirable for the Setup-URI to be random. Setup-URI is inevitably long, so it goes through the clipboard. I think that its passphrase should not go through the same path, so it should essentially be typed manually.
|
|
> Hence, if we keep empty for uri_passphrase, generate_setupuri.ts generates an adjective-noun-randomnumber passphrase so that we can remember it without going through the clipboard.
|
|
|
|
You will then get the following output:
|
|
|
|
```bash
|
|
obsidian://setuplivesync?settings=%5B%22tm2DpsOE74nJAryprZO2M93wF%2Fvg.......4b26ed33230729%22%5D
|
|
|
|
Your passphrase of Setup-URI is: patient-haze
|
|
This passphrase is never shown again, so please note it in a safe place.
|
|
```
|
|
|
|
Please keep your passphrase of Setup-URI.
|
|
|
|
### 2. Setup Self-hosted LiveSync to Obsidian
|
|
[This video](https://youtu.be/7sa_I1832Xc?t=146) may help us.
|
|
1. Install Self-hosted LiveSync
|
|
2. Choose `Use the copied setup URI` from the command palette and paste the setup URI. (obsidian://setuplivesync?settings=.....).
|
|
3. Type the previously displayed passphrase (`patient-haze`) for setup-uri passphrase.
|
|
4. Answer `yes` and `Set it up...`, and finish the first dialogue with `Keep them disabled`.
|
|
5. `Reload app without save` once.
|
|
|
|
---
|
|
|
|
## Manual setup information
|
|
|
|
### Setting up your domain
|
|
|
|
Set the A record of your domain to point to your server, and host reverse proxy as you like.
|
|
Note: Mounting CouchDB on the top directory is not recommended.
|
|
Using Caddy is a handy way to serve the server with SSL automatically.
|
|
|
|
I have published [docker-compose.yml and ini files](https://github.com/vrtmrz/self-hosted-livesync-server) that launch Caddy and CouchDB at once. If you are using Traefik you can check the [Reverse Proxies](#reverse-proxies) section below.
|
|
|
|
And, be sure to check the server log and be careful of malicious access.
|
|
|
|
|
|
## Reverse Proxies
|
|
|
|
### Traefik
|
|
|
|
If you are using Traefik, this [docker-compose.yml](https://github.com/vrtmrz/obsidian-livesync/blob/main/docker-compose.traefik.yml) file (also pasted below) has all the right CORS parameters set. It assumes you have an external network called `proxy`.
|
|
|
|
```yaml
|
|
version: "2.1"
|
|
services:
|
|
couchdb:
|
|
image: couchdb:latest
|
|
container_name: obsidian-livesync
|
|
user: 1000:1000
|
|
environment:
|
|
- COUCHDB_USER=username
|
|
- COUCHDB_PASSWORD=password
|
|
volumes:
|
|
- ./data:/opt/couchdb/data
|
|
- ./local.ini:/opt/couchdb/etc/local.ini
|
|
# Ports not needed when already passed to Traefik
|
|
#ports:
|
|
# - 5984:5984
|
|
restart: unless-stopped
|
|
networks:
|
|
- proxy
|
|
labels:
|
|
- "traefik.enable=true"
|
|
# The Traefik Network
|
|
- "traefik.docker.network=proxy"
|
|
# Don't forget to replace 'obsidian-livesync.example.org' with your own domain
|
|
- "traefik.http.routers.obsidian-livesync.rule=Host(`obsidian-livesync.example.org`)"
|
|
# The 'websecure' entryPoint is basically your HTTPS entrypoint. Check the next code snippet if you are encountering problems only; you probably have a working traefik configuration if this is not your first container you are reverse proxying.
|
|
- "traefik.http.routers.obsidian-livesync.entrypoints=websecure"
|
|
- "traefik.http.routers.obsidian-livesync.service=obsidian-livesync"
|
|
- "traefik.http.services.obsidian-livesync.loadbalancer.server.port=5984"
|
|
- "traefik.http.routers.obsidian-livesync.tls=true"
|
|
# Replace the string 'letsencrypt' with your own certificate resolver
|
|
- "traefik.http.routers.obsidian-livesync.tls.certresolver=letsencrypt"
|
|
- "traefik.http.routers.obsidian-livesync.middlewares=obsidiancors"
|
|
# The part needed for CORS to work on Traefik 2.x starts here
|
|
- "traefik.http.middlewares.obsidiancors.headers.accesscontrolallowmethods=GET,PUT,POST,HEAD,DELETE"
|
|
- "traefik.http.middlewares.obsidiancors.headers.accesscontrolallowheaders=accept,authorization,content-type,origin,referer"
|
|
- "traefik.http.middlewares.obsidiancors.headers.accesscontrolalloworiginlist=app://obsidian.md,capacitor://localhost,http://localhost"
|
|
- "traefik.http.middlewares.obsidiancors.headers.accesscontrolmaxage=3600"
|
|
- "traefik.http.middlewares.obsidiancors.headers.addvaryheader=true"
|
|
- "traefik.http.middlewares.obsidiancors.headers.accessControlAllowCredentials=true"
|
|
|
|
networks:
|
|
proxy:
|
|
external: true
|
|
```
|
|
|
|
Partial `traefik.yml` config file mentioned in above:
|
|
```yml
|
|
...
|
|
|
|
entryPoints:
|
|
web:
|
|
address: ":80"
|
|
http:
|
|
redirections:
|
|
entryPoint:
|
|
to: "websecure"
|
|
scheme: "https"
|
|
websecure:
|
|
address: ":443"
|
|
|
|
...
|
|
```
|