Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/topi314/reddit-discord-bot
A Discord Bot to deliver Reddit posts into your server
https://github.com/topi314/reddit-discord-bot
bot discord discord-bot reddit
Last synced: about 2 months ago
JSON representation
A Discord Bot to deliver Reddit posts into your server
- Host: GitHub
- URL: https://github.com/topi314/reddit-discord-bot
- Owner: topi314
- License: apache-2.0
- Created: 2021-05-25T00:21:57.000Z (over 3 years ago)
- Default Branch: v2
- Last Pushed: 2024-10-04T20:45:49.000Z (3 months ago)
- Last Synced: 2024-10-29T09:14:55.186Z (about 2 months ago)
- Topics: bot, discord, discord-bot, reddit
- Language: Go
- Homepage:
- Size: 503 KB
- Stars: 26
- Watchers: 6
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Reddit-Discord-Bot
Simple webhook based bot delivering Reddit posts into your Discord Server
The bot does not require any permissions and can't do anything in your Discord. With that it's safe to use!
Table of Contents
- [Public Bot](#public-bot)
- [Usage](#usage)
- [Add Subreddit](#add-subreddit)
- [Remove Subreddit](#remove-subreddit)
- [List Subreddits](#list-subreddits)
- [Self-hosted](#self-hosted)
- [Binary](#binary)
- [Docker-Compose](#docker-compose)
- [Help](#help)
- [License](#license)
- [Contributing](#contributing)
- [Contact](#contact)
## Public Bot
Invite the bot [here](https://discord.com/oauth2/authorize?client_id=846396249241288796&scope=applications.commands)
## Usage
### Add Subreddit
To add a new subreddit run
```bash
/reddit add (new/hot/top/rising) (embed/text/link) (role) (proxy)
```
and click the returned link
select the server & channel in the discord popup & hit okay that's all!
### Update Subreddit
To update a subreddit run
```bash
/reddit update (new/hot/top/rising) (embed/text/link) (role) (proxy)
```
### Remove Subreddit
To remove a subreddit subscriptions run
```bash
/reddit remove
```
and remove the bot under `Server Settings > Integrations` or just delete the webhook under `Channel Settings > Integrations > Webhooks`
### List Subreddits
To list all subreddit subscriptions run
```bash
/reddit list (channel)
```
## Self-hosted
Reddit-Discord-Bot is now super easy to self-host. You can either use the docker image or build a binary yourself.
Before you can run the bot you need to create a config file. You can find an example [here](/config.example.yml)
You also need a discord bot token, which you can get from [here](https://discord.com/developers/applications).
Lastly you need to create a reddit app which can be done [here](https://www.reddit.com/prefs/apps/).
The bot requires a database, which can either be `SQLite` or `PostgreSQL`. Just select the one you want to use in the config file.
### Binary
Prerequisites:
- [Go](https://golang.org/doc/install)
- [Git](https://git-scm.com/downloads)
- [PostgreSQL](https://www.postgresql.org/download/) (optional)
```bash
$ git clone [email protected]:topi314/Reddit-Discord-Bot.git
$ cd Reddit-Discord-Bot
$ go build -o reddit-discord-bot github.com/topi314/reddit-discord-bot/v2
```
You can now run the bot with
```bash
$ ./reddit-discord-bot -config config.yml
```
### Docker-Compose
Docker-Compose is the easiest way to run the bot and is also the way I recommend.
#### Prerequisites
- [Docker](https://docs.docker.com/get-docker/)
- [Docker-Compose](https://docs.docker.com/compose/install/)
- [PostgreSQL](https://www.postgresql.org/download/) (optional)
#### Setup
Create a `docker-compose.yml` file and paste the following into it
```bash
version: "3.8"
services:
reddit-bot:
image: ghcr.io/topi314/reddit-discord-bot:v2
container_name: reddit-bot
restart: unless-stopped
volumes:
- ./config.yml:/var/lib/reddit-discord-bot/config.yml
- ./database.db:/var/lib/reddit-discord-bot/database.db
```
#### Configuration
Create a `config.yml` file and paste [this](/config.example.yml) into it.
Fill in the required fields, and you are good to go!
Also create a `database.db` file if you want to use SQLite.
#### Running
You can now run the bot with
```bash
$ docker-compose up -d
```
#### Updating
To update the bot just run
```bash
$ docker-compose pull
$ docker-compose up -d
```
#### Stopping
To stop the bot run
```bash
$ docker-compose down
```
# Help
If you encounter any problems feel free to open an issue or reach out to me(`toπ#3141`) via discord [here](https://discord.gg/RKM92xXu4Y)
# License
Reddit-Discord-Bot is licensed under the [Apache License 2.0](LICENSE).
# Contributing
Contributions are always welcome! Just open a pull request or discussion and I will take a look at it.
## Contact
- [Discord](https://discord.gg/sD3ABd5)
- [Twitter](https://twitter.com/topi314)
- [Email](mailto:[email protected])
- [Matrix](https://matrix.to/#/@topi:topi.wtf)