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.
This commit is contained in:
160
QUICK_REFERENCE_DOCKER.md
Normal file
160
QUICK_REFERENCE_DOCKER.md
Normal file
@@ -0,0 +1,160 @@
|
||||
# Archipelago Docker Dev - Quick Reference
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
```bash
|
||||
cd neode-ui
|
||||
npm start # Start everything (Docker + UI)
|
||||
```
|
||||
|
||||
Open: **http://localhost:8100**
|
||||
|
||||
## 🛑 Stop Everything
|
||||
|
||||
```bash
|
||||
cd neode-ui
|
||||
npm stop # Stop all containers + UI
|
||||
```
|
||||
|
||||
## 📱 App URLs
|
||||
|
||||
| App | URL | Default Creds |
|
||||
|-----|-----|---------------|
|
||||
| **Neode UI** | http://localhost:8100 | - |
|
||||
| Grafana | http://localhost:3000 | admin/admin |
|
||||
| Home Assistant | http://localhost:8123 | (create on first run) |
|
||||
| Mempool | http://localhost:4080 | - |
|
||||
| SearXNG | http://localhost:8082 | - |
|
||||
| Penpot | http://localhost:9001 | (create account) |
|
||||
| OnlyOffice | http://localhost:8083 | - |
|
||||
| BTCPay Server | http://localhost:14142 | (setup on first run) |
|
||||
| Ollama API | http://localhost:11434 | - |
|
||||
| Endurain | http://localhost:8084 | (placeholder) |
|
||||
| MorphOS | http://localhost:8081 | (placeholder) |
|
||||
|
||||
## 🐳 Docker Commands
|
||||
|
||||
```bash
|
||||
# View all containers
|
||||
docker compose ps
|
||||
|
||||
# View logs
|
||||
docker compose logs -f # All logs
|
||||
docker compose logs -f bitcoin # Specific app
|
||||
|
||||
# Control containers
|
||||
docker compose stop bitcoin # Stop one app
|
||||
docker compose start bitcoin # Start one app
|
||||
docker compose restart lnd # Restart one app
|
||||
|
||||
# Status check
|
||||
docker compose ps # Running containers
|
||||
docker stats # Resource usage
|
||||
|
||||
# Fresh start
|
||||
docker compose down -v # Delete all data
|
||||
docker compose up -d # Start everything
|
||||
```
|
||||
|
||||
## 🔧 Troubleshooting
|
||||
|
||||
### App won't load
|
||||
```bash
|
||||
docker compose ps # Check if running
|
||||
docker compose logs bitcoin # Check logs
|
||||
docker compose restart bitcoin # Try restart
|
||||
```
|
||||
|
||||
### Port conflict
|
||||
```bash
|
||||
lsof -i :8123 # Find what's using port
|
||||
docker compose stop # Stop all containers
|
||||
```
|
||||
|
||||
### Out of space
|
||||
```bash
|
||||
docker system prune -a # Clean up everything
|
||||
```
|
||||
|
||||
### Complete reset
|
||||
```bash
|
||||
npm stop
|
||||
docker compose down -v
|
||||
docker system prune -a
|
||||
npm start
|
||||
```
|
||||
|
||||
## 💡 Development Tips
|
||||
|
||||
### First run
|
||||
- Takes 10-30 min to download images
|
||||
- ~3-5GB of images
|
||||
- You'll be prompted to confirm
|
||||
|
||||
### Making UI changes
|
||||
- Files auto-reload on save
|
||||
- Edit in `neode-ui/src/`
|
||||
|
||||
### Testing Bitcoin
|
||||
```bash
|
||||
# Generate regtest blocks
|
||||
docker exec archy-bitcoin bitcoin-cli -regtest \
|
||||
-rpcuser=bitcoin -rpcpassword=bitcoinpass \
|
||||
generatetoaddress 101 [address]
|
||||
```
|
||||
|
||||
### View specific logs
|
||||
```bash
|
||||
docker compose logs -f --tail=100 bitcoin
|
||||
```
|
||||
|
||||
### Check resource usage
|
||||
```bash
|
||||
docker stats
|
||||
```
|
||||
|
||||
## 📁 Project Structure
|
||||
|
||||
```
|
||||
archy/
|
||||
├── docker-compose.yml # All apps defined here
|
||||
├── start-docker-apps.sh # Start script
|
||||
├── stop-docker-apps.sh # Stop script
|
||||
├── GETTING_STARTED.md # Full guide
|
||||
├── DOCKER_DEV_SETUP.md # Technical docs
|
||||
└── neode-ui/
|
||||
├── start-dev.sh # npm start
|
||||
├── stop-dev.sh # npm stop
|
||||
└── src/
|
||||
├── views/Apps.vue # My Apps page
|
||||
└── utils/dummyApps.ts # App definitions
|
||||
```
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
- **Setup Guide**: [GETTING_STARTED.md](GETTING_STARTED.md)
|
||||
- **Technical Details**: [DOCKER_DEV_SETUP.md](DOCKER_DEV_SETUP.md)
|
||||
- **What's Done**: [DOCKER_SETUP_COMPLETE.md](DOCKER_SETUP_COMPLETE.md)
|
||||
|
||||
## ⚡ Common Tasks
|
||||
|
||||
### Update images
|
||||
```bash
|
||||
docker compose pull
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
### Backup data
|
||||
```bash
|
||||
docker compose down
|
||||
cp -r /var/lib/docker/volumes ~/docker-backup
|
||||
```
|
||||
|
||||
### Add new app
|
||||
1. Edit `docker-compose.yml`
|
||||
2. Edit `neode-ui/src/utils/dummyApps.ts`
|
||||
3. Run `npm stop && npm start`
|
||||
|
||||
---
|
||||
|
||||
**Need help? See [GETTING_STARTED.md](GETTING_STARTED.md)**
|
||||
Reference in New Issue
Block a user