44 lines
1.2 KiB
Markdown
44 lines
1.2 KiB
Markdown
# Runtipi Development Guidelines
|
|
|
|
## App-Specific Context Files
|
|
- **rego-tunnel-linux**: Read `apps/rego-tunnel-linux/REGO-VPN-CONTEXT.md` for Cisco VPN container details, fixes, and troubleshooting
|
|
|
|
## 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
|