Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hirbodbehnam/redditdownloaderbot
A reddit downloader telegram bot
https://github.com/hirbodbehnam/redditdownloaderbot
reddit reddit-downloader reddit-downloader-bot telegram-bot
Last synced: 1 day ago
JSON representation
A reddit downloader telegram bot
- Host: GitHub
- URL: https://github.com/hirbodbehnam/redditdownloaderbot
- Owner: HirbodBehnam
- License: mit
- Created: 2020-03-29T04:53:32.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-22T15:20:04.000Z (about 1 month ago)
- Last Synced: 2025-01-13T15:12:34.611Z (8 days ago)
- Topics: reddit, reddit-downloader, reddit-downloader-bot, telegram-bot
- Language: Go
- Homepage:
- Size: 273 KB
- Stars: 88
- Watchers: 6
- Forks: 23
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Reddit Downloader Bot
A Telegram bot for downloading Reddit posts.
Table of Contents
=================
* [What this bot can do](#what-this-bot-can-do)
* [What this bot cannot do](#what-this-bot-cannot-do)
* [List of non x.redd.it hosts from which this bot
*can* download](#list-of-non-xreddit-hosts-from-which-this-bot-can-download)
* [Setup](#setup)
* [Build](#build)
* [Obtain Reddit Token](#obtain-reddit-token)
* [Obtain Telegram Token](#obtain-telegram-token)
* [Run](#run)
* [Optional Settings](#optional-settings)
* [Allowed Users](#allowed-users)
* [Disable NSFW Content](#disable-nsfw-content)
# What this bot can do
* Send Reddit posts and comments as text on Telegram
* Send images and image galleries hosted on `i.redd.it`
* Send videos hosted on `v.redd.it`
* Convert videos to audio only
* Send GIFs hosted on Reddit
* Let users choose the quality of images and videos
* Limit the users who can use it
# What this bot cannot do
* Send polls
* Send deleted posts
* Upload files larger than 50 MB
* Send text posts with over 4,096 characters or complex markdown (for example, tables)
* Download images or videos that are not hosted on `x.redd.it` (for example, YouTube videos)
## List of non `x.redd.it` hosts from which this bot *can* download
1. Imgur
2. Gfycat
3. Streamable
# Setup
## Build
First, install [FFmpeg](https://www.ffmpeg.org). On Debian or Ubuntu, simply run `apt install ffmpeg`. Then, clone and
build the project using the following steps.
```bash
git clone https://github.com/HirbodBehnam/RedditDownloaderBot
cd RedditDownloaderBot
go build ./cmd/RedditDownloaderBot/
```
## Obtain Reddit Token
To use the bot, you will need Reddit and Telegram tokens. Start by creating a Reddit application. Go
to https://www.reddit.com/prefs/apps and click on “are you a developer? create an app...” Choose a name, select `script`
as the type of application, input something in the redirect URI field, and click on “create app.”
You will be given two tokens: a client ID and a client secret—as shown in the image below.
## Obtain Telegram Token
Interact with [BotFather](https://t.me/BotFather) to create a bot and obtain its token. Additionally, you can use
this [guide](https://core.telegram.org/bots/tutorial#obtain-your-bot-token).
Your token will look something like this:
```bash
4839574812:AAFD39kkdpWt3ywyRZergyOLMaJhac60qc
```
## Run
Now that you have the necessary tokens, edit the docker-compose.yml file and set the environment variables as such:
```bash
export CLIENT_ID=p-jcoLKBynTLew
export CLIENT_SECRET=gko_LXELoV07ZBNUXrvWZfzE3aI
export BOT_TOKEN=1234567:4TT8bAc8GHUspu3ERYn-KGcvsvGB9u_n4ddy
```
You can run the bot using docker-compose. In case you don’t have docker-compose installed, follow the steps below.
```bash
sudo curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-linux-x86_64" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
```
Lastly, run `docker-compose up --build` inside the RedditDownloaderBot directory to build and run the bot.
# Optional Settings
## Allowed Users
You can configure the bot to allow access to only a group of users. This is useful for deploying private bots. To do so,
you need to create a whitelist that consists of Telegram user IDs. You can obtain user IDs
using [GetIDs Bot](https://t.me/getidsbot). Next, create the environment variable `ALLOWED_USERS` and set its value to
user IDs, separated by a comma.
```bash
export ALLOWED_USERS=1,2,3
```
## Disable NSFW Content
You can keep the bot from downloading NSFW posts by setting the following environment variable:
```bash
export DENY_NSFW=true
```
## Disable Post Link
The post link is included in the caption by default. You can disable it by setting the following environment variable:
```bash
export DISABLE_LINK_IN_CAPTION=true
```
## Imgur Proxy
The proxy to download the Imgur media through it. Imgur sometimes blocks some IP addresses like Hetzner for example.
It's interesting because even with authorization it does not work. Even accessing through the browser it does not work
either. So, someone might use a proxy (like Cloudflare Warp) to bypass this restriction.
```bash
export IMGUR_PROXY=http://127.0.0.1:10809
```