Skip to content

Commit

Permalink
Update README on contact info within user agent
Browse files Browse the repository at this point in the history
  • Loading branch information
synzen committed Dec 23, 2024
1 parent f315078 commit a46fa4e
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ USER_FEEDS_DISCORD_API_TOKEN="BOT_TOKEN_HERE"
DISCORD_REST_LISTENER_BOT_TOKEN="BOT_TOKEN_HERE"
DISCORD_REST_LISTENER_BOT_CLIENT_ID="BOT_CLIENT_ID_HERE"

FEED_REQUESTS_FEED_REQUEST_DEFAULT_USER_AGENT="Self-Hosted MonitoRSS/1.0"
FEED_REQUESTS_FEED_REQUEST_DEFAULT_USER_AGENT="MonitoRSS [Self-Hosted]/1.0"

# Disable feeds after 5*(2^11) minutes, or 6.25 days
FEED_REQUESTS_MAX_FAIL_ATTEMPTS=11
Expand Down
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,13 @@ Docker is required to easily coordinate and run multiple services at once.
5. Create a copy of the existing `.env.example` file and rename it to `.env.prod`
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. Replace all instances of "BOT_TOKEN_HERE" with your Discord bot application token
3. Replace all instances of "BOT_CLIENT_ID_HERE" with your Discord bot application ID
4. Replace all instances of "BOT_CLIENT_SECRET_HERE" with your Discord bot application secret
5. Set `BACKEND_API_SESSION_SECRET` to a random 64-character string
6. Set `BACKEND_API_SESSION_SALT` to a random 16-character string
7. Add `http://localhost:8000/api/v1/discord/callback-v2` to the list of redirect URIs in your Discord application in the OAuth2 page
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 up -d`
- If you run into issues with network timeouts, pass the parallel flag to only build 1 container at once: `docker compose --parallel 1 up -d`
- Any containers ending in `-migration` do not need to be running
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,8 @@ export class FeedFetcherListenerService {
await this.hostRateLimiterService.incrementUrlCount(url);

if (isRateLimited) {
logger.debug(
`Host ${url} is still rate limited, retrying later`,
logger.info(
`Host of ${url} is still rate limited, retrying later`,
);
}

Expand Down

0 comments on commit a46fa4e

Please sign in to comment.