search

GothenburgBitFactory / taskchampion-sync-server

The sync server for Taskchampion
MIT License
44 stars 8 forks source link

Should this repo cover deployment? #8

Closed ryneeverett closed 4 months ago

ryneeverett commented 5 months ago

A reaction to #7.

A few questions for consideration:

  1. Are we going to document guidance on how to deploy the docker image? On various platforms?
  2. Are we going to support multiple deployment solutions or is Docker going to be the blessed solution?
  3. Do we want to support deployment solutions in the same repo as the server software itself or in (a) separate repo(s)?

I'm not necessarily opposed to allowing this repository to be a monorepo overwhelmed with deployment-related concerns but I think it should be a conscientious choice. It does seem like this could potentially distract from the development of the server software itself though as deployment often draws a separate skill set and interest.

djmitche commented 4 months ago

The answers to those questions will probably change over time, so I think it's OK to start with simple answers and try to avoid locking those answers in permanently.

For the moment, with limited people paying attention, I think it makes sense to do everything in this repo, and having a single working deployment solution is better than none. Clear documentation on how to run that would be good, too, especially if it's written to a level where someone with relatively little experience can do it.

Looking forward, it may make sense to build more general deployment strategies for the tool (e.g., in K8s, standalone with a reverse proxy like nginx, etc.), and maybe those are "supported" but less well-documented. Those might also support more advanced options such as authentication, where the docker option is optimized for a single user.