An open API service indexing awesome lists of open source software.

https://github.com/sxwebdev/torrentscout

A Telegram bot for searching torrents on rutor.info with a user-friendly interface and request caching.
https://github.com/sxwebdev/torrentscout

go torrent

Last synced: about 1 month ago
JSON representation

A Telegram bot for searching torrents on rutor.info with a user-friendly interface and request caching.

Awesome Lists containing this project

README

          

# Torrent Scout

A Telegram bot for searching torrents on rutor.info with a user-friendly interface and request caching.

## Features

- 🔍 **Fast torrent search** by title, year, quality, and releaser
- 📄 **Result pagination** - 5 results per page for convenient browsing
- â„šī¸ **Detailed information** about torrents with preview images
- 💾 **Download .torrent files** directly in Telegram
- ⚡ **Request caching** - quick access to frequently requested data

## Quick Start

### Using Pre-built Docker Image

Pull the image from GitHub Container Registry:

```bash
docker pull ghcr.io/sxwebdev/torrentscout:latest
```

Create a `config.yaml` file with your bot token:

```yaml
telegram_bot_token: "YOUR_BOT_TOKEN_HERE"
```

Run the container:

```bash
docker run -d --name torrentscout -v $(pwd)/config.yaml:/app/config.yaml ghcr.io/sxwebdev/torrentscout:latest start -c ./config.yaml
```

### Using Docker Compose

Create a `docker-compose.yml`:

```yaml
services:
torrentscout:
image: ghcr.io/sxwebdev/torrentscout:latest
command: ["start", "-c", "./config.yaml"]
container_name: torrentscout
restart: unless-stopped
volumes:
- ./config.yaml:/app/config.yaml
```

Run:

```bash
docker-compose up -d
```

## Bot Usage

1. Start a conversation with the bot using `/start` or `/help` command
2. Enter a search query, for example: `batman 2022 1080p`
3. Use commands to interact with results:
- `/info_ID` - get detailed information about a torrent
- `/download_ID` - download the .torrent file
4. Navigate through results using pagination buttons

## License

MIT License