Tour/viewer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

viewer

michael1986
2025-12-02 14:08:53 +01:00
parent 4b2c9095e7
commit f541584a36
4 changed files with 138 additions and 138 deletions
Download Patch File Download Diff File Expand all files Collapse all files

114
DEPLOY_SERVER_SETUP.md

@@ -72,35 +72,35 @@ Located in: **Settings → Git Hooks → post-receive**
```bash ```bash
#!/usr/bin/env bash #!/usr/bin/env bash
/usr/local/bin/app-deploy diagram /usr/local/bin/app-deploy viewer
``` ```
#### 3. App Deploy Script (Server) #### 3. App Deploy Script (Server)
Runs as Linux user `git`: Runs as Linux user `git`:
```bash ```bash
app-deploy diagram app-deploy viewer
``` ```
This script performs: This script performs:
1. `cd /opt/apps/diagram` 1. `cd /opt/apps/viewer`
2. `git pull --ff-only` from `git@git.appmodel.nl:Tour/diagram.git` 2. `git pull --ff-only` from `git@git.appmodel.nl:Tour/viewer.git`
3. `cd /home/tour/infra/diagram` 3. `cd /home/tour/infra/viewer`
4. `docker compose up -d --build diagram` 4. `docker compose up -d --build viewer`
#### 4. Docker Build (Server) #### 4. Docker Build (Server)
Multi-stage build process: Multi-stage build process:
- **Stage 1**: Build diagrams using Python + Graphviz - **Stage 1**: Build viewer using Python + Graphviz
- **Stage 2**: Serve with Nginx - **Stage 2**: Serve with Nginx
#### 5. Traefik Routing (Server) #### 5. Traefik Routing (Server)
Traefik automatically detects the container via labels and publishes: Traefik automatically detects the container via labels and publishes:
``` ```
https://diagram.appmodel.nl https://viewer.appmodel.nl
``` ```
#### 6. DNS Resolution (AdGuard) #### 6. DNS Resolution (AdGuard)
AdGuard resolves `diagram.appmodel.nl` → Build server IP AdGuard resolves `viewer.appmodel.nl` → Build server IP
Result: Both internal and external clients use the same URL. Result: Both internal and external clients use the same URL.
@@ -108,7 +108,7 @@ Result: Both internal and external clients use the same URL.
``` ```
/opt/apps/ /opt/apps/
└── diagram/ # Git repository (pulled from Gitea) └── viewer/ # Git repository (pulled from Gitea)
├── Dockerfile ├── Dockerfile
├── docker-compose.yml ├── docker-compose.yml
├── requirements.txt ├── requirements.txt
@@ -118,12 +118,12 @@ Result: Both internal and external clients use the same URL.
└── index.html └── index.html
/home/tour/infra/ /home/tour/infra/
└── diagram/ └── viewer/
├── docker-compose.yml # Docker Compose config (may differ from repo) ├── docker-compose.yml # Docker Compose config (may differ from repo)
└── logs/ # Nginx logs (optional) └── logs/ # Nginx logs (optional)
/var/log/ /var/log/
└── app-deploy-diagram.log # Deployment logs └── app-deploy-viewer.log # Deployment logs
``` ```
## Setup Instructions ## Setup Instructions
@@ -133,19 +133,19 @@ Result: Both internal and external clients use the same URL.
1. Navigate to: https://git.appmodel.nl 1. Navigate to: https://git.appmodel.nl
2. Create new repository: 2. Create new repository:
- **Owner**: `Tour` - **Owner**: `Tour`
- **Name**: `diagram` - **Name**: `viewer`
- **Visibility**: Private - **Visibility**: Private
### 2. Initialize Local Repository ### 2. Initialize Local Repository
```bash ```bash
# On dev machine # On dev machine
git clone git@git.appmodel.nl:Tour/diagram.git git clone git@git.appmodel.nl:Tour/viewer.git
cd diagram cd viewer
# Add project files # Add project files
git add Dockerfile docker-compose.yml requirements.txt *.py public/ git add Dockerfile docker-compose.yml requirements.txt *.py public/
git commit -m "Initial commit: diagram viewer" git commit -m "Initial commit: viewer"
git push origin main git push origin main
``` ```
@@ -153,23 +153,23 @@ git push origin main
```bash ```bash
# On server as appropriate user # On server as appropriate user
sudo -u git mkdir -p /opt/apps/diagram sudo -u git mkdir -p /opt/apps/viewer
sudo -u git git clone git@git.appmodel.nl:Tour/diagram.git /opt/apps/diagram sudo -u git git clone git@git.appmodel.nl:Tour/viewer.git /opt/apps/viewer
mkdir -p /home/tour/infra/diagram mkdir -p /home/tour/infra/viewer
cp /opt/apps/diagram/docker-compose.yml /home/tour/infra/diagram/ cp /opt/apps/viewer/docker-compose.yml /home/tour/infra/viewer/
``` ```
### 4. Configure Gitea Post-Receive Hook ### 4. Configure Gitea Post-Receive Hook
1. Go to: https://git.appmodel.nl/Tour/diagram 1. Go to: https://git.appmodel.nl/Tour/viewer
2. Navigate to: **Settings → Git Hooks** 2. Navigate to: **Settings → Git Hooks**
3. Select: **post-receive** 3. Select: **post-receive**
4. Add script: 4. Add script:
```bash ```bash
#!/usr/bin/env bash #!/usr/bin/env bash
/usr/local/bin/app-deploy diagram /usr/local/bin/app-deploy viewer
``` ```
5. Save and test 5. Save and test
@@ -178,24 +178,24 @@ cp /opt/apps/diagram/docker-compose.yml /home/tour/infra/diagram/
Add DNS record in AdGuard: Add DNS record in AdGuard:
``` ```
diagram.appmodel.nl → <server-ip> viewer.appmodel.nl → <server-ip>
``` ```
### 6. Test Deployment ### 6. Test Deployment
```bash ```bash
# Manual test on server # Manual test on server
app-deploy diagram app-deploy viewer
# Verify container is running # Verify container is running
cd /home/tour/infra/diagram cd /home/tour/infra/viewer
docker compose ps docker compose ps
# Check logs # Check logs
docker compose logs -f diagram docker compose logs -f viewer
# Test endpoint # Test endpoint
curl -I https://diagram.appmodel.nl curl -I https://viewer.appmodel.nl
``` ```
## Docker Configuration ## Docker Configuration
@@ -231,21 +231,21 @@ CMD ["nginx", "-g", "daemon off;"]
version: '3.8' version: '3.8'
services: services:
diagram: viewer:
build: build:
context: . context: .
dockerfile: Dockerfile dockerfile: Dockerfile
container_name: diagram-viewer container_name: viewer
restart: unless-stopped restart: unless-stopped
networks: networks:
- traefik_net - traefik_net
labels: labels:
- "traefik.enable=true" - "traefik.enable=true"
- "traefik.http.routers.diagram.rule=Host(`diagram.appmodel.nl`)" - "traefik.http.routers.viewer.rule=Host(`viewer.appmodel.nl`)"
- "traefik.http.routers.diagram.entrypoints=websecure" - "traefik.http.routers.viewer.entrypoints=websecure"
- "traefik.http.routers.diagram.tls=true" - "traefik.http.routers.viewer.tls=true"
- "traefik.http.routers.diagram.tls.certresolver=letsencrypt" - "traefik.http.routers.viewer.tls.certresolver=letsencrypt"
- "traefik.http.services.diagram.loadbalancer.server.port=80" - "traefik.http.services.viewer.loadbalancer.server.port=80"
networks: networks:
traefik_net: traefik_net:
@@ -274,7 +274,7 @@ python lan_architecture.py
# Commit and push # Commit and push
git add . git add .
git commit -m "Update diagram architecture" git commit -m "Update viewer architecture"
git push git push
``` ```
@@ -295,13 +295,13 @@ If needed, manually trigger deployment:
```bash ```bash
# On server # On server
app-deploy diagram app-deploy viewer
# Or manually # Or manually
cd /opt/apps/diagram cd /opt/apps/viewer
git pull git pull
cd /home/tour/infra/diagram cd /home/tour/infra/viewer
docker compose up -d --build diagram docker compose up -d --build viewer
``` ```
## Monitoring & Troubleshooting ## Monitoring & Troubleshooting
@@ -310,39 +310,39 @@ docker compose up -d --build diagram
```bash ```bash
# Deployment logs # Deployment logs
tail -f /var/log/app-deploy-diagram.log tail -f /var/log/app-deploy-viewer.log
# Container logs # Container logs
cd /home/tour/infra/diagram cd /home/tour/infra/viewer
docker compose logs -f diagram docker compose logs -f viewer
# Nginx access logs (if volume mounted) # Nginx access logs (if volume mounted)
tail -f /home/tour/infra/diagram/logs/access.log tail -f /home/tour/infra/viewer/logs/access.log
``` ```
### Check Container Status ### Check Container Status
```bash ```bash
cd /home/tour/infra/diagram cd /home/tour/infra/viewer
# List running containers # List running containers
docker compose ps docker compose ps
# Inspect container # Inspect container
docker compose exec diagram sh docker compose exec viewer sh
# Test nginx config # Test nginx config
docker compose exec diagram nginx -t docker compose exec viewer nginx -t
``` ```
### Debug Build Issues ### Debug Build Issues
```bash ```bash
# Rebuild without cache # Rebuild without cache
docker compose build --no-cache diagram docker compose build --no-cache viewer
# View build output # View build output
docker compose up --build diagram docker compose up --build viewer
# Check image layers # Check image layers
docker image history diagram-viewer docker image history diagram-viewer
@@ -356,7 +356,7 @@ docker image history diagram-viewer
**Solution**: Verify `requirements.txt` is correct **Solution**: Verify `requirements.txt` is correct
```bash ```bash
cd /opt/apps/diagram cd /opt/apps/viewer
cat requirements.txt cat requirements.txt
``` ```
@@ -366,7 +366,7 @@ cat requirements.txt
**Solution**: Check if files were copied correctly **Solution**: Check if files were copied correctly
```bash ```bash
docker compose exec diagram ls -la /usr/share/nginx/html/ docker compose exec viewer ls -la /usr/share/nginx/html/
``` ```
#### 3. Traefik Not Routing #### 3. Traefik Not Routing
@@ -375,8 +375,8 @@ docker compose exec diagram ls -la /usr/share/nginx/html/
**Solution**: **Solution**:
- Verify container is on `traefik_net`: `docker network inspect traefik_net` - Verify container is on `traefik_net`: `docker network inspect traefik_net`
- Check Traefik labels: `docker inspect diagram-viewer | grep traefik` - Check Traefik labels: `docker inspect viewer | grep traefik`
- Verify DNS: `nslookup diagram.appmodel.nl` - Verify DNS: `nslookup viewer.appmodel.nl`
#### 4. Git Pull Fails #### 4. Git Pull Fails
@@ -384,7 +384,7 @@ docker compose exec diagram ls -la /usr/share/nginx/html/
**Solution**: **Solution**:
- Check SSH keys for git user: `sudo -u git ssh -T git@git.appmodel.nl` - Check SSH keys for git user: `sudo -u git ssh -T git@git.appmodel.nl`
- Verify remote: `cd /opt/apps/diagram && git remote -v` - Verify remote: `cd /opt/apps/viewer && git remote -v`
## Security Considerations ## Security Considerations
@@ -407,7 +407,7 @@ For apps requiring secrets:
```yaml ```yaml
# In docker-compose.yml # In docker-compose.yml
services: services:
diagram: viewer:
environment: environment:
- SECRET_KEY=${SECRET_KEY} - SECRET_KEY=${SECRET_KEY}
env_file: env_file:
@@ -416,8 +416,8 @@ services:
Create `.env` file on server: Create `.env` file on server:
```bash ```bash
echo "SECRET_KEY=your-secret-here" > /home/tour/infra/diagram/.env echo "SECRET_KEY=your-secret-here" > /home/tour/infra/viewer/.env
chmod 600 /home/tour/infra/diagram/.env chmod 600 /home/tour/infra/viewer/.env
``` ```
## Scaling & Future Improvements ## Scaling & Future Improvements
@@ -490,7 +490,7 @@ Add monitoring stack:
| Service | URL | | Service | URL |
|---------|-----| |---------|-----|
| Gitea | https://git.appmodel.nl | | Gitea | https://git.appmodel.nl |
| Diagram Viewer | https://diagram.appmodel.nl | | Diagram Viewer | https://viewer.appmodel.nl |
| Traefik Dashboard | https://traefik.appmodel.nl/dashboard/ | | Traefik Dashboard | https://traefik.appmodel.nl/dashboard/ |
## Support ## Support

