chore: add Claude Code project context

This commit is contained in:
2026-05-28 19:02:03 +00:00
parent 5330d1ba74
commit 27733e99f9
3 changed files with 75 additions and 0 deletions

View File

@@ -0,0 +1,11 @@
# Validate Docker Compose Stack
Validate the Compose stack named in `$ARGUMENTS`.
If `$ARGUMENTS` is empty, inspect the repository and validate all `*-compose.yml` files you can safely validate.
Steps:
1. Identify the compose file and matching `.env.example` file.
2. Run `docker compose config` with the example env file when possible.
3. Report syntax errors, missing variables, unsupported options, and manual values required.
4. Do not modify files unless the user asks.

View File

@@ -0,0 +1,29 @@
# Docker Compose Stack Skill
Use this skill when adding, reviewing, or modifying regular Docker Compose stacks in this repository.
## Workflow
1. Confirm the service belongs in the non-Swarm Compose repo.
2. Create or update `<service>-compose.yml`.
3. Create or update `<service>.env.example` with placeholders only.
4. Keep real secrets out of the repo.
5. Include healthchecks when practical.
6. Use configurable paths and document required host directories.
7. Validate with `docker compose config` when Docker is available.
8. Summarize changed files and any manual setup steps.
## Compose Standards
- Use 2-space YAML indentation.
- Prefer explicit image tags over unpinned `latest` when stability matters.
- Use `restart: unless-stopped` for ordinary long-running services unless there is a reason not to.
- Put service-specific networks at the bottom of the file.
- Avoid hardcoding passwords, domains, tokens, or private IP assumptions unless they are already public repo conventions.
- For reverse proxy routing, add comments instead of assuming a specific proxy unless the user provides details.
## Validation Command Pattern
```bash
docker compose --env-file <service>.env.example -f <service>-compose.yml config
```

35
CLAUDE.md Normal file
View File

@@ -0,0 +1,35 @@
# Docker Compose Stacks Repository
This repository is for regular, non-Swarm Docker Compose stacks for Wheelz's HomeLab.
## Repository Purpose
- Store standalone Docker Compose stacks that run with `docker compose`.
- Do not add Docker Swarm stack files here.
- Use this repo for services that are deployed on a single Docker host or non-Swarm compose environment.
## Rules
- Never commit real secrets, passwords, tokens, API keys, private keys, or recovery codes.
- Use `.env.example` files for required variables.
- Prefer clear service-specific filenames such as `<service>-compose.yml` and `<service>.env.example`.
- Keep persistent data paths explicit and documented.
- Prefer named volumes or clearly documented bind mounts. If bind mounts are used, make host paths configurable through `.env` variables.
- Add comments for non-obvious ports, volumes, healthchecks, hardware acceleration, and reverse-proxy expectations.
- Preserve existing files unless the user explicitly asks to replace or reorganize them.
- Do not push to Gitea unless the user explicitly asks.
## Validation
For regular Compose files, validate with:
```bash
docker compose --env-file <service>.env.example -f <service>-compose.yml config
```
If the example env intentionally contains placeholder values that prevent validation, explain what placeholders must be filled in.
## Current Files
- `immich-compose.yml` — regular Docker Compose stack for Immich.
- `immich.env.example` — example environment variables for Immich.