Add CLAUDE.md with deployment workflow guidelines
Some checks failed
Test / test (push) Has been cancelled

This commit is contained in:
2025-12-24 22:00:29 +00:00
parent 3da3578d08
commit 51feea00bb

40
CLAUDE.md Normal file
View File

@@ -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 <APP_NAME>:runtipi
```
4. Start the app:
```bash
sudo runtipi-cli app start <APP_NAME>: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