⚡️ Feature: (DOCS) Use compose.overrides.yaml, and don't store volumes in git repo.
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 55/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- docker, docker-compose
- Domain
- devops, documentation, infrastructure
Research direction
Start by locating the repository’s documentation and default compose.yaml files, then review how current instructions use compose.yaml, .env, and bind-mounted volumes. Update the documented workflow around compose.overrides.yaml and ensure the default volume paths are outside the git repository. Done means the docs and compose configurations support git pulls, branches, and newly added services without editing tracked files or storing container data in the repository.
Written by the indexing model from the issue text.
Description
Feature Description
Update docs and default compose.yaml files to:
- Use
compose.overrides.yaml - only bind folders outside the git repo
Problem It Solves
Currently the instructions are to clone the repo, cd to a service, edit compose.yaml and .env.
However this leads to problems when updating the repo (e.g. to use newly added services).
Furthermore it's complicated to use branches because of permission issues with container data stored directly in the repo directories.
Proposed Solution
- Update docs to suggest using
compose.overrides.yamlinstead of editing the main file - Update
compose.yamlfiles in order to store volumes outside the git repo (could be something like ${HOME}/scaletale-data/${SERVICE} or similar)
Could even use https://specifications.freedesktop.org/basedir/latest/ but that might be overkill
With this setup you can happily keep using git pull to pull updates and add additional services if needed.
Would you be willing to work on this feature?
- Yes, I'd like to implement this feature
- I could help with parts of this feature
- No, I'm just suggesting the feature
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 127
- Avg merge
- 15h 58m
- Merged PRs (30d)
- 16
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from tailscale-dev/ScaleTail
-
new service
Difficulty 3/5 1-2 days Newbie friendliness 45/100
tailscale-dev/ScaleTail#341 ·
Maintainers usually reply within 1 day
-
new service
Difficulty 4/5 3-5 days Newbie friendliness 48/100
tailscale-dev/ScaleTail#335 ·
Maintainers usually reply within 1 day
-
new service
Difficulty 4/5 3-5 days Newbie friendliness 30/100
tailscale-dev/ScaleTail#325 ·
Maintainers usually reply within 1 day
-
new service
Difficulty 3/5 1-2 days Newbie friendliness 52/100
tailscale-dev/ScaleTail#323 ·
Maintainers usually reply within 1 day
-
new service
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
tailscale-dev/ScaleTail#322 ·
Maintainers usually reply within 1 day
All issues in tailscale-dev/ScaleTail
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
data-umbrella/du-event-board#225 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100