Skip to content
This repository has been archived by the owner on Dec 20, 2023. It is now read-only.

Latest commit

 

History

History
73 lines (38 loc) · 3.52 KB

README.md

File metadata and controls

73 lines (38 loc) · 3.52 KB
Raw

Important

This repo is no longer used for hosting MonitoRSS. Please visit https://github.com/synzen/MonitoRSS instead to either set up MonitoRSS, or to migrate off of this repo.

MonitoRSS Clone (Formerly Discord.RSS)

This repository is only for users who will clone MonitoRSS (formerly known as Discord.RSS) files directly.

The main repository is located at https://github.com/synzen/MonitoRSS, and the web repository at https://github.com/synzen/MonitoRSS-Web.

Driven by the lack of comprehensive RSS bots available, I have decided to try my hand at creating one of my own. Designed with as much customization as possible for both users and bot hosters, while also (or should be) easy to understand.

All documentation can be found at https://docs.monitorss.xyz/.

Publicly Hosted Instance

Don't want to bother hosting your own instance? Use the publicly hosted one!

https://discordapp.com/oauth2/authorize?client_id=268478587651358721&scope=bot&permissions=19456

Web Interface

MonitoRSS also comes with a web interface! To run the web interface, see the documentation.

UI Screenshot

Deploy to Heroku

You can deploy the bot in a simple way to Heroku using the button below. Click here for detailed instructions - you must have MongoDB hosted with its URI ready to also insert into DRSS_DATABASE_URI environment variable.

Deploy

If you want to deploy manually without the button, you can follow this guide instead.

Hosting on Glitch

MonitoRSS requires node.js v12.16. As of 23 May 2020, Glitch does not install v12.16 automatically, and must be manually installed. For MonitoRSS to work on Glitch, follow these steps.

Setup

  1. Click the remix button and wait for the setup to complete. Be sure to make your project private to protect your configs.

Remix on Glitch

  1. Open terminal and run the following command. Adding the git remote will let you pull updates from the clone repo.
git remote add origin https://github.com/synzen/MonitoRSS-Clone.git && npm install --no-save [email protected]
  1. Set up your configs. You can use MongoDB Atlas for the MongoDB database and Redis Labs for the Redis database.
  2. Use a tool like Uptime Robot to prevent the bot from going offline.

If you want the web interface, you will need to follow the web configuration and add the following in a file named .env:

image

The web port for Glitch is 3000.

Updating

See https://docs.monitorss.xyz/setting-up/staying-updated. Since using npm install will remove the required node v12.16 automatically, you must install it again after updating:

git reset --hard origin/master && npm install && npm install --no-save [email protected]