Update README and API for Docker integration and app management

- Revised README.md to clarify the use of Docker alongside Podman for containerization. - Updated API documentation to reflect new RPC endpoints, including `auth.logout`. - Enhanced WebSocket handling in the API for better connection management. - Modified Neode UI to utilize a curated list of Docker-based applications, replacing previous Start9 registry calls. - Improved error handling and logging in the marketplace for better user experience.
2026-01-27 22:55:20 +00:00
parent 10fa19df66
commit 7afefafec1
14 changed files with 1406 additions and 179 deletions
@@ -0,0 +1,242 @@
+# My Apps - Complete List (Alphabetical Order)
+
+This document shows all apps exactly as they appear in the "My Apps" section of the Neode UI.
+
+## Apps List (A-Z)
+
+### 1. Bitcoin Core ⚡
+- **Port**: 18443 (RPC)
+- **Status**: Running
+- **Type**: Full Bitcoin node (regtest mode)
+- **Description**: Bitcoin Core reference implementation
+- **Launch**: RPC only (no web UI)
+- **Docker**: `archy-bitcoin`
+
+### 2. BTCPay Server 💰
+- **Port**: 14142
+- **Status**: Running
+- **Type**: Bitcoin payment processor
+- **Description**: Self-hosted Bitcoin payment processor
+- **Launch**: http://localhost:14142
+- **Docker**: `archy-btcpay`
+
+### 3. Endurain 🚧
+- **Port**: 8084
+- **Status**: Stopped
+- **Type**: Application platform
+- **Description**: Decentralized application platform
+- **Launch**: http://localhost:8084 (placeholder)
+- **Docker**: `archy-endurain`
+
+### 4. Fedimint 🔐
+- **Port**: 8173
+- **Status**: Running
+- **Type**: Federated Bitcoin mint
+- **Description**: Federated Bitcoin minting service
+- **Launch**: http://localhost:8173 (API only)
+- **Docker**: `archy-fedimint`
+
+### 5. Grafana 📊
+- **Port**: 3000
+- **Status**: Running
+- **Type**: Analytics and monitoring
+- **Description**: Analytics and monitoring platform
+- **Launch**: http://localhost:3000
+- **Docker**: `archy-grafana`
+- **Credentials**: admin/admin
+
+### 6. Home Assistant 🏠
+- **Port**: 8123
+- **Status**: Running
+- **Type**: Home automation
+- **Description**: Open source home automation platform
+- **Launch**: http://localhost:8123
+- **Docker**: `archy-homeassistant`
+
+### 7. Lightning Stack ⚡
+- **Ports**: 8080 (REST), 9735 (P2P), 10009 (gRPC)
+- **Status**: Running
+- **Type**: Lightning Network
+- **Description**: Complete Lightning Network implementation (LND)
+- **Launch**: http://localhost:8080 (REST API)
+- **Docker**: `archy-lnd`
+
+### 8. Mempool 🔍
+- **Port**: 4080
+- **Status**: Running
+- **Type**: Blockchain explorer
+- **Description**: Bitcoin mempool and blockchain explorer
+- **Launch**: http://localhost:4080
+- **Docker**: `archy-mempool-web`, `archy-mempool-api`
+
+### 9. MorphOS Server 🚧
+- **Port**: 8081
+- **Status**: Running
+- **Type**: Server platform
+- **Description**: Flexible server platform
+- **Launch**: http://localhost:8081 (placeholder)
+- **Docker**: `archy-morphos`
+
+### 10. Ollama 🤖
+- **Port**: 11434
+- **Status**: Running
+- **Type**: Local AI
+- **Description**: Run large language models locally
+- **Launch**: http://localhost:11434 (API only)
+- **Docker**: `archy-ollama`
+
+### 11. OnlyOffice 📝
+- **Port**: 8083
+- **Status**: Running
+- **Type**: Office suite
+- **Description**: Office suite and document collaboration
+- **Launch**: http://localhost:8083
+- **Docker**: `archy-onlyoffice`
+
+### 12. Penpot 🎨
+- **Port**: 9001
+- **Status**: Running
+- **Type**: Design platform
+- **Description**: Open-source design and prototyping
+- **Launch**: http://localhost:9001
+- **Docker**: `archy-penpot-frontend`, `archy-penpot-backend`
+
+### 13. SearXNG 🔎
+- **Port**: 8082
+- **Status**: Running
+- **Type**: Search engine
+- **Description**: Privacy-respecting metasearch engine
+- **Launch**: http://localhost:8082
+- **Docker**: `archy-searxng`
+
+## Summary
+
+- **Total Apps**: 13
+- **Running by Default**: 12
+- **Stopped by Default**: 1 (Endurain)
+- **With Web UI**: 11
+- **API Only**: 2 (Bitcoin Core RPC, Ollama)
+- **Placeholders**: 2 (Endurain, MorphOS)
+
+## Categories
+
+### Bitcoin & Lightning (5 apps)
+1. Bitcoin Core
+2. BTCPay Server
+3. Fedimint
+4. Lightning Stack
+5. Mempool
+
+### Self-Hosted Services (4 apps)
+6. Grafana
+7. Home Assistant
+8. Ollama
+9. SearXNG
+
+### Collaboration (2 apps)
+10. OnlyOffice
+11. Penpot
+
+### Placeholders (2 apps)
+12. Endurain
+13. MorphOS Server
+
+## App Dependencies
+
+### Bitcoin Core Dependencies
+- **Dependent apps**: BTCPay Server, Lightning Stack, Mempool
+- **Must start first**: Yes
+
+### Database Dependencies
+- **BTCPay Server** → PostgreSQL (auto-started)
+- **Mempool** → MariaDB (auto-started)
+- **Penpot** → PostgreSQL + Redis (auto-started)
+
+## Port Map (sorted by port)
+
+| Port | App |
+|------|-----|
+| 3000 | Grafana |
+| 4080 | Mempool |
+| 8080 | Lightning Stack (REST) |
+| 8081 | MorphOS Server |
+| 8082 | SearXNG |
+| 8083 | OnlyOffice |
+| 8084 | Endurain |
+| 8123 | Home Assistant |
+| 8173 | Fedimint |
+| 9001 | Penpot |
+| 9735 | Lightning Stack (P2P) |
+| 10009 | Lightning Stack (gRPC) |
+| 11434 | Ollama |
+| 14142 | BTCPay Server |
+| 18443 | Bitcoin Core (RPC) |
+| 18444 | Bitcoin Core (P2P) |
+
+## UI Display Order
+
+Apps display alphabetically in the "My Apps" grid:
+
+```
+Row 1 (3 apps):
+┌─────────────────┬─────────────────┬─────────────────┐
+│ Bitcoin Core    │ BTCPay Server   │ Endurain        │
+└─────────────────┴─────────────────┴─────────────────┘
+
+Row 2 (3 apps):
+┌─────────────────┬─────────────────┬─────────────────┐
+│ Fedimint        │ Grafana         │ Home Assistant  │
+└─────────────────┴─────────────────┴─────────────────┘
+
+Row 3 (3 apps):
+┌─────────────────┬─────────────────┬─────────────────┐
+│ Lightning Stack │ Mempool         │ MorphOS Server  │
+└─────────────────┴─────────────────┴─────────────────┘
+
+Row 4 (3 apps):
+┌─────────────────┬─────────────────┬─────────────────┐
+│ Ollama          │ OnlyOffice      │ Penpot          │
+└─────────────────┴─────────────────┴─────────────────┘
+
+Row 5 (1 app):
+┌─────────────────┐
+│ SearXNG         │
+└─────────────────┘
+```
+
+**Note**: Order remains stable whether apps are running or stopped.
+
+## Launch Behavior
+
+### Click "Launch" Button
+- Opens app in new browser tab
+- Uses `lan-address` from app manifest
+- All running apps with UI are launchable
+
+### Click "Start" Button
+- Currently shows in UI
+- Will start Docker container (implementation pending)
+
+### Click "Stop" Button
+- Currently shows in UI  
+- Will stop Docker container (implementation pending)
+
+## Development Status
+
+### ✅ Working Now
+- All apps defined in docker-compose
+- Apps sorted alphabetically
+- Launch button opens correct URL
+- Docker containers start/stop via CLI
+
+### 🚧 In Progress
+- Backend API connection to Docker
+- Start/Stop from UI buttons
+- Health status monitoring
+- Log viewing in UI
+
+### 📋 Planned
+- App configuration UI
+- Resource usage display
+- Backup/restore functionality
+- App marketplace integration