Skip to content

⚡️ Feature: (DOCS) Use compose.overrides.yaml, and don't store volumes in git repo. #317

Description

@cvlc12

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.yaml instead of editing the main file
  • Update compose.yaml files 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature, change or request
    No fields configured for Feature.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions