Skip to content

Conversation

@julowe
Copy link

@julowe julowe commented Jan 10, 2026

Hello!

So this is still very much a draft pull request right now - I wanted to ask questions about repo/file organization, formatting, and documentation. The code should be in a (mostly?) finished state. And there aren't many substantive changes, just a shuffling of pieces really so that the method is the same, just the exact process changed.

Pull Request Contents

This pull request would enable github to automatically create and publish to its container registry a docker image whenever the (few) relevant files are changed.

I created a local.ini file from the curl commands in the bash script.
The Dockerfile just pulls the couchdb image and copies in the local.ini file.
I created a docker-compose file that uses docker persistent named volumes instead of mapping local directories or files.

I wrote up the start of some documentation of commands etc, but I kept it separate for now (mostly so I could focus on documenting what I was doing and writing it, instead of trying to fit it into existing documentation right away). So I wanted to ask and see how it could best be integrated to current 'setup your own server' documentation. That existing documentation file is a bit confusing to me. I have not yet made many actual edits to it, but there are some formatting changes I've checked in so far to this branch.

I've pushed it to the main branch of my fork to make sure the action work, so you can actually see the image now and install it with my instructions. https://github.com/julowe/obsidian-livesync/pkgs/container/obsidian-livesync

I have tested the compose and run methods and both seem to work well. I've cribbed some from https://github.com/oleduc/docker-obsidian-livesync-couchdb so I'll @oleduc as well to see if they have any input.

I think these changes will allow for an easier as well as automated way for people to get this docker container running. That was actually a major reason I started this work, so I could more easily use the container with a docker home-lab manager I use - Ref: my compose file for Cosmos Cloud

Questions

  1. It wasn't until later that I saw the template local.ini files in the other readme files. Are they the most up to date configurations, or better to go off of the shell script? I did not yet check to see what is the current format and sectioning of specific configuration items in the ini file. I also wasn't sure which config lines should be kept in place, or doubled up in different sections if you wanted to retain backwards compatibility? (I believe I saw that in an issue, but lost track of which one)
  2. Do you want to keep these files in the repo, or separate them into a different one? There aren't many files, but I did put them in the docker subdirectory as to not clutter up the actual plugin
  3. Does my readme in the docker directory make sense? If it mostly makes sense I will start editing that content into the existing setup your own server file for this PR.

I know I had more to ask, but forget, so I'll post this draft for now.

julowe added 24 commits January 8, 2026 21:01
The Dockerfile just copies in the local.ini file
The local.ini file is mostly a conversion of the
utils/couchdb/couchdb-init.sh script.
http://localhost:5984/_node/_local/_config
shows a `# username` user...
fix yaml to the 2 space indent
fix markdown formatting
… if not a pull request

this should now make the pull request checks run succesfully
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant