All apps · 0 apps
Obsidian-Livesync
Docker app from simpleServer's Repository
Overview
Obsidian-LiveSync provides a Self-Hosted CoudDB backend to the Obsidian-LiveSync plugin.
To understand how to connect Obsidian to obsidian-livesync, you should follow this excellent instructional video: https://www.youtube.com/watch?v=r4NKCDirm64
Readme
View on GitHubCouchDB with Let's encrypt's SSL certificate for Self-hosted LiveSync.
What is this
- CouchDB Server which configured about CORS for Obsidian and Self-hosted LiveSync.
- Automatically set up SSL Certificates by Let's Encrypt (With Caddy).
- If you do not have any domains, self-hosted-livesync-server-tailscale is available!
Requirements
- Internet-accessible webserver
- Docker and docker-compose
- Valid domain
Limitations
- Verbose logging (Just leave it to docker now)
- Automatic detection of malicious access.
How to Use
- Clone the repository,
git clone git@github.com:vrtmrz/self-hosted-livesync-server.git - Create Caddy's network:
docker network create caddy - Configure files
caddy.handle_path_1: /e=_/*ondocker-compose.yml
You have to change thise=_to something your favorite secret word.authentication_redirect = /e=_/_utils/session.htmlonconf/local.ini
changee=_too, as same as you changed on 3.1..
- Set environment variables.
| name | value | example |
|---|---|---|
| COUCHDB_SERVER | Your server's domain | db.example.net |
| COUCHDB_USER | The account name you want to access | testuser |
| COUCHDB_PW | The password | testpassword |
- Run
docker-compose -f docker-compose.yml up
Note: If you using an arm machine,docker-compose -f docker-compose.yml -f docker-compose.arm.yml up - Check from the browser, open
https://COUCHDB_SERVER/e=_/_utils, and try to authenticate. - Check from Self-hosted LiveSync, as like below
| name | value | example |
|---|---|---|
| URI | https://COUCHDB_SERVER/e=_ | https://db.example.net/e=_ |
| Username | COUCHDB_USER | testuser |
| Password | COUCHDB_PW | testpassword |
| Database name | As you like | test |
- If you could access and use the database,
docker-compose -f docker-compose.yml startto enable your server. Note: ordocker-compose -f docker-compose.yml -f docker-compose.arm.yml start.
License
MIT
Install Obsidian-Livesync on Unraid in a few clicks.
Find Obsidian-Livesync in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.
Open the Apps tab on your Unraid server Search Community Apps for Obsidian-Livesync Review the template variables and paths Click Install
Categories
Download Statistics
29,121
Total Downloads
6,001
This Month
2,895
Avg / Month
Total Downloads Over Time
Loading chart...
Related apps
Explore more like this
Explore allDetails
Repository
gotanaccount/obsidian-livesyncLast Updated2024-10-18
First Seen2024-10-30
Runtime arguments
- Web UI
http://[IP]:[PORT:5984]/_utils- Privileged
- false
Template configuration
AppData Config PathPathrw
Container Path: /config
- Target
- /opt/couchdb/data
- Value
- /mnt/user/appdata/obsidian-livesync
CouchDB _utils Web UIPorttcp
- Target
- 5984
- Default
- 5984
- Value
- 5984
COUCHDB_USERVariable
- Default
- admin
- Value
- admin
COUCHDB_PASSWORDVariable
- Default
- password
- Value
- password