Merge branch 'master' of https://git.klein.ruhr/matthias/gts-holmirdas
This commit is contained in:
commit
e66b0c2e82
1 changed files with 16 additions and 17 deletions
33
README.md
33
README.md
|
@ -1,9 +1,11 @@
|
|||
# GTS-HolMirDas 🚀
|
||||
|
||||
RSS-based content discovery for GoToSocial instances.
|
||||
RSS-based content discovery for **[GoToSocial](https://codeberg.org/superseriousbusiness/gotosocial)** instances.
|
||||
|
||||
Automatically discovers and federates content from RSS feeds across the Fediverse, helping small GoToSocial instances populate their federated timeline without relying on traditional relays.
|
||||
|
||||
*Inspired by the original [HolMirDas](https://github.com/aliceif/HolMirDas) for Misskey by [@aliceif](https://github.com/aliceif) ([@aliceif@mkultra.x27.one](https://mkultra.x27.one/@aliceif)), this GoToSocial adaptation extends the RSS-to-ActivityPub concept with enhanced Docker deployment and multi-instance processing.*
|
||||
|
||||
## Features
|
||||
|
||||
- 📡 **Multi-Instance RSS Discovery** - Fetches content from configurable RSS feeds across Fediverse instances
|
||||
|
@ -15,7 +17,7 @@ Automatically discovers and federates content from RSS feeds across the Fedivers
|
|||
|
||||
## How it Works
|
||||
|
||||
GTS-HolMirDas reads RSS feeds from various Fediverse instances and uses GoToSocial's search API to federate the discovered content. This approach:
|
||||
**GTS-HolMirDas** reads RSS feeds from various Fediverse instances and uses GoToSocial's search API to federate the discovered content. This approach:
|
||||
|
||||
- Maintains proper ActivityPub federation (posts remain interactive)
|
||||
- Respects rate limits and instance policies
|
||||
|
@ -26,7 +28,7 @@ GTS-HolMirDas reads RSS feeds from various Fediverse instances and uses GoToSoci
|
|||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://your-forgejo-instance.tld/user/gts-holmirdas
|
||||
git clone https://git.klein.ruhr/user/gts-holmirdas
|
||||
cd gts-holmirdas
|
||||
|
||||
# Copy configuration templates
|
||||
|
@ -38,10 +40,10 @@ nano .env # Add your GTS credentials
|
|||
nano rss_feeds.txt # Customize RSS feeds
|
||||
|
||||
# Deploy
|
||||
docker-compose up -d
|
||||
docker compose up -d
|
||||
|
||||
# Monitor
|
||||
docker-compose logs -f
|
||||
docker compose logs -f
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
@ -91,7 +93,7 @@ https://infosec.exchange/tags/selfhosting.rss
|
|||
|
||||
```
|
||||
📊 GTS-HolMirDas Run Statistics:
|
||||
⏱️ Runtime: 0:04:14
|
||||
⏱️ Runtime: 0:04:14
|
||||
📄 Total posts processed: 45
|
||||
🌐 Current known instances: 2519
|
||||
➕ New instances discovered: +3
|
||||
|
@ -110,7 +112,7 @@ https://infosec.exchange/tags/selfhosting.rss
|
|||
|
||||
### Docker Compose (Recommended)
|
||||
```bash
|
||||
docker-compose up -d
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
### Standalone Docker
|
||||
|
@ -125,7 +127,7 @@ docker run -d --env-file .env \
|
|||
|
||||
## Monitoring
|
||||
|
||||
- **Logs**: `docker-compose logs -f`
|
||||
- **Logs**: `docker compose logs -f`
|
||||
- **Health**: Optional Healthchecks.io integration
|
||||
- **Statistics**: Built-in runtime and performance metrics
|
||||
- **Resource Usage**: Docker stats or container monitoring tools
|
||||
|
@ -134,20 +136,17 @@ docker run -d --env-file .env \
|
|||
|
||||
### Common Issues
|
||||
|
||||
**No posts processed**: Check access token permissions and RSS feed URLs
|
||||
|
||||
**Rate limiting errors**: Increase `DELAY_BETWEEN_REQUESTS` or reduce feed count
|
||||
|
||||
**High memory usage**: Reduce `MAX_POSTS_PER_RUN` or feed frequency
|
||||
|
||||
**Container won't start**: Verify `.env` file format and required variables
|
||||
- **No posts processed**: Check access token permissions and RSS feed URLs
|
||||
- **Rate limiting errors**: Increase `DELAY_BETWEEN_REQUESTS` or reduce feed count
|
||||
- **High memory usage**: Reduce `MAX_POSTS_PER_RUN` or feed frequency
|
||||
- **Container won't start**: Verify `.env` file format and required variables
|
||||
|
||||
### Debug Mode
|
||||
|
||||
```bash
|
||||
# Enable debug logging
|
||||
echo "LOG_LEVEL=DEBUG" >> .env
|
||||
docker-compose restart gts-holmirdas
|
||||
docker compose restart gts-holmirdas
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
@ -170,6 +169,6 @@ MIT License - see LICENSE file for details.
|
|||
|
||||
## Acknowledgments
|
||||
|
||||
- Inspired by the [HolMirDas](https://github.com/aliceif/HolMirDas) concept
|
||||
- Inspired by [HolMirDas](https://github.com/aliceif/HolMirDas) by [@aliceif](https://github.com/aliceif) ([@aliceif@mkultra.x27.one](https://mkultra.x27.one/@aliceif)) - the original RSS-to-ActivityPub concept
|
||||
- Built for the GoToSocial community
|
||||
- RSS-to-ActivityPub approach inspired by Fediverse discovery challenges
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue