Fixes #628 - Add a git-ignored local/ folder for instance-specific files.

[mgruner]

Fixes #628

Adds a local/ folder that git ignores except for its README, so admins can keep instance-specific files (config snippets, own scenarios, scripts, notes, certificates) inside the deployment folder without git status or git pull touching them.

• .gitignore: ignore /local/*, keep /local/README.md
• local/README.md: explains the purpose; nothing in it is loaded automatically, files are wired in via docker-compose.override.yml or COMPOSE_FILE
• .env.dist, docker-compose.override.yml.dist: short pointers to local/

On the open questions in the issue:

1. The folder is shipped with a README, so it exists at the same path in every clone and explains itself.
2. Existing installations need nothing beyond pulling; they can move their files in afterwards.

Documentation on docs.zammad.org will follow separately.

Summary by CodeRabbit

• Documentation
  • Added guidance for keeping instance-specific scenario files, configuration snippets, scripts, notes, and certificates in local/.
  • Explained how to include local files in Compose settings and how relative paths are resolved.
  • Clarified that local files are not loaded automatically and must be added to the stack configuration.
  • Updated examples for loading optional scenarios and referencing hotfix files.
• Chores
  • .env and files in local/ are excluded from version control, except for the tracked local/README.md.

[coderabbitai]

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: c991a000-b7a9-4471-be5b-88a62226aea6

📥 Commits

Reviewing files that changed from the base of the PR and between 2f704a8 and d376868.

📒 Files selected for processing (2)

• local/README.md
• scenarios/debug/add-hotfix-rails-initializer.yml

🚧 Files skipped from review as they are similar to previous changes (1)

• local/README.md

Included review availability: Your plan provides up to 2 included reviews per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

The repository now ignores files under local/ while tracking local/README.md. The README and comments in .env.dist and docker-compose.override.yml.dist explain how to store instance-specific files and reference them in the Compose stack. The documentation states that files are not loaded automatically and must be wired in manually. The hotfix scenario comment now uses ./local/my_hotfix.rb as its example path.

Priority: ⬇️ Low

Severity of issue fixed: Low

Merge Risk: ⚪ Minimal · up to d3768

The change provides a documented location for instance-specific files without loading them automatically. No concrete merge-blocking behavior is indicated.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly describes the main change: adding a Git-ignored local/ folder for instance-specific files.
Linked Issues check	✅ Passed	[#628] The PR adds a consistent local/ directory and ignores its contents while keeping local/README.md tracked. The README documents instance-specific files, including snippets, scripts, notes, c…
Out of Scope Changes check	✅ Passed	The changes to .gitignore, local/README.md, .env.dist, docker-compose.override.yml.dist, and the hotfix example support the local/ objective in [#628]. The diff contains no unrelated deploym…
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[mgruner]

@ralf401 can you handle the docs part, please?

[fliebe92]

scenarios/debug/add-hotfix-rails-initializer.yml:9 still uses HOTFIX_FILE=./hotfixes/my_hotfix.rb as its example. That puts an untracked hotfixes/ folder in the repo root, which is exactly what #628 is about. Could we change it to HOTFIX_FILE=./local/my_hotfix.rb in this PR?

[mgruner]

@fliebe92 Thanks, the hotfix example now uses HOTFIX_FILE=./local/my_hotfix.rb (d376868).