Compare commits

..

39 Commits

Author SHA1 Message Date
c69694031c test 2025-12-02 18:04:27 +01:00
05dbc38507 test 2025-12-02 18:03:22 +01:00
3233ce1998 test 2025-12-02 18:02:06 +01:00
7a12f25d0a test 2025-12-02 17:57:23 +01:00
bc7e0644e3 test 2025-12-02 17:54:15 +01:00
f6929726f4 test 2025-12-02 17:46:21 +01:00
55c4d88608 test 2025-12-02 17:43:41 +01:00
0f07e73d7d test 2025-12-02 17:41:40 +01:00
0c0b4effea test 2025-12-02 17:35:37 +01:00
ff6500e709 test 2025-12-02 17:34:49 +01:00
Gitea Deploy
eca11a82a9 Fix build script to copy static files 2025-12-02 17:30:01 +01:00
root
e3b67752b5 Test auto-deploy 2025-12-02 16:25:22 +01:00
3dd1e4d576 nTest auto-deploy 2025-12-02 16:05:12 +01:00
ce48826dd8 npm 2025-12-02 15:54:22 +01:00
cf7541b5ff npm 2025-12-02 15:52:23 +01:00
b55fdb532b npm 2025-12-02 15:45:09 +01:00
8653c510b7 npm 2025-12-02 15:44:35 +01:00
bd3eb14edc viewer 2025-12-02 14:08:53 +01:00
f6c2cb0a8a test.. 2025-12-02 13:50:28 +01:00
c2646d9680 test.. 2025-12-02 13:40:22 +01:00
2ac206ebd9 test.. 2025-12-02 13:27:26 +01:00
f6ccae25ca wiki 2025-12-02 13:21:59 +01:00
eb12cc4dd5 Images 2025-12-02 13:21:42 +01:00
aa02ea67aa wiki 2025-12-02 13:12:29 +01:00
ca3a190e32 work? 2025-12-02 12:54:36 +01:00
7a4e310acc work? 2025-12-02 12:51:30 +01:00
dba487efd4 Add wiki submodule 2025-12-02 12:45:57 +01:00
7fe32f1715 Initial wiki content 2025-12-02 12:45:56 +01:00
449006b1df Remove wiki from main repo 2025-12-02 12:44:49 +01:00
5ae2fba1e4 work? 2025-12-02 12:44:03 +01:00
77b951d415 Add wiki submodule 2025-12-02 12:43:05 +01:00
be532fd78f Remove wiki files from main repo to prepare for submodule 2025-12-02 12:43:05 +01:00
e3a8d3b98e Fix wiki submodule configuration 2025-12-02 12:42:18 +01:00
3e6ef60b9c Add wiki content 2025-12-02 12:35:14 +01:00
f2de4d7100 wiki 2025-12-02 12:29:00 +01:00
836d7dd65b Add wiki as submodule 2025-12-02 12:28:40 +01:00
02afce8229 Add documentation 2025-12-02 12:27:29 +01:00
8d536151a8 view 2025-12-02 12:24:02 +01:00
bef1bd6181 Add wiki as submodule 2025-12-02 12:20:27 +01:00
27 changed files with 7862 additions and 2919 deletions

1
.app-type Normal file
View File

@@ -0,0 +1 @@
type=static-fe

5
.gitignore vendored
View File

@@ -10,10 +10,9 @@ __pycache__/
*.so
.Python
node_modules/
# Generated diagram files
*.png
*.pdf
*.svg
*.gv
# IDE
@@ -27,7 +26,7 @@ __pycache__/
.DS_Store
Thumbs.db
# Distribution / packaging
# Distribution // packaging
dist/
build/
*.egg-info/

View File

@@ -1,61 +1,23 @@
# Multi-stage Dockerfile for static frontend deployment
# Stage 1: Build the diagrams
FROM python:3.11-slim AS builder
# Install system dependencies for Graphviz
RUN apt-get update && \
apt-get install -y --no-install-recommends \
graphviz \
&& rm -rf /var/lib/apt/lists/*
# Set working directory
# -- Build stage --
FROM node:20-alpine AS build
WORKDIR /app
# Copy requirements and install Python dependencies
COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt
# Alleen package-bestanden eerst (better caching)
COPY package*.json ./
RUN npm ci || npm install
# Copy source files
COPY *.py .
# Dan de rest van de code
COPY . .
# Generate diagrams (outputs will be in /app)
RUN python lan_architecture.py && \
python main.py
# LET OP: pas dit aan als jouw build-script anders heet
RUN npm run build
# Verify generated files exist
RUN ls -la *.png || echo "Warning: No PNG files generated"
# Stage 2: Serve with Nginx
# -- Serve stage --
FROM nginx:alpine
WORKDIR /usr/share/nginx/html
# Remove default nginx static assets
RUN rm -rf /usr/share/nginx/html/*
# Pas dit aan als jouw outputmap niet 'dist' is (bijv. 'build')
COPY --from=build /app/dist ./
# Copy generated diagram files from builder stage
COPY --from=builder /app/*.png /usr/share/nginx/html/
# Copy any HTML/CSS files for the frontend
COPY public/ /usr/share/nginx/html/
# Create a simple nginx config for serving static files
RUN echo 'server { \
listen 80; \
server_name _; \
root /usr/share/nginx/html; \
index index.html; \
location / { \
try_files $uri $uri/ /index.html; \
} \
# Enable CORS if needed \
add_header Access-Control-Allow-Origin *; \
}' > /etc/nginx/conf.d/default.conf
# Expose port 80
EXPOSE 80
# Health check
HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
CMD wget --quiet --tries=1 --spider http://localhost/ || exit 1
# Start nginx
CMD ["nginx", "-g", "daemon off;"]
# Optioneel: eigen nginx.conf voor SPA routing
# COPY nginx.conf /etc/nginx/conf.d/default.conf

View File

@@ -1,28 +1,26 @@
version: '3.8'
services:
diagram:
viewer:
build:
context: .
context: /opt/apps/viewer
dockerfile: Dockerfile
container_name: diagram-viewer
container_name: viewer
restart: unless-stopped
networks:
- traefik_net
labels:
- "traefik.enable=true"
- "traefik.http.routers.diagram.rule=Host(`diagram.appmodel.nl`)"
- "traefik.http.routers.diagram.entrypoints=websecure"
- "traefik.http.routers.diagram.tls=true"
- "traefik.http.routers.diagram.tls.certresolver=letsencrypt"
- "traefik.http.services.diagram.loadbalancer.server.port=80"
# Optional: mount logs
volumes:
- ./logs:/var/log/nginx
# Optional: environment variables
environment:
- TZ=Europe/Amsterdam
- "traefik.http.routers.viewer.rule=Host(`viewer.appmodel.nl`)"
- "traefik.http.routers.viewer.entrypoints=websecure"
- "traefik.http.routers.viewer.tls=true"
- "traefik.http.services.viewer.loadbalancer.server.port=80"
- "traefik.http.routers.viewer-http.rule=Host(`viewer.appmodel.nl`)"
- "traefik.http.routers.viewer-http.entrypoints=web"
- "traefik.http.routers.viewer-http.middlewares=viewer-https"
- "traefik.http.middlewares.viewer-https.redirectscheme.scheme=https"
- "traefik.http.routers.auction.tls.certresolver=letsencrypt",
- "traefik.http.middlewares.viewer-https.redirectscheme.permanent=true"
networks:
traefik_net:
external: true
name: traefik_net

View File

@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>Home-Lab diagram Mermaid + Kroki (Graphviz)</title>
<title>Home-Lab viewer Mermaid + Kroki (Graphviz)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<style>
:root{--bg:#f7f9fc;--text:#222;--accent:#0d6efd}
@@ -32,7 +32,7 @@
<script src="https://cdn.jsdelivr.net/npm/html2canvas@1.4.1/dist/html2canvas.min.js"></script>
</head>
<body>
<header>🏠 Home-Lab diagram editable in browser (localStorage auto-saved)</header>
<header>🏠 Home-Lab viewer editable in browser (localStorage auto-saved)</header>
<div class="wrap">
<!-- ---- LEFT: EDITOR ---- -->

Binary file not shown.

After

Width:  |  Height:  |  Size: 276 KiB

4651
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

9
package.json Normal file
View File

@@ -0,0 +1,9 @@
{
"name": "viewer",
"version": "1.0.0",
"description": "",
"maintainers": ["michael@appmodel.nl"],
"scripts": {
"build": "mkdir -p dist && cp -r public/* dist/"
}
}

BIN
public/home.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 148 KiB

BIN
public/img.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 131 KiB

View File

@@ -1,3 +1,4 @@
<!-- test321 -->
<!DOCTYPE html>
<html lang="en">
<head>
@@ -262,3 +263,4 @@ render();
</script>
</body>
</html>
<!-- Auto-deployed at $(date122`) -->

Binary file not shown.

After

Width:  |  Height:  |  Size: 284 KiB

40
test.md
View File

@@ -1,40 +0,0 @@
┌─────────────────────────────────────────────────────────────────────┐
│ 🌐 Internet / Cloud │
└────────────────┬────────────────────────────────────────────────────┘
┌─────────────────────────────────────────────────────────────────────┐
│ 🛜 Router (hub.lan) - 192.168.1.1 │
│ Gateway & DHCP │
└────────────────┬────────────────────────────────────────────────────┘
┌────────────┴────────────┬──────────────┬──────────────┐
▼ ▼ ▼ ▼
┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐
│ LAN │ │ LAN │ │ LAN │ │ LAN │
│ 192.168.│ │ Infra & │ │ Home │ │ IoT & │
│ 1.x │ │ DNS │ │ Assist │ │ Workers │
│ │ │ │ │ │ │ │
│ │ │ │ │ │ │ │
│ ┌────┐ │ │ ┌────┐ │ │ ┌────┐ │ │ ┌────┐ │
│ │Core│ │ │ │DNS │ │ │ │ HA │ │ │ │Atlas│ │
│ │ Srv│ │ │ │Host│ │ │ │Host│ │ │ │ │ │
│ └┬───┘ │ │ └┬───┘ │ │ └┬───┘ │ │ └┬───┘ │
│ │ │ │ │ │ │ │ │ │ │ │
│ ┌─▼──┐ │ │ ┌─▼──┐ │ │ ┌─▼──┐ │ │ │ │
│ │Dock│ │ │ │AdGr│ │ │ │Hass│ │ │ │ │
│ │er │ │ │ │d │ │ │ │ │ │ │ │ │
│ └────┘ │ │ └────┘ │ │ └────┘ │ │ │ │
│ │ │ │ │ │ │ │
└──────────┘ └──────────┘ └──────────┘ └──────────┘
│ ┌─────────────────────────────────────────────────────┐
└──►│ Tether Subnet 192.168.137.x │
│ ┌──────────┐ ┌──────────┐ │
│ │ Hermes │ │ Plato │ │
│ │ Worker │ │ Worker │ │
│ └──────────┘ └──────────┘ │
└─────────────────────────────────────────────────────┘
Developer Laptops
(Windows/WSL)

View File

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

View File

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

View File

@@ -7,8 +7,8 @@ Get up and running with the Diagram Viewer in minutes.
### 1. Clone Repository
```bash
git clone git@git.appmodel.nl:Tour/diagram.git
cd diagram
git clone git@git.appmodel.nl:Tour/viewer.git
cd viewer
```
### 2. Setup Environment
@@ -74,7 +74,7 @@ git push origin main
Simply navigate to:
```
https://diagram.appmodel.nl
https://viewer.appmodel.nl
```
### Manual Deployment
@@ -83,13 +83,13 @@ On the server:
```bash
# Trigger deployment
app-deploy diagram
app-deploy viewer
# View logs
tail -f /var/log/app-deploy-diagram.log
tail -f /var/log/app-deploy-viewer.log
# Check status
cd /home/tour/infra/diagram
cd /home/tour/infra/viewer
docker compose ps
```
@@ -97,27 +97,27 @@ docker compose ps
```bash
# Deployment logs
tail -f /var/log/app-deploy-diagram.log
tail -f /var/log/app-deploy-viewer.log
# Container logs
cd /home/tour/infra/diagram
docker compose logs -f diagram
cd /home/tour/infra/viewer
docker compose logs -f viewer
# Last 100 lines
docker compose logs --tail=100 diagram
docker compose logs --tail=100 viewer
```
### Restart Service
```bash
cd /home/tour/infra/diagram
cd /home/tour/infra/viewer
# Restart container
docker compose restart diagram
docker compose restart viewer
# Full restart (rebuild)
docker compose down
docker compose up -d --build diagram
docker compose up -d --build viewer
```
---
@@ -176,10 +176,10 @@ git push
docker compose ps
# Health check
docker inspect diagram-viewer | grep -A 10 Health
docker inspect viewer | grep -A 10 Health
# 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
# Check logs
tail -f /var/log/app-deploy-diagram.log
tail -f /var/log/app-deploy-viewer.log
# Rebuild with verbose output
cd /home/tour/infra/diagram
docker compose build --no-cache --progress=plain diagram
cd /home/tour/infra/viewer
docker compose build --no-cache --progress=plain viewer
```
### Site Not Loading
@@ -204,10 +204,10 @@ docker compose build --no-cache --progress=plain diagram
docker compose ps
# Check Traefik routing
docker logs traefik | grep diagram
docker logs traefik | grep viewer
# Test DNS
nslookup diagram.appmodel.nl
nslookup viewer.appmodel.nl
# Test directly
curl http://localhost:PORT
@@ -217,8 +217,8 @@ curl http://localhost:PORT
```bash
# Force rebuild
cd /home/tour/infra/diagram
docker compose up -d --build --force-recreate diagram
cd /home/tour/infra/viewer
docker compose up -d --build --force-recreate viewer
# Clear browser cache
# 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
- Review [DEPLOY_SERVER_SETUP.md](../DEPLOY_SERVER_SETUP.md) for deployment details
- 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
---

361
wiki/WIKI_INTEGRATION.md Normal file
View File

@@ -0,0 +1,361 @@
# Gitea Wiki Integration Guide
This guide explains how to integrate the local `wiki/` folder with Gitea's wiki system.
## How Gitea Wikis Work
Gitea stores wiki pages in a **separate Git repository** with the naming pattern:
```
<repository>.wiki.git
```
For the `viewer` repository:
- Main repo: `git@git.appmodel.nl:Tour/viewer.git`
- Wiki repo: `git@git.appmodel.nl:Tour/viewer.wiki.git`
Wiki pages are **markdown files** (`.md`) stored in the root of the wiki repository.
## Integration Options
### Option 1: Push Local Wiki to Gitea (Recommended)
This approach replaces the current Gitea wiki with your local content.
```bash
# 1. Clone the Gitea wiki repository
git clone git@git.appmodel.nl:Tour/viewer.wiki.git viewer-wiki
# 2. Copy your wiki files to the wiki repository
cd viewer-wiki
cp ../viewer/wiki/*.md .
# 3. Commit and push
git add .
git commit -m "Initialize wiki with documentation"
git push origin master
# 4. View on Gitea
# Navigate to: https://git.appmodel.nl/Tour/viewer/wiki
```
### Option 2: Use Git Submodule (Bidirectional Sync)
Keep the wiki as a submodule in the main repository for easy synchronization.
```bash
# In the main viewer repository
cd /c/vibe/viewer
# Remove local wiki folder
rm -rf wiki/
# Add Gitea wiki as submodule
git submodule add git@git.appmodel.nl:Tour/viewer.wiki.git wiki
# Copy your documentation
cp ../temp-wiki-backup/*.md wiki/
# Commit to wiki submodule
cd wiki
git add .
git commit -m "Add documentation"
git push origin master
# Update main repository
cd ..
git add wiki
git commit -m "Add wiki as submodule"
git push origin main
```
Now changes can be made either:
- **In Gitea UI**: Edit wiki pages directly
- **Locally**: Edit in `wiki/` folder, commit, and push
To sync changes from Gitea:
```bash
cd wiki
git pull origin master
cd ..
git add wiki
git commit -m "Update wiki submodule"
git push
```
### Option 3: Git Subtree (Advanced)
Similar to submodule but integrates the wiki history into the main repository.
```bash
# Add wiki as subtree
git subtree add --prefix=wiki git@git.appmodel.nl:Tour/viewer.wiki.git master --squash
# Push changes to wiki
git subtree push --prefix=wiki git@git.appmodel.nl:Tour/viewer.wiki.git master
# Pull changes from wiki
git subtree pull --prefix=wiki git@git.appmodel.nl:Tour/viewer.wiki.git master --squash
```
### Option 4: Automated Sync Script
Create a script to automatically sync wiki changes.
Create `sync-wiki.sh`:
```bash
#!/bin/bash
# sync-wiki.sh - Sync local wiki with Gitea
WIKI_REPO="git@git.appmodel.nl:Tour/viewer.wiki.git"
WIKI_DIR="wiki"
TEMP_WIKI="/tmp/gitea-wiki-$$"
# Clone Gitea wiki
git clone "$WIKI_REPO" "$TEMP_WIKI"
# Copy local changes to temp wiki
cp -r "$WIKI_DIR"/*.md "$TEMP_WIKI/"
# Commit and push
cd "$TEMP_WIKI"
git add .
if git diff-staged --quiet; then
echo "No changes to sync"
else
git commit -m "Sync wiki from main repository"
git push origin master
echo "Wiki synced successfully"
fi
# Cleanup
cd -
rm -rf "$TEMP_WIKI"
```
Usage:
```bash
chmod +x sync-wiki.sh
./sync-wiki.sh
```
## Recommended Workflow
For your deployment pipeline, I recommend **Option 1** with a manual push:
### Step-by-Step Setup
1. **Create wiki repository on Gitea** (if not exists):
- Go to: https://git.appmodel.nl/Tour/viewer
- Click "Wiki" tab
- Create first page (triggers wiki repo creation)
2. **Push local wiki content**:
```bash
# Clone wiki repository
cd /c/vibe
git clone git@git.appmodel.nl:Tour/viewer.wiki.git
# Copy your wiki files
cd viewer.wiki
cp ../viewer/wiki/*.md .
# Verify files
ls -la
# Commit and push
git add .
git commit -m "Initialize wiki documentation
Added:
- Home.md: Main documentation page
- Quick-Start.md: Quick start guide
"
git push origin master
```
3. **Verify on Gitea**:
- Navigate to: https://git.appmodel.nl/Tour/viewer/wiki
- You should see your wiki pages
4. **Keep local wiki in main repo** (optional):
- Keep `wiki/` folder in main repo as "source of truth"
- When updating wiki, manually sync to Gitea wiki repo
- Or set up automated sync via CI/CD
## Wiki Page Naming
Gitea wikis follow these conventions:
| Filename | URL | Purpose |
|----------|-----|---------|
| `Home.md` | `/wiki/` or `/wiki/Home` | Main wiki page |
| `Quick-Start.md` | `/wiki/Quick-Start` | Quick start guide |
| `API-Reference.md` | `/wiki/API-Reference` | API documentation |
**Rules**:
- Use PascalCase or kebab-case for multi-word pages
- Spaces in filenames become hyphens in URLs
- First page is always `Home.md`
## Linking Between Pages
In your markdown files:
```markdown
<!-- Link to another wiki page -->
[Quick Start Guide](Quick-Start)
<!-- Link with custom text -->
[Get Started](Quick-Start)
<!-- Link to main repository -->
[View Code](../)
<!-- Link to specific file -->
[Dockerfile](../src/master/Dockerfile)
<!-- External link -->
[Diagrams Library](https://diagrams.mingrammer.com/)
```
## Automation with Post-Receive Hook
To automatically sync wiki on deployment, add to Gitea post-receive hook:
```bash
#!/usr/bin/env bash
# Deploy main app
/usr/local/bin/app-deploy viewer
# Sync wiki (if wiki/ folder exists in repo)
if [ -d "/opt/apps/viewer/wiki" ]; then
cd /tmp
git clone git@git.appmodel.nl:Tour/viewer.wiki.git gitea-wiki-$$
cp /opt/apps/viewer/wiki/*.md /tmp/gitea-wiki-$$/
cd /tmp/gitea-wiki-$$
git add .
if ! git diff --staged --quiet; then
git commit -m "Auto-sync from main repository"
git push origin master
fi
cd /tmp
rm -rf /tmp/gitea-wiki-$$
fi
```
## Current Setup Instructions
Based on your current setup, here's what to do:
```bash
# 1. Navigate to your viewer project
cd /c/vibe/viewer
# 2. Clone the wiki repository (for viewer, adjust as needed)
cd ..
git clone git@git.appmodel.nl:Tour/viewer.wiki.git
# 3. Copy wiki files
cp viewer/wiki/*.md viewer.wiki/
# 4. Push to Gitea
cd viewer.wiki
git add .
git commit -m "Initialize wiki with deployment documentation"
git push origin master
# 5. Verify
# Open: https://git.appmodel.nl/Tour/viewer/wiki
```
## Maintaining Both Wikis
If you want to keep both local and Gitea wikis in sync:
### Manual Sync (Simple)
```bash
# After editing local wiki files
cd /c/vibe/viewer/wiki
cp *.md /c/vibe/viewer.wiki/
cd /c/vibe/viewer.wiki
git add .
git commit -m "Update documentation"
git push
```
### Automated Sync (Add to package.json or Makefile)
```json
{
"scripts": {
"sync-wiki": "cp wiki/*.md ../viewer.wiki/ && cd ../viewer.wiki && git add . && git commit -m 'Sync wiki' && git push"
}
}
```
Or create a `Makefile`:
```makefile
.PHONY: sync-wiki
sync-wiki:
@echo "Syncing wiki to Gitea..."
@cp wiki/*.md ../viewer.wiki/
@cd ../viewer.wiki && git add . && git commit -m "Sync wiki from main repo" && git push
@echo "Wiki synced successfully!"
```
Usage: `make sync-wiki`
## Best Practices
1. **Single Source of Truth**: Choose one location (local or Gitea) as authoritative
2. **Version Control**: Keep wiki changes in Git history
3. **Review Process**: Use pull requests for significant documentation changes
4. **Link Checking**: Regularly verify internal links work
5. **Consistent Formatting**: Use markdown linting tools
6. **Table of Contents**: Keep `Home.md` as navigation hub
## Troubleshooting
### Wiki Repository Doesn't Exist
Create the wiki first in Gitea UI:
1. Go to repository: https://git.appmodel.nl/Tour/viewer
2. Click "Wiki" tab
3. Click "Create New Page"
4. Create a dummy page (will be overwritten)
5. Now you can clone `viewer.wiki.git`
### Permission Denied
Ensure your SSH key is added to Gitea:
```bash
ssh -T git@git.appmodel.nl
```
### Merge Conflicts
If both local and Gitea wiki are edited:
```bash
cd viewer.wiki
git pull origin master
# Resolve conflicts manually
git add .
git commit -m "Merge local and remote changes"
git push
```
## Summary
**Recommended approach for your setup**:
1. Keep `wiki/` in main repository for version control
2. Manually push to Gitea wiki repository when documentation is ready
3. Optionally add automated sync in post-receive hook
4. Edit wiki locally, sync to Gitea for visibility
This gives you the best of both worlds:
- ✅ Documentation versioned with code
- ✅ Visible wiki in Gitea UI
- ✅ Easy to maintain and update
- ✅ Works with existing deployment pipeline