GothenburgBitFactory / taskchampion-sync-server

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

Installation instructions #14

Open domalex opened 4 months ago

domalex commented 4 months ago

I didn't manage to setup a working installation. The manpage of task-sync doesn't provide enough guidance for an average user. It was already a nightmare to get taskserver syncing with taskwarrior v.2. It would be great you could make the setup and deployment more user friendly with taskchampion by providing easily understandable instructions.

djmitche commented 4 months ago

Agreed -- right now, the server exists but more as a proof-of-concept (or more accurately a "reference implementation"). Making it easier to install, configure, and run is definitely the next step for this project!

adriangalilea commented 4 months ago

Can we just run the docker file and be good to go?

I've also found this: https://www.reddit.com/r/taskwarrior/comments/1c7w61k/comment/l0cwe9r/?utm_source=share&utm_medium=web3x&utm_name=web3xcss&utm_term=1&utm_content=share_button

But would rather use the official one if there's one available.(I'm a noob to docker)

ogarcia commented 4 months ago

I have written some documentation that explains how to compile the server or install it using docker. While we discuss how to merge it you can take a look at it here.

Update: Is already merged. Go to README.md to see it.

domalex commented 3 months ago

@ogarcia your link lands on "404 - page not found". Could you let me know the new link?

ogarcia commented 3 months ago

@domalex because the pull request is already merged. Now the documentation is in the README.md

adriangalilea commented 3 months ago

@domalex the readme points to release binaries but there are none, is there any plan for those?

I want to see if I can run this on a pi zero and using docker is pushing it.

EDIT: Managed to install it, doing https://github.com/GothenburgBitFactory/taskchampion-sync-server?tab=readme-ov-file#installing-taskchampion-sync-server

When I run it, I get a blank output, I don't understand what to do next, is there any sort of documentation?

I'm guessing it uses port 8080 judging from the docker command but I have no idea what to do or what to expect.

EDIT2: Managed to make it work after some trial and error, now i'm wondering, how do I see the tasks on the server? Do I need to run an instance of taskwarrior with task config sync.server.origin http://127.0.0.1:8080 and a new client_id? or is there a way to see it directly from the server?

ogarcia commented 3 months ago

Managed to make it work after some trial and error, now i'm wondering, how do I see the tasks on the server? Do I need to run an instance of taskwarrior with task config sync.server.origin http://127.0.0.1:8080 and a new client_id? or is there a way to see it directly from the server?

This server is to keep the tasks synchronized between two or more clients, but on the server you will not see anything beyond the file it leaves where you have mounted the /var/lib/taskchampion-sync-server. It does not have any kind of frontend.

adriangalilea commented 3 months ago

@ogarcia so my idea of being both server and client with 127.0.0.1 would be the way to go, right?

I think having access to the data in the server would be great, both for debug and convenience.

ogarcia commented 3 months ago

@adriangalilea If what you are looking for is simply a local synchronization, yes, that is correct.