KNEL/TSYSDevStack-SupportStack-LocalWorkstation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(demo): synchronize all documentation with 16-service stack

Browse Source 
Fix all documentation to match the actual running stack. Every service
count, port number, credential, network name, container name, and
dependency is now accurate across all files.

Key changes:
- Remove all stale Portainer/portainer references (replaced by Dockhand)
- Fix project name from tsysdevstack to kneldevstack everywhere
- Fix volume name pattern (underscore not dash after project name)
- Fix network names (add -network suffix, correct subnet in commands)
- Fix Homepage category from Infrastructure to Developer Tools
- Add companion services (ta-redis, ta-elasticsearch) to all service lists
- Fix Dockhand dependency description (direct socket, not proxy)
- Remove port 4005 from all host-facing health check loops and port tables
- Fix broken commands (docker exec dockhand docker version, wrong volume globs)
- Fix INFLUXDB_ADMIN_USER credential references from demo_admin to admin
- Fix Grafana datasource user to match
- Fix misleading "ports 4000-4018" range to explicit port list
- Add Docker Socket Proxy internal-only notes where applicable
- Update root AGENTS.md service categories to match compose labels

💘 Generated with Crush

Assisted-by: GLM-5.1 via Crush <crush@charm.land>
This commit is contained in:
reachableceo
2026-04-27 13:07:02 -05:00
parent eff78907d4
commit 55aa340a6c
6 changed files with 55 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
demo/README.md
View File

@@ -58,11 +58,11 @@ All configuration is managed through `demo.env` and dynamic detection:
| Variable | Description | Default |
|-----------|-------------|----------|
| **COMPOSE_PROJECT_NAME** | Consistent naming prefix | `tsysdevstack-supportstack-demo` |
| **COMPOSE_PROJECT_NAME** | Consistent naming prefix | `kneldevstack-supportstack-demo` |
| **UID** | Current user ID | Auto-detected |
| **GID** | Current group ID | Auto-detected |
| **DOCKER_GID** | Docker group ID | Auto-detected |
| **COMPOSE_NETWORK_NAME** | Docker network name | `tsysdevstack-supportstack-demo-network` |
| **COMPOSE_NETWORK_NAME** | Docker network name | `kneldevstack-supportstack-demo-network` |
### 🎯 Deployment Scripts
@@ -158,7 +158,7 @@ services:
| Service | Health Check Path | Status |
|---------|-------------------|--------|
| **Pi-hole** (DNS Management) | `HTTP GET /` | ✅ Active |
| **Portainer** (Container Management) | `HTTP GET /` | ✅ Active |
| **Dockhand** (Container Management) | `HTTP GET /` | ✅ Active |
| **InfluxDB** (Time Series Database) | `HTTP GET /ping` | ✅ Active |
| **Grafana** (Visualization Platform) | `HTTP GET /api/health` | ✅ Active |
| **Draw.io** (Diagramming Server) | `HTTP GET /` | ✅ Active |
@@ -186,7 +186,7 @@ labels:
| Service | Username | Password | 🔗 Access |
|---------|----------|----------|-----------|
| **Grafana** | `admin` | `demo_password` | [Login](http://localhost:4009) |
| **Portainer** | `admin` | `demo_password` | [Login](http://localhost:4007) |
| **Dockhand** | `admin` | `demo_password` | [Login](http://localhost:4007) |
---
@@ -207,8 +207,9 @@ graph TD
| Service | Dependencies | Status |
|---------|--------------|--------|
| **Container Management** (Portainer) | Container Socket Proxy | 🔗 Required |
| **Container Management** (Dockhand) | Docker socket (direct mount) | 🔗 Required |
| **Visualization Platform** (Grafana) | Time Series Database (InfluxDB) | 🔗 Required |
| **Video Archiving** (Tube Archivist) | Redis (ta-redis) + Elasticsearch (ta-elasticsearch) | 🔗 Required |
| **All Other Services** | None | ✅ Standalone |
---
@@ -265,10 +266,10 @@ ls -la /var/lib/docker/volumes/${COMPOSE_PROJECT_NAME}_*/
docker info
# 🌐 Check network
docker network ls | grep tsysdevstack_supportstack
docker network ls | grep kneldevstack-supportstack-demo
# 🔄 Recreate network
docker network create tsysdevstack_supportstack
docker network create --subnet 192.168.3.0/24 --gateway 192.168.3.1 kneldevstack-supportstack-demo-network
```
#### Port conflicts
@@ -295,7 +296,7 @@ docker compose restart {service}
|-------|---------|----------|
| **DNS issues** | Pi-hole | Ensure Docker DNS settings allow custom DNS servers<br>Check that port 53 is available on the host |
| **Database connection** | Grafana-InfluxDB | Verify both services are on the same network<br>Check database connectivity: `curl http://localhost:4008/ping` |
| **Container access** | Portainer | Ensure container socket is properly mounted<br>Check Container Socket Proxy service if used |
| **Container access** | Dockhand | Ensure container socket is properly mounted<br>Check Container Socket Proxy service if used |
---
@@ -316,7 +317,7 @@ docker compose restart {service}
```bash
# 📋 List volumes
docker volume ls | grep tsysdevstack
docker volume ls | grep kneldevstack
# 🗑️ Clean up all data
docker compose down -v