https://github.com/skrysm/obsidian-livesync-server
Server for LiveSync plugin for Obsidian
https://github.com/skrysm/obsidian-livesync-server
docker livesync obsidian
Last synced: 4 months ago
JSON representation
Server for LiveSync plugin for Obsidian
- Host: GitHub
- URL: https://github.com/skrysm/obsidian-livesync-server
- Owner: skrysm
- License: mit
- Created: 2025-09-17T12:24:14.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-09-19T07:08:17.000Z (9 months ago)
- Last Synced: 2025-10-09T10:48:25.762Z (8 months ago)
- Topics: docker, livesync, obsidian
- Language: Shell
- Homepage:
- Size: 32.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Server for Obsidian LiveSync
This repo contains a ready-to-use server for the [Obsidian LiveSync plugin](https://github.com/vrtmrz/obsidian-livesync). The server is hosted via Docker and automatically secured over HTTPS (certificates created by Let's Encrypt).
The setup will use port 80 (for Let's Encrypt only) and a configurable HTTPS port (443 by default).
> [!NOTE]
> This setup is for servers that can be **directly reached** from the Internet. It's *not* meant for intranet servers hidden behind Cloudflare tunnels or similar technologies.
## One-Time Setup
Create **`secrets.couchdb.env`** file in the root directory (i.e. the directory where the `docker-compose.yml` file is located):
```
COUCHDB_PASSWORD=
```
Create **`secrets.proxy.env`** file:
```
SERVER_DOMAIN=
```
> [!NOTE]
> The specified domain name (``) must resolve to the IP address of the server.
After that **restrict permissions** on the secret files:
```sh
> chmod 0600 secrets*.env
```
## Running the Server
To run the server, run:
```sh
> docker compose up -d
```
This will make the CouchDB instance accessible at:
https:///couchdb/
## Notes
* The LiveSync plugin automatically creates databases inside the CouchDB instance. As such, it needs the admin password.