/link-bot

A pangora/lemmy/kbin bot that replies with recommended communities based on keywords it finds in post titles

Primary LanguageJavaScriptGNU Affero General Public License v3.0AGPL-3.0

GitHub tag (latest SemVer) GitHub issues License GitHub stars

A bot for Pangora, Lemmy, and Kbin to post recommended communities based on keywords in the post title.

About the Bot

This bot looks at post names in given communities and sees if any contain any keywords youve defined. If so it replies with a comment on that post it found it in with all of the matching communities to the keywords it found.

image

Self-Hosting Setup

You need node.js downloaded to run this

  1. Clone the repository (git clone https://github.com/PangoraWeb/link-bot.git in a terminal)
  2. Create an account in the instance you want the bot to have as its home (just make a regular user)
  3. Create a file called .env in the bot folder and give it values in this format with the data in the quotes (dont add the slashes or the part after the slashes)
LEMMY_INSTANCE="" // The instance the bot account is in
LEMMY_USERNAME="" // The bot username
LEMMY_PASSWORD="" // The bot password
  1. Change the data in config.yaml based on what you want set
  2. Open a terminal in the bot folder and run npm install to install dependendies and then node main.js to run the bot (whenever you want to start the bot again you can just do ctrl+c to interrupt the process and node main.js to start the bot)

I recommend installing something like forever.js for running it in the background on your server

If you run into issues feel free to dm me on Matrix here

Contributing

If you want to contribute to add some sort of feature feel free to make a pull request with it added

This repository has some info on how to do development in a repository and make a pull request

Credits

Icon base by Lorc under CC BY 3.0 with modifications to add a gradient