Delivers highly-customized news feeds to Discord!

• MonitoRSS (formerly Discord.RSS)
  • Get Started
    • Use Public Instance
    • Self Host
      • Customize Site Domain
      • Enable Email Notifications
      • Enable Reddit Authorizations
      • Updating
  • Migrating from v6

To use the publicly hosted instance for free, visit https://monitorss.xyz!

Docker is required to easily coordinate and run multiple services at once.

1. Install Docker Engine
2. Install Docker Compose
3. Go to the Releases page and download the docker-compose-<version>.yml file from the latest release
4. Download the .env.example file into the same directory as the compose file and rename it to .env.prod
5. Create a Discord application through Discord's developer portal if you do not already have one
6. Replace all relevant values in the .env.prod file with your own values
   1. If you have your own MongoDB instance, set BACKEND_API_MONGODB_URI to your MongoDB URI
   2. Add your email at the end of FEED_REQUESTS_FEED_REQUEST_DEFAULT_USER_AGENT for feed hosts to be able to contact you if you violate their usage policies. For example, MonitoRSS [Self-Hosted]/1.0 [email protected].
   3. Replace all instances of "BOT_TOKEN_HERE" with your Discord bot application token
   4. Replace all instances of "BOT_CLIENT_ID_HERE" with your Discord bot application ID
   5. Replace all instances of "BOT_CLIENT_SECRET_HERE" with your Discord bot application secret
   6. Set BACKEND_API_SESSION_SECRET to a random 64-character string
   7. Set BACKEND_API_SESSION_SALT to a random 16-character string
   8. Add http://localhost:8000/api/v1/discord/callback-v2 to the list of redirect URIs in your Discord application in the OAuth2 page
7. Run docker compose -f docker-compose-<version>.yml up -d (replace <version> with the version you downloaded)
   • Make sure all containers, except those with "migration" in it, are running via docker ps
   • Any containers ending in -migration do not need to be running after initial setup
   • If any containers are failing to start, troubleshoot by getting the last few logs for the container with docker logs <container_name or ID> --tail 100
8. Access the control panel via http://localhost:8000

1. Set up your domain to point to the server running the control panel on localhost
2. Update all references to http://localhost:8000 in your .env.prod to your desired domain. For example, https://mynewdomain.com.
3. Add {DOMAIN_HERE}/api/v1/discord/callback-v2 to the list of redirect URIs in your Discord application in the OAuth2 page, replacing {DOMAIN_HERE} with the value you set in step 1

While email notifications are available so that you may get notified when feeds are disabled for various reasons (permission erorrs, request errors, etc), credentials must be set to be able to send them out. Set the three variables below with your email provider's SMTP settings in your env file:

• BACKEND_API_SMTP_HOST
• BACKEND_API_SMTP_USERNAME
• BACKEND_API_SMTP_PASSWORD
• BACKEND_API_SMTP_FROM

Make sure to opt into email notifications in the control panel's user settings page afterwards.

1. Create a Reddit application at https://www.reddit.com/prefs/apps as a "web app".
2. Add {DOMAIN_HERE}/api/v1/reddit/callback to the list of redirect URIs in your Reddit application settings, replacing {DOMAIN_HERE} with your domain that you're using to access the control panel.
3. Copy the redirect URI you just added and set it as BACKEND_API_REDDIT_REDIRECT_URI in your .env.prod file.
4. Copy the Reddit application's client ID (under "web app" label) and set it as BACKEND_API_REDDIT_CLIENT_ID in your .env.prod file.
5. Copy the Reddit application's secret and set it as BACKEND_API_REDDIT_CLIENT_SECRET in your .env.prod file.
6. Generate a random 64-digit hexadecimal string and set it as BACKEND_API_ENCRYPTION_KEY_HEX in your .env.prod file. One option is to use an online generator such as this one.

To update to a new release:

1. Make a backup of your MongoDB data just in case since data migrations may occur
2. Download the new docker-compose-<version>.yml file from the Releases page
3. Stop containers with docker compose -f docker-compose-<old-version>.yml down
4. Start containers with docker compose -f docker-compose-<new-version>.yml up -d

If you've been using MonitoRSS v6 (used by the repo https://github.com/synzen/MonitoRSS-Clone), these are the instructions to migrate to v7.

It's recommended that you don't delete your v6 files until you've confirmed that all your feeds are working as expected post-migration.

1. Follow the Self Host instructions above. The clone repo is no longer used or maintained.
2. In your .env.prod file, set BACKEND_API_MONGODB_URI to your existing MongoDB URI
3. Run docker compose -f docker-compose-<version>.yml up -d
4. Access the control panel via http://localhost:8000/servers and convert all your legacy feeds to personal feeds. Legacy feed articles will not be fetched/delivered until they are converted to personal feeds.
5. After verifying that all is working as expected, you may delete your v6 files.