https://github.com/pangoraweb/link-bot
A pangora/lemmy/kbin bot that replies with recommended communities based on keywords it finds in post titles
https://github.com/pangoraweb/link-bot
bot bots fediverse fediverse-bot javascript kbin lemmy lemmy-bot pangora pangora-bot sublinks sublinks-bot
Last synced: 11 months ago
JSON representation
A pangora/lemmy/kbin bot that replies with recommended communities based on keywords it finds in post titles
- Host: GitHub
- URL: https://github.com/pangoraweb/link-bot
- Owner: PangoraWeb
- License: agpl-3.0
- Created: 2023-11-14T00:10:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-15T02:28:14.000Z (over 2 years ago)
- Last Synced: 2025-01-22T04:42:46.812Z (over 1 year ago)
- Topics: bot, bots, fediverse, fediverse-bot, javascript, kbin, lemmy, lemmy-bot, pangora, pangora-bot, sublinks, sublinks-bot
- Language: JavaScript
- Homepage: https://matrix.to/#/#pangora:matrix.org
- Size: 49.8 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/PippitWeb/pippit/issues)
[](LICENSE)
Link Bot
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.
## 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
```
4. Change the data in config.yaml based on what you want set
5. 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](https://www.npmjs.com/package/forever) for running it in the background on your server
If you run into issues feel free to dm me on Matrix [here](https://matrix.to/#/@ategon:matrix.org)
## Contributing
If you want to contribute to add some sort of feature feel free to make a pull request with it added
[This repository](https://github.com/firstcontributions/first-contributions) has some info on how to do development in a repository and make a pull request
## Credits
Icon base by [Lorc]([https://delapouite.com/](https://lorcblog.blogspot.com)) under [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) with modifications to add a gradient