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

fix(demo): correct docs, env config, and health checks for production readiness

Browse Source 
- Fix DrawIO/Kroki health checks from wget to curl (DrawIO has no wget,
  Kroki /health endpoint unreliable with wget)
- Fix script paths in demo/AGENTS.md (./demo-test.sh → ./scripts/demo-test.sh)
- Fix script paths in demo/README.md (./demo-stack.sh → ./scripts/demo-stack.sh)
- Fix all service URLs from 192.168.3.6 to localhost in demo/README.md
- Fix hardcoded variable references to actual port values in demo/README.md
- Fix root AGENTS.md doc paths (docs/ → demo/docs/)
- Reorganize demo.env: group related vars, fix TA_HOST to container DNS,
  fix ES_JAVA_OPTS quoting, move service credentials with their configs
- Add CWD guidance note to troubleshooting guide
- Regenerate docker-compose.yml with corrected TA_HOST

All 16 services healthy, 38/38 tests passing.

💘 Generated with Crush

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

52
demo/README.md
View File

@@ -36,15 +36,15 @@
```bash
# 🎯 Demo deployment with dynamic user detection
./demo-stack.sh deploy
./scripts/demo-stack.sh deploy
# 🔧 Comprehensive testing and validation
./demo-test.sh full
./scripts/demo-test.sh full
```
</div>
🎉 **Access all services via the Homepage dashboard at** **[http://localhost:${HOMEPAGE_PORT}](http://localhost:${HOMEPAGE_PORT})**
🎉 **Access all services via the Homepage dashboard at** **[http://localhost:4000](http://localhost:4000)**
> ⚠️ **Demo Configuration Only** - This stack is designed for demonstration purposes with no data persistence.
@@ -68,8 +68,8 @@ All configuration is managed through `demo.env` and dynamic detection:
| Script | Purpose | Usage |
|---------|---------|--------|
| **demo-stack.sh** | Dynamic deployment with user detection | `./demo-stack.sh [deploy|stop|restart]` |
| **demo-test.sh** | Comprehensive QA and validation | `./demo-test.sh [full|security|permissions]` |
| **demo-stack.sh** | Dynamic deployment with user detection | `./scripts/demo-stack.sh [deploy|stop|restart]` |
| **demo-test.sh** | Comprehensive QA and validation | `./scripts/demo-test.sh [full|security|permissions]` |
| **demo.env** | All environment variables | Source of configuration |
---
@@ -79,35 +79,35 @@ All configuration is managed through `demo.env` and dynamic detection:
### 🛠️ Developer Tools
| Service | Port | Description | 🌐 Access |
|---------|------|-------------|-----------|
| **Homepage** | 4000 | Central dashboard for service discovery | [Open](http://192.168.3.6:4000) |
| **Atomic Tracker** | 4012 | Habit tracking and personal dashboard | [Open](http://192.168.3.6:4012) |
| **Wakapi** | 4015 | Open-source WakaTime alternative for time tracking | [Open](http://192.168.3.6:4015) |
| **MailHog** | 4017 | Web and API based SMTP testing tool | [Open](http://192.168.3.6:4017) |
| **Atuin** | 4018 | Magical shell history synchronization | [Open](http://192.168.3.6:4018) |
| **Homepage** | 4000 | Central dashboard for service discovery | [Open](http://localhost:4000) |
| **Atomic Tracker** | 4012 | Habit tracking and personal dashboard | [Open](http://localhost:4012) |
| **Wakapi** | 4015 | Open-source WakaTime alternative for time tracking | [Open](http://localhost:4015) |
| **MailHog** | 4017 | Web and API based SMTP testing tool | [Open](http://localhost:4017) |
| **Atuin** | 4018 | Magical shell history synchronization | [Open](http://localhost:4018) |
### 📚 Archival & Content Management
| Service | Port | Description | 🌐 Access |
|---------|------|-------------|-----------|
| **ArchiveBox** | 4013 | Web archiving solution | [Open](http://192.168.3.6:4013) |
| **Tube Archivist** | 4014 | YouTube video archiving | [Open](http://192.168.3.6:4014) |
| **ArchiveBox** | 4013 | Web archiving solution | [Open](http://localhost:4013) |
| **Tube Archivist** | 4014 | YouTube video archiving | [Open](http://localhost:4014) |
### 🏗️ Infrastructure Services
| Service | Port | Description | 🌐 Access |
|---------|------|-------------|-----------|
| **Pi-hole** | 4006 | DNS-based ad blocking and monitoring | [Open](http://192.168.3.6:4006) |
| **Dockhand** | 4007 | Modern Docker management UI | [Open](http://192.168.3.6:4007) |
| **Pi-hole** | 4006 | DNS-based ad blocking and monitoring | [Open](http://localhost:4006) |
| **Dockhand** | 4007 | Modern Docker management UI | [Open](http://localhost:4007) |
### 📊 Monitoring & Observability
| Service | Port | Description | 🌐 Access |
|---------|------|-------------|-----------|
| **InfluxDB** | 4008 | Time series database for metrics | [Open](http://192.168.3.6:4008) |
| **Grafana** | 4009 | Analytics and visualization platform | [Open](http://192.168.3.6:4009) |
| **InfluxDB** | 4008 | Time series database for metrics | [Open](http://localhost:4008) |
| **Grafana** | 4009 | Analytics and visualization platform | [Open](http://localhost:4009) |
### 📚 Documentation & Diagramming
| Service | Port | Description | 🌐 Access |
|---------|------|-------------|-----------|
| **Draw.io** | 4010 | Web-based diagramming application | [Open](http://192.168.3.6:4010) |
| **Kroki** | 4011 | Diagrams as a service | [Open](http://192.168.3.6:4011) |
| **Draw.io** | 4010 | Web-based diagramming application | [Open](http://localhost:4010) |
| **Kroki** | 4011 | Diagrams as a service | [Open](http://localhost:4011) |
---
@@ -222,16 +222,16 @@ graph TD
```bash
# 🎯 Full deployment and validation
./demo-stack.sh deploy && ./demo-test.sh full
./scripts/demo-stack.sh deploy && ./scripts/demo-test.sh full
# 🔍 Security compliance validation
./demo-test.sh security
./scripts/demo-test.sh security
# 👤 File ownership validation
./demo-test.sh permissions
./scripts/demo-test.sh permissions
# 🌐 Network isolation validation
./demo-test.sh network
./scripts/demo-test.sh network
```
</div>
@@ -246,12 +246,12 @@ docker compose ps
docker compose logs {service-name}
# 🌐 Test individual endpoints with variables
curl -f http://localhost:${HOMEPAGE_PORT}/
curl -f http://localhost:${INFLUXDB_PORT}/ping
curl -f http://localhost:${GRAFANA_PORT}/api/health
curl -f http://localhost:4000/
curl -f http://localhost:4008/ping
curl -f http://localhost:4009/api/health
# 🔍 Validate user permissions
ls -la /var/lib/docker/volumes/${COMPOSE_PROJECT_NAME}_*/
ls -la /var/lib/docker/volumes/kneldevstack-supportstack-demo_*/
```
---