Add service directory README with active services
This commit is contained in:
86
README.md
Normal file
86
README.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# NastyNAS Service Directory
|
||||
|
||||
Welcome to NastyNAS! This directory tracks all configured and operational services on the Unraid server.
|
||||
|
||||
## 🟢 Active Services
|
||||
|
||||
### System & Monitoring
|
||||
|
||||
#### **Pushover-On-Start** ✅
|
||||
- **Function:** Boot notification service
|
||||
- **Access:** No Web UI - Notification service only
|
||||
- **Status:** Operational - Sends alerts to phone on Unraid startup
|
||||
- **Notes:** Works as intended, could use a config dashboard in future
|
||||
|
||||
---
|
||||
|
||||
### Web Archiving & Tools
|
||||
|
||||
#### **ArchiveBox** ✅
|
||||
- **Function:** Full-featured web archiving solution
|
||||
- **Access:** [http://192.168.0.5:8092](http://192.168.0.5:8092)
|
||||
- **Status:** Operational - Manual backup functional
|
||||
- **Notes:** Consider adding automatic backup integration
|
||||
|
||||
#### **Change Detection** ✅
|
||||
- **Function:** Monitor websites for changes
|
||||
- **Access:** [http://192.168.0.5:8094](http://192.168.0.5:8094)
|
||||
- **Status:** Operational - Manual backup functional
|
||||
- **Notes:** Works well, may integrate with Kopia for automated backups
|
||||
|
||||
#### **13ft Ladder** ✅
|
||||
- **Function:** Paywall bypass proxy service
|
||||
- **Access:** [http://192.168.0.5:8093](http://192.168.0.5:8093)
|
||||
- **Status:** Operational - No configuration needed
|
||||
- **Future Plans:**
|
||||
- Configure port forwarding/subdomain access
|
||||
- Add API for Spike news alternative integration
|
||||
- Browser extension setup
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Configuration In Progress
|
||||
|
||||
*Services currently being configured will appear here as issues are closed*
|
||||
|
||||
---
|
||||
|
||||
## 📝 Future Improvements & Notes
|
||||
|
||||
### Backup Considerations
|
||||
- **ArchiveBox & Change Detection:** Currently have manual backup functionality. Evaluate whether Kopia integration is sufficient or if dedicated automatic backup is needed.
|
||||
|
||||
### Network & Access
|
||||
- **13ft Ladder:** Plan to expose via subdomain for easier access, integrate with news aggregation tools
|
||||
|
||||
### System Enhancements
|
||||
- **Pushover:** Could benefit from a simple configuration dashboard for managing notification settings
|
||||
|
||||
---
|
||||
|
||||
## 📊 Server Statistics
|
||||
|
||||
- **Total Containers:** 80+
|
||||
- **Configured:** 4
|
||||
- **In Progress:** 76+
|
||||
- **Server Uptime:** Check [Uptime Kuma](http://192.168.0.5:3001) (when configured)
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Quick Links
|
||||
|
||||
### Management
|
||||
- [Gitea Issues](http://192.168.0.5:3022/tonym/NastyNAS/issues) - Configuration tracking
|
||||
- [Unraid WebUI](http://192.168.0.5) - Server management
|
||||
- [Portainer](http://192.168.0.5:9000) - Docker management (when configured)
|
||||
|
||||
### Coming Soon
|
||||
- Dashboard (Homepage/Homarr)
|
||||
- Plex Media Server
|
||||
- Download Management Suite
|
||||
- Home Automation
|
||||
|
||||
---
|
||||
|
||||
*Last Updated: September 14, 2025*
|
||||
*This document automatically updates as services are configured and brought online*
|
||||
Reference in New Issue
Block a user