54
Home.md

@@ -25,8 +25,8 @@ This project provides a static web interface for viewing and managing network ar
```bash ```bash
# Clone repository # Clone repository
git clone git@git.appmodel.nl:Tour/diagram.git git clone git@git.appmodel.nl:Tour/viewer.git
cd diagram cd viewer
# Create virtual environment # Create virtual environment
python -m venv .venv python -m venv .venv
@@ -47,7 +47,7 @@ python main.py
### Project Structure ### Project Structure
``` ```
diagram/ viewer/
├── Dockerfile # Multi-stage build for production ├── Dockerfile # Multi-stage build for production
├── docker-compose.yml # Docker Compose configuration ├── docker-compose.yml # Docker Compose configuration
├── requirements.txt # Python dependencies ├── requirements.txt # Python dependencies
@@ -121,11 +121,11 @@ The project uses a fully automated Docker-based deployment pipeline:
```bash ```bash
# On server: Create app structure # On server: Create app structure
apps-create diagram static-fe apps-create viewer static-fe
# This creates: # This creates:
# - /opt/apps/diagram (git repository) # - /opt/apps/viewer (git repository)
# - /home/tour/infra/diagram/docker-compose.yml # - /home/tour/infra/viewer/docker-compose.yml
``` ```
#### 2. Configure Gitea Hook #### 2. Configure Gitea Hook
@@ -134,7 +134,7 @@ In repository **Settings → Git Hooks → post-receive**:
```bash ```bash
#!/usr/bin/env bash #!/usr/bin/env bash
/usr/local/bin/app-deploy diagram /usr/local/bin/app-deploy viewer
``` ```
#### 3. Deploy #### 3. Deploy
@@ -149,7 +149,7 @@ The server automatically:
- Pulls latest code - Pulls latest code
- Rebuilds Docker image - Rebuilds Docker image
- Restarts container - Restarts container
- Updates live site at https://diagram.appmodel.nl - Updates live site at https://viewer.appmodel.nl
### Manual Deployment ### Manual Deployment
@@ -157,24 +157,24 @@ If needed:
```bash ```bash
# On server # On server
app-deploy diagram app-deploy viewer
# Or step-by-step # Or step-by-step
cd /opt/apps/diagram cd /opt/apps/viewer
git pull git pull
cd /home/tour/infra/diagram cd /home/tour/infra/viewer
docker compose up -d --build diagram docker compose up -d --build viewer
``` ```
### Monitoring ### Monitoring
```bash ```bash
# View deployment logs # View deployment logs
tail -f /var/log/app-deploy-diagram.log tail -f /var/log/app-deploy-viewer.log
# View container logs # View container logs
cd /home/tour/infra/diagram cd /home/tour/infra/viewer
docker compose logs -f diagram docker compose logs -f viewer
# Check container status # Check container status
docker compose ps docker compose ps
@@ -193,7 +193,7 @@ docker compose ps
│ │ │ │
│ ┌──────────────┐ │ │ ┌──────────────┐ │
│ │ Gitea │ (Source of Truth) │ │ │ Gitea │ (Source of Truth) │
│ │ Tour/diagram │ │ │ │ Tour/viewer │ │
│ └──────┬───────┘ │ │ └──────┬───────┘ │
│ │ git push │ │ │ git push │
│ ↓ │ │ ↓ │
@@ -201,10 +201,10 @@ docker compose ps
│ │ Post-Receive │ (Auto-trigger) │ │ │ Post-Receive │ (Auto-trigger) │
│ │ Hook │ │ │ │ Hook │ │
│ └──────┬───────┘ │ │ └──────┬───────┘ │
│ │ app-deploy diagram │ │ │ app-deploy viewer │
│ ↓ │ │ ↓ │
│ ┌──────────────────────┐ │ │ ┌──────────────────────┐ │
│ │ /opt/apps/diagram/ │ │ │ │ /opt/apps/viewer/ │ │
│ │ (Git Repository) │ │ │ │ (Git Repository) │ │
│ └──────┬───────────────┘ │ │ └──────┬───────────────┘ │
│ │ git pull │ │ │ git pull │
@@ -238,7 +238,7 @@ docker compose ps
│ └──────┬───────────────┘ │ │ └──────┬───────────────┘ │
│ │ HTTPS │ │ │ HTTPS │
│ ↓ │ │ ↓ │
│ diagram.appmodel.nl │ │ viewer.appmodel.nl │
│ │ │ │
└─────────────────────────────────────────────┘ └─────────────────────────────────────────────┘
``` ```
@@ -262,7 +262,7 @@ The diagram viewer documents our home lab infrastructure:
| Service | URL | Description | | Service | URL | Description |
|---------|-----|-------------| |---------|-----|-------------|
| Diagram Viewer | https://diagram.appmodel.nl | This application | | Diagram Viewer | https://viewer.appmodel.nl | This application |
| Gitea | https://git.appmodel.nl | Git hosting | | Gitea | https://git.appmodel.nl | Git hosting |
| Auction Frontend | https://auction.appmodel.nl | Auction platform | | Auction Frontend | https://auction.appmodel.nl | Auction platform |
| Aupi API | https://aupi.appmodel.nl | Backend API | | Aupi API | https://aupi.appmodel.nl | Backend API |
@@ -328,11 +328,11 @@ pip install --upgrade diagrams
**Solution**: **Solution**:
```bash ```bash
# Check deployment logs # Check deployment logs
tail -f /var/log/app-deploy-diagram.log tail -f /var/log/app-deploy-viewer.log
# Rebuild manually with verbose output # Rebuild manually with verbose output
cd /home/tour/infra/diagram cd /home/tour/infra/viewer
docker compose build --no-cache --progress=plain diagram docker compose build --no-cache --progress=plain viewer
``` ```
#### Site Not Accessible #### Site Not Accessible
@@ -340,8 +340,8 @@ docker compose build --no-cache --progress=plain diagram
**Problem**: Container runs but site not reachable **Problem**: Container runs but site not reachable
**Solution**: **Solution**:
1. Check DNS: `nslookup diagram.appmodel.nl` 1. Check DNS: `nslookup viewer.appmodel.nl`
2. Verify Traefik labels: `docker inspect diagram-viewer | grep traefik` 2. Verify Traefik labels: `docker inspect viewer-viewer | grep traefik`
3. Check Traefik logs: `docker logs traefik` 3. Check Traefik logs: `docker logs traefik`
4. Test container directly: `curl http://localhost:PORT` 4. Test container directly: `curl http://localhost:PORT`
@@ -352,9 +352,9 @@ docker compose build --no-cache --progress=plain diagram
**Solution**: **Solution**:
```bash ```bash
# Force rebuild on server # Force rebuild on server
cd /home/tour/infra/diagram cd /home/tour/infra/viewer
docker compose down docker compose down
docker compose up -d --build --force-recreate diagram docker compose up -d --build --force-recreate viewer
# Clear browser cache # Clear browser cache
# Ctrl+Shift+R (Windows/Linux) or Cmd+Shift+R (macOS) # Ctrl+Shift+R (Windows/Linux) or Cmd+Shift+R (macOS)

46
Quick-Start.md

@@ -7,8 +7,8 @@ Get up and running with the Diagram Viewer in minutes.
### 1. Clone Repository ### 1. Clone Repository
```bash ```bash
git clone git@git.appmodel.nl:Tour/diagram.git git clone git@git.appmodel.nl:Tour/viewer.git
cd diagram cd viewer
``` ```
### 2. Setup Environment ### 2. Setup Environment
@@ -74,7 +74,7 @@ git push origin main
Simply navigate to: Simply navigate to:
``` ```
https://diagram.appmodel.nl https://viewer.appmodel.nl
``` ```
### Manual Deployment ### Manual Deployment
@@ -83,13 +83,13 @@ On the server:
```bash ```bash
# Trigger deployment # Trigger deployment
app-deploy diagram app-deploy viewer
# View logs # View logs
tail -f /var/log/app-deploy-diagram.log tail -f /var/log/app-deploy-viewer.log
# Check status # Check status
cd /home/tour/infra/diagram cd /home/tour/infra/viewer
docker compose ps docker compose ps
``` ```
@@ -97,27 +97,27 @@ docker compose ps
```bash ```bash
# Deployment logs # Deployment logs
tail -f /var/log/app-deploy-diagram.log tail -f /var/log/app-deploy-viewer.log
# Container logs # Container logs
cd /home/tour/infra/diagram cd /home/tour/infra/viewer
docker compose logs -f diagram docker compose logs -f viewer
# Last 100 lines # Last 100 lines
docker compose logs --tail=100 diagram docker compose logs --tail=100 viewer
``` ```
### Restart Service ### Restart Service
```bash ```bash
cd /home/tour/infra/diagram cd /home/tour/infra/viewer
# Restart container # Restart container
docker compose restart diagram docker compose restart viewer
# Full restart (rebuild) # Full restart (rebuild)
docker compose down docker compose down
docker compose up -d --build diagram docker compose up -d --build viewer
``` ```
--- ---
@@ -176,10 +176,10 @@ git push
docker compose ps docker compose ps
# Health check # Health check
docker inspect diagram-viewer | grep -A 10 Health docker inspect viewer | grep -A 10 Health
# Test endpoint # Test endpoint
curl -I https://diagram.appmodel.nl curl -I https://viewer.appmodel.nl
``` ```
--- ---
@@ -190,11 +190,11 @@ curl -I https://diagram.appmodel.nl
```bash ```bash
# Check logs # Check logs
tail -f /var/log/app-deploy-diagram.log tail -f /var/log/app-deploy-viewer.log
# Rebuild with verbose output # Rebuild with verbose output
cd /home/tour/infra/diagram cd /home/tour/infra/viewer
docker compose build --no-cache --progress=plain diagram docker compose build --no-cache --progress=plain viewer
``` ```
### Site Not Loading ### Site Not Loading
@@ -204,10 +204,10 @@ docker compose build --no-cache --progress=plain diagram
docker compose ps docker compose ps
# Check Traefik routing # Check Traefik routing
docker logs traefik | grep diagram docker logs traefik | grep viewer
# Test DNS # Test DNS
nslookup diagram.appmodel.nl nslookup viewer.appmodel.nl
# Test directly # Test directly
curl http://localhost:PORT curl http://localhost:PORT
@@ -217,8 +217,8 @@ curl http://localhost:PORT
```bash ```bash
# Force rebuild # Force rebuild
cd /home/tour/infra/diagram cd /home/tour/infra/viewer
docker compose up -d --build --force-recreate diagram docker compose up -d --build --force-recreate viewer
# Clear browser cache # Clear browser cache
# Ctrl+Shift+R (Windows/Linux) # Ctrl+Shift+R (Windows/Linux)
@@ -232,7 +232,7 @@ docker compose up -d --build --force-recreate diagram
- Read the [Home](Home.md) page for comprehensive documentation - Read the [Home](Home.md) page for comprehensive documentation
- Review [DEPLOY_SERVER_SETUP.md](../DEPLOY_SERVER_SETUP.md) for deployment details - Review [DEPLOY_SERVER_SETUP.md](../DEPLOY_SERVER_SETUP.md) for deployment details
- Check [Diagrams Library docs](https://diagrams.mingrammer.com/) for icon options - Check [Diagrams Library docs](https://diagrams.mingrammer.com/) for icon options
- Explore the [Mermaid editor](https://diagram.appmodel.nl) for live diagram editing - Explore the [Mermaid editor](https://viewer.appmodel.nl) for live diagram editing
--- ---

62
WIKI_INTEGRATION.md

@@ -35,7 +35,7 @@ git commit -m "Initialize wiki with documentation"
git push origin master git push origin master
# 4. View on Gitea # 4. View on Gitea
# Navigate to: https://git.appmodel.nl/Tour/diagram/wiki # Navigate to: https://git.appmodel.nl/Tour/viewer/wiki
``` ```
### Option 2: Use Git Submodule (Bidirectional Sync) ### Option 2: Use Git Submodule (Bidirectional Sync)
@@ -43,8 +43,8 @@ git push origin master
Keep the wiki as a submodule in the main repository for easy synchronization. Keep the wiki as a submodule in the main repository for easy synchronization.
```bash ```bash
# In the main diagram repository # In the main viewer repository
cd /c/vibe/diagram cd /c/vibe/viewer
# Remove local wiki folder # Remove local wiki folder
rm -rf wiki/ rm -rf wiki/
@@ -88,13 +88,13 @@ Similar to submodule but integrates the wiki history into the main repository.
```bash ```bash
# Add wiki as subtree # Add wiki as subtree
git subtree add --prefix=wiki git@git.appmodel.nl:Tour/diagram.wiki.git master --squash git subtree add --prefix=wiki git@git.appmodel.nl:Tour/viewer.wiki.git master --squash
# Push changes to wiki # Push changes to wiki
git subtree push --prefix=wiki git@git.appmodel.nl:Tour/diagram.wiki.git master git subtree push --prefix=wiki git@git.appmodel.nl:Tour/viewer.wiki.git master
# Pull changes from wiki # Pull changes from wiki
git subtree pull --prefix=wiki git@git.appmodel.nl:Tour/diagram.wiki.git master --squash git subtree pull --prefix=wiki git@git.appmodel.nl:Tour/viewer.wiki.git master --squash
``` ```
### Option 4: Automated Sync Script ### Option 4: Automated Sync Script
@@ -106,7 +106,7 @@ Create `sync-wiki.sh`:
#!/bin/bash #!/bin/bash
# sync-wiki.sh - Sync local wiki with Gitea # sync-wiki.sh - Sync local wiki with Gitea
WIKI_REPO="git@git.appmodel.nl:Tour/diagram.wiki.git" WIKI_REPO="git@git.appmodel.nl:Tour/viewer.wiki.git"
WIKI_DIR="wiki" WIKI_DIR="wiki"
TEMP_WIKI="/tmp/gitea-wiki-$$" TEMP_WIKI="/tmp/gitea-wiki-$$"
@@ -145,7 +145,7 @@ For your deployment pipeline, I recommend **Option 1** with a manual push:
### Step-by-Step Setup ### Step-by-Step Setup
1. **Create wiki repository on Gitea** (if not exists): 1. **Create wiki repository on Gitea** (if not exists):
- Go to: https://git.appmodel.nl/Tour/diagram - Go to: https://git.appmodel.nl/Tour/viewer
- Click "Wiki" tab - Click "Wiki" tab
- Create first page (triggers wiki repo creation) - Create first page (triggers wiki repo creation)
@@ -153,11 +153,11 @@ For your deployment pipeline, I recommend **Option 1** with a manual push:
```bash ```bash
# Clone wiki repository # Clone wiki repository
cd /c/vibe cd /c/vibe
git clone git@git.appmodel.nl:Tour/diagram.wiki.git git clone git@git.appmodel.nl:Tour/viewer.wiki.git
# Copy your wiki files # Copy your wiki files
cd diagram.wiki cd viewer.wiki
cp ../diagram/wiki/*.md . cp ../viewer/wiki/*.md .
# Verify files # Verify files
ls -la ls -la
@@ -174,7 +174,7 @@ git push origin master
``` ```
3. **Verify on Gitea**: 3. **Verify on Gitea**:
- Navigate to: https://git.appmodel.nl/Tour/diagram/wiki - Navigate to: https://git.appmodel.nl/Tour/viewer/wiki
- You should see your wiki pages - You should see your wiki pages
4. **Keep local wiki in main repo** (optional): 4. **Keep local wiki in main repo** (optional):
@@ -226,13 +226,13 @@ To automatically sync wiki on deployment, add to Gitea post-receive hook:
#!/usr/bin/env bash #!/usr/bin/env bash
# Deploy main app # Deploy main app
/usr/local/bin/app-deploy diagram /usr/local/bin/app-deploy viewer
# Sync wiki (if wiki/ folder exists in repo) # Sync wiki (if wiki/ folder exists in repo)
if [ -d "/opt/apps/diagram/wiki" ]; then if [ -d "/opt/apps/viewer/wiki" ]; then
cd /tmp cd /tmp
git clone git@git.appmodel.nl:Tour/diagram.wiki.git gitea-wiki-$$ git clone git@git.appmodel.nl:Tour/viewer.wiki.git gitea-wiki-$$
cp /opt/apps/diagram/wiki/*.md /tmp/gitea-wiki-$$/ cp /opt/apps/viewer/wiki/*.md /tmp/gitea-wiki-$$/
cd /tmp/gitea-wiki-$$ cd /tmp/gitea-wiki-$$
git add . git add .
if ! git diff --staged --quiet; then if ! git diff --staged --quiet; then
@@ -249,24 +249,24 @@ fi
Based on your current setup, here's what to do: Based on your current setup, here's what to do:
```bash ```bash
# 1. Navigate to your diagram project # 1. Navigate to your viewer project
cd /c/vibe/diagram cd /c/vibe/viewer
# 2. Clone the wiki repository (for viewer, adjust as needed) # 2. Clone the wiki repository (for viewer, adjust as needed)
cd .. cd ..
git clone git@git.appmodel.nl:Tour/diagram.wiki.git git clone git@git.appmodel.nl:Tour/viewer.wiki.git
# 3. Copy wiki files # 3. Copy wiki files
cp diagram/wiki/*.md diagram.wiki/ cp viewer/wiki/*.md viewer.wiki/
# 4. Push to Gitea # 4. Push to Gitea
cd diagram.wiki cd viewer.wiki
git add . git add .
git commit -m "Initialize wiki with deployment documentation" git commit -m "Initialize wiki with deployment documentation"
git push origin master git push origin master
# 5. Verify # 5. Verify
# Open: https://git.appmodel.nl/Tour/diagram/wiki # Open: https://git.appmodel.nl/Tour/viewer/wiki
``` ```
## Maintaining Both Wikis ## Maintaining Both Wikis
@@ -276,9 +276,9 @@ If you want to keep both local and Gitea wikis in sync:
### Manual Sync (Simple) ### Manual Sync (Simple)
```bash ```bash
# After editing local wiki files # After editing local wiki files
cd /c/vibe/diagram/wiki cd /c/vibe/viewer/wiki
cp *.md /c/vibe/diagram.wiki/ cp *.md /c/vibe/viewer.wiki/
cd /c/vibe/diagram.wiki cd /c/vibe/viewer.wiki
git add . git add .
git commit -m "Update documentation" git commit -m "Update documentation"
git push git push
@@ -288,7 +288,7 @@ git push
```json ```json
{ {
"scripts": { "scripts": {
"sync-wiki": "cp wiki/*.md ../diagram.wiki/ && cd ../diagram.wiki && git add . && git commit -m 'Sync wiki' && git push" "sync-wiki": "cp wiki/*.md ../viewer.wiki/ && cd ../viewer.wiki && git add . && git commit -m 'Sync wiki' && git push"
} }
} }
``` ```
@@ -299,8 +299,8 @@ Or create a `Makefile`:
sync-wiki: sync-wiki:
@echo "Syncing wiki to Gitea..." @echo "Syncing wiki to Gitea..."
@cp wiki/*.md ../diagram.wiki/ @cp wiki/*.md ../viewer.wiki/
@cd ../diagram.wiki && git add . && git commit -m "Sync wiki from main repo" && git push @cd ../viewer.wiki && git add . && git commit -m "Sync wiki from main repo" && git push
@echo "Wiki synced successfully!" @echo "Wiki synced successfully!"
``` ```
@@ -320,11 +320,11 @@ Usage: `make sync-wiki`
### Wiki Repository Doesn't Exist ### Wiki Repository Doesn't Exist
Create the wiki first in Gitea UI: Create the wiki first in Gitea UI:
1. Go to repository: https://git.appmodel.nl/Tour/diagram 1. Go to repository: https://git.appmodel.nl/Tour/viewer
2. Click "Wiki" tab 2. Click "Wiki" tab
3. Click "Create New Page" 3. Click "Create New Page"
4. Create a dummy page (will be overwritten) 4. Create a dummy page (will be overwritten)
5. Now you can clone `diagram.wiki.git` 5. Now you can clone `viewer.wiki.git`
### Permission Denied ### Permission Denied
@@ -337,7 +337,7 @@ ssh -T git@git.appmodel.nl
If both local and Gitea wiki are edited: If both local and Gitea wiki are edited:
```bash ```bash
cd diagram.wiki cd viewer.wiki
git pull origin master git pull origin master
# Resolve conflicts manually # Resolve conflicts manually
git add . git add .