Delivers highly-customized news feeds to Discord!
To use the publicly hosted instance for free, visit https://monitorss.xyz!
Docker is required to easily coordinate and run multiple services at once.
Note
General knowledge of how Docker, Docker volumes, and docker-compose works is highly recommended to avoid accidental data loss
- Install Docker Engine
- Install Docker Compose
- Clone this repo's
main
(the default) branch -git clone https://github.com/synzen/MonitoRSS.git
- Create a copy of the existing
.env.example
file and rename it to.env.prod
- Create a Discord application through Discord's developer portal if you do not already have one
- Replace all relevant values
- If you have your own MongoDB instance, set
BACKEND_API_MONGODB_URI
to your MongoDB URI - Replace all instances of "BOT_TOKEN_HERE" with your Discord bot application token
- Replace all instances of "BOT_CLIENT_ID_HERE" with your Discord bot application ID
- Set
BACKEND_API_SESSION_SECRET
to a random 64-character string - Set
BACKEND_API_SESSION_SALT
to a random 16-character string - Add
http:https://localhost:8000/api/v1/discord/callback-v2
to the list of redirect URIs in your Discord application in the OAuth2 page
- If you have your own MongoDB instance, set
- Run
docker-compose up -d
- Access the control panel via http:https://localhost:8000
- Set up your domain to point to the server running the control panel on localhost
- Update all references to
http:https://localhost:8000
in your.env.prod
to your desired domain. For example,https://mynewdomain.com
. - Add
{DOMAIN_HERE}/api/v1/discord/callback-v2
to the list of redirect URIs in your Discord application in the OAuth2 page, replacingDOMAIN_HERE
with the value you set in step 1
- Pull the latest files from the main branch
- Rebuild containers with
docker-compose up -d --build
If you've been using MonitoRSS v6 (used by the repo https://github.com/synzen/MonitoRSS-Clone), then these are instructions to migrate off of that repo to use the latest changes.
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.
- Follow the instructions above to self host. Be sure to clone this repo - the clone repo is no longer used or maintained.
- In your
.env.prod
file, setBACKEND_API_MONGODB_URI
to your MongoDB URI - Run
docker-compose up -d --build
- Access the control panel via http:https://localhost:8000 and convert all your legacy feeds to personal feeds. Legacy feed articles will not be fetched/delivered until they are converted to personal feeds.