Dome/GTS-Federator
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Dome
2026-04-18 08:42:37 +02:00
parent c24504fa78
commit 87ed243779
1 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+16 -1
View File
@@ -39,7 +39,7 @@ GTS-Federator is a refined and modernized fork built upon the innovative concept
This version takes these foundations and optimizes them for modern production environments, focusing on native Docker integration, long-term stability, and GoToSocial's unique architectural requirements. This version takes these foundations and optimizes them for modern production environments, focusing on native Docker integration, long-term stability, and GoToSocial's unique architectural requirements.
## 🛠 What this bot is for ## 🛠 What this service is for
GTS-Federator is not a relay in the traditional sense. It is a targeted discovery engine. Instead of receiving everything from a relay, you "pull" exactly what interests you. GTS-Federator is not a relay in the traditional sense. It is a targeted discovery engine. Instead of receiving everything from a relay, you "pull" exactly what interests you.
@@ -70,6 +70,17 @@ The bot calculates its next run based on your local time. With built-in timezone
### Production-Ready Dockerization ### Production-Ready Dockerization
The entire application is container-native. It runs as a non-root user for enhanced security and can be deployed in seconds using Docker Compose. The entire application is container-native. It runs as a non-root user for enhanced security and can be deployed in seconds using Docker Compose.
## 🚀 Key Upgrades in this Fork
While the original project pioneered the core discovery concept, this fork has been fundamentally restructured for modern, containerized production environments:
- From "Script" to "Service": Replaced external dependency on system cron jobs with an internal interval-based engine, allowing for a native "always-on" Docker experience.
- Controlled Request Sequencing: Introduced staggered execution and request delays. By throttling API calls, we prevent the "thundering herd" effect, effectively load-balancing discovery traffic to keep your instance responsive.
- Resilient State Persistence: Upgraded from simple URL tracking to a structured JSON database that persists across container restarts, including tracking for domain growth metrics.
- Professional Logging & Observability: Implemented a standardized logging framework that supports custom log levels (DEBUG/INFO) and provides real-time feedback on runtime, processed posts, and instance growth.
- Environment-Native Design: Complete decoupling of configuration from code. Every aspect—from API timeouts to timing intervals—is now managed via standardized environment variables (.env).
- Security-First Containerization: Provided a hardened Dockerfile that ensures the bot runs as a non-root user with minimized permissions, suitable for high-security home lab setups.
## 🧠 Design Philosophy ## 🧠 Design Philosophy
GTS-Federator follows a few key principles: GTS-Federator follows a few key principles:
@@ -148,3 +159,7 @@ services:
restart: always restart: always
``` ```
You can download the docker image on [Docker Hub](https://hub.docker.com/repository/docker/domoel/gts-federator/general) You can download the docker image on [Docker Hub](https://hub.docker.com/repository/docker/domoel/gts-federator/general)
## 📜 License & Credits
This project is released under the MIT License. This ensures that the code remains open and accessible to the community.