diff --git a/services/donetick/README.md b/services/donetick/README.md index f584d2e0..a74481ed 100644 --- a/services/donetick/README.md +++ b/services/donetick/README.md @@ -1,19 +1,26 @@ -# Donetick with Tailscale Sidecar Configuration +# Donetick with Tailscale Sidecar Configuration This Docker Compose configuration sets up **[Donetick](https://github.com/donetick/donetick)** with Tailscale as a sidecar container to securely manage and access your self-hosted task management system over a private Tailscale network. By integrating Tailscale, you can ensure that your Donetick instance remains private and accessible only to authorized devices within your Tailscale network. -## Donetick +## Donetick [Donetick](https://github.com/donetick/donetick) is a **self-hosted task and checklist manager** designed for simplicity and efficiency. It helps users stay organized with structured to-do lists and task tracking while ensuring full control over their data. With Donetick, you can create tasks, set deadlines, and track progress without relying on third-party services. By integrating Tailscale, you can further secure your Donetick instance by restricting access to only authorized devices within your private network. -## Key Features +## Key Features -- **Task & Checklist Management** – Organize and track tasks efficiently. -- **Collaborative Workflows** – Share tasks and checklists with team members. -- **Self-Hosted Privacy** – Keep full control over your task management data. -- **Minimalist & Lightweight** – A simple, distraction-free interface for productivity. -- **Secure Access with Tailscale** – Restrict access to only authorized devices within your private network. +- **Task & Checklist Management** – Organize and track tasks efficiently. +- **Collaborative Workflows** – Share tasks and checklists with team members. +- **Self-Hosted Privacy** – Keep full control over your task management data. +- **Minimalist & Lightweight** – A simple, distraction-free interface for productivity. +- **Secure Access with Tailscale** – Restrict access to only authorized devices within your private network. -## Configuration Overview +## Configuration Overview -In this setup, the `tailscale-donetick` service runs Tailscale, which manages secure networking for the Donetick service. The `donetick` service uses the Tailscale network stack via Docker's `network_mode: service:` configuration. This ensures that Donetick’s web interface is only accessible through the Tailscale network (or locally, if preferred), adding an extra layer of security and privacy for managing tasks and checklists. +In this setup, the `tailscale-donetick` service runs Tailscale, which manages secure networking for the Donetick service. The `donetick` service uses the Tailscale network stack via Docker's `network_mode: service:` configuration. This ensures that Donetick’s web interface is only accessible through the Tailscale network (or locally, if preferred), adding an extra layer of security and privacy for managing tasks and checklists. + +## Files to check + +Please check the following contents for validity as some variables need to be defined upfront. + +- `.env` // Main variable `TS_AUTHKEY` +- `donetick-data/config/selfhosted.yaml` // Generate jwt secret with e.g. openssl rand -base64 32 diff --git a/services/donetick/donetick-data/config/selfhosted.yaml b/services/donetick/donetick-data/config/selfhosted.yaml index 37e9d9b4..d140d451 100644 --- a/services/donetick/donetick-data/config/selfhosted.yaml +++ b/services/donetick/donetick-data/config/selfhosted.yaml @@ -15,7 +15,7 @@ database: password: "secret" name: "secret" jwt: - secret: "secret" + secret: "change_this_to_a_secure_random_string_32_characters_long" session_time: 168h max_refresh: 168h server: @@ -48,4 +48,4 @@ oauth2: token_url: user_info_url: redirect_url: - name: \ No newline at end of file + name: