From 51feea00bbea365b0cb8a769ff67473c53d344ed Mon Sep 17 00:00:00 2001 From: alexz Date: Wed, 24 Dec 2025 22:00:29 +0000 Subject: [PATCH] Add CLAUDE.md with deployment workflow guidelines --- CLAUDE.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..1f0725d --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,40 @@ +# Runtipi Development Guidelines + +## Deployment Workflow + +**IMPORTANT:** Always follow this workflow when deploying changes to runtipi apps: + +1. Push changes to the repo: + ```bash + cd /etc/runtipi/repos/runtipi + git add . && git commit -m "message" && git push + ``` + +2. Update the appstore to pull latest changes: + ```bash + sudo runtipi-cli appstore update + ``` + +3. Stop the app: + ```bash + sudo runtipi-cli app stop :runtipi + ``` + +4. Start the app: + ```bash + sudo runtipi-cli app start :runtipi + ``` + +**NEVER** use `docker compose up/down` or `docker run` directly for runtipi apps unless debugging. + +## App Naming Convention + +Apps require the `:runtipi` namespace suffix when using runtipi-cli commands: +- `rego-tunnel-linux:runtipi` +- `cistech-tunnel:runtipi` + +## Directory Structure + +- `/etc/runtipi/repos/runtipi/apps/` - App definitions (config.json, docker-compose.yml, docker-compose.json, source/) +- `/etc/runtipi/app-data/` - Runtime app data (managed by runtipi) +- `/etc/runtipi/user-config/` - User configuration overrides