Add Home

Matthias Klein 2025-08-03 20:51:36 +00:00
parent 4c52046b8e
commit 665e3fd7d1

64
Home.md Normal file

@ -0,0 +1,64 @@
# GTS-HolMirDas Documentation
Welcome to the complete documentation for **GTS-HolMirDas** - RSS-based content discovery for GoToSocial instances.
## 🚀 Getting Started
**New to GTS-HolMirDas?** Start here:
- **[Installation Guide](Installation-Guide)** - Complete setup guide with Docker deployment
- **[Quick Start](Installation-Guide#quick-start)** - Get running in 5 minutes
## 📈 Optimization & Scaling
- **[Performance & Scaling](Performance-Scaling)** - Optimization strategies and performance benchmarks
- **[Advanced Configuration](Advanced-Configuration)** - Environment variables, RSS strategies, production tips
## 📊 Monitoring & Support
- **[Monitoring & Stats](Monitoring-Stats)** - Understanding output, health monitoring, metrics
- **[Troubleshooting](Troubleshooting)** - Common issues and solutions
- **[FAQ](FAQ)** - Frequently asked questions *(coming soon)*
## 🤝 Community & Contributing
- **[Contributing Guide](Contributing)** - Development setup and contribution guidelines *(coming soon)*
- **Issues**: [Report bugs or request features](../issues)
- **Discussions**: Join the conversation on the Fediverse
---
## 📋 Quick Reference
### Key Features
- **Multi-RSS Processing**: Monitor 30+ RSS feeds simultaneously
- **Smart Federation**: Automatically discover new GoToSocial/Mastodon instances
- **Production Ready**: Docker deployment with comprehensive monitoring
- **High Performance**: Process 100+ posts per run in <5 minutes
### Typical Performance
- **Runtime**: 1-5 minutes per cycle
- **Post Discovery**: 20-100 new posts per run
- **Instance Growth**: +5-30 instances per run
- **Memory Usage**: 50-400MB depending on feed count
### Environment Quick Config
```env
GTS_SERVER_URL=https://your-instance.com
GTS_ACCESS_TOKEN=your_token_here
MAX_POSTS_PER_RUN=25
SLEEP_INTERVAL=3600
RSS_URLS_FILE=/app/rss_feeds.txt
```
---
## 🔗 External Links
- **Repository**: [git.klein.ruhr/matthias/gts-holmirdas](https://git.klein.ruhr/matthias/gts-holmirdas)
- **GoToSocial**: [Official Documentation](https://docs.gotosocial.org/)
- **Docker Hub**: *Coming soon*
---
*Last updated: January 2025*