add README

This commit is contained in:
Alex Kelly 2026-03-13 21:48:31 -04:00
commit fda2f34ff3
2 changed files with 25 additions and 0 deletions

21
README.md Normal file
View file

@ -0,0 +1,21 @@
# logseq-watch
First: I don't know anything about clojure or too much about node. As long as I
can continue to get builds to work, I'll keep this updated. But if it gets
complicated, I'm out :)
This is a docker container that provides the db-sync for self-hosted logseq
sync. I built it following the instructions at https://4shutosh.com/selfhost-logseq except instead of "VPS Deployement" I did a "Docker Deployment".
# Usage
!!As of 2026-03-13, this has only been tested locally on port 8787, so currently is extremely limited!!.
Eventually this will be put it behind an NGINX reverse proxy with a dedicated name, that I have physically set
up on my server. The docker-compose file could be extended to support that in
docker, but I am probably not going to be testing it that way myself.
Make sure you define a data directory that persists. If you don't, your sync
data will be lost when the container restarts. The example docker-compose file
is using a bind mount, you could use a named mount instead if you prefer. The
docker-compose example has commented out lines that show that.
This is very much a work in progress

View file

@ -4,5 +4,9 @@ services:
image: "codeberg.org/kellya/logseq-sync:latest"
volumes:
- ./data:/logseq-sync/data
# or use a named volume and uncomment the volume section below
# - data:/logseq-sync/data
restart: unless-stopped
network_mode: host
#volumes:
# data: