Update configuration instructions to center JSON format #113
+370
−167
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Comment on lines
+96
to
+117
| | `rate.ip.count` | 500 | number | Allowed number of requests per IP within window | | ||
| | `rate.ip.window` | 5 | number | IP rate limit window, in seconds | | ||
| | `rate.global.count` | 250 | number | Allowed number of requests globally within window | | ||
| | `rate.global.window` | 5 | number | Global rate limit window, in seconds | | ||
| | `rate.error.count` | 10 | number | Number of allowed errors per user within window | | ||
| | `rate.error.window` | 5 | number | User error rate limit window, in seconds | | ||
| | `rate.routes.guild.count` | 5 | number | Allowed number of /guild\* requests per user within window | | ||
| | `rate.routes.guild.window` | 5 | number | User /guild\* rate limit window, in seconds | | ||
| | `rate.routes.webhook.count` | 10 | number | Allowed number of /webhooks\* requests per user within window | | ||
| | `rate.routes.webhook.window` | 5 | number | User /webhooks\* rate limit window, in seconds | | ||
| | `rate.routes.channel.count` | 10 | number | Allowed number of /channel\* requests per user within window | | ||
| | `rate.routes.channel.window` | 5 | number | User /channel\* rate limit window, in seconds | | ||
| | `rate.routes.auth.login.count` | 5 | number | Allowed number of IP /login requests within window | | ||
| | `rate.routes.auth.login.window` | 60 | number | IP /login rate limit window, in seconds | | ||
| | `rate.routes.auth.register.count` | 2 | number | Allowed number of IP /register requests within window | | ||
| | `rate.routes.auth.register.window` | 43200 | number | IP /register rate limit window, in seconds | | ||
| | `absoluteRate.register.limit` | 25 | number | Absolute number of registrations instance-wide per window | | ||
| | `absoluteRate.register.window` | 3600000 | number | Global /register rate limit window, in milliseconds | | ||
| | `absoluteRate.register.enabled` | true | boolean | Whether absolute register rate limits are enabled | | ||
| | `absoluteRate.sendMessage.limit` | 200 | number | Absolute number of messages instance-wide per window | | ||
| | `absoluteRate.sendMessage.window` | 60000 | number | Global sendMessage window, in milliseconds | | ||
| | `absoluteRate.sendMessage.enabled` | true | boolean | Whether absolute message sending rate limits are enabled | |
Member
There was a problem hiding this comment.
Just a note for future sake, not a blocker: I would probably rework this into a couple more compact sections (ie generalising the definition of "window" and "limit" for most of them, and explaining what absoluteRate is)
| "general": { | ||
| "instanceDescription": "I'm in space!", | ||
| "instanceName": "A Spacebar Instance", | ||
| "serverName": "spacebar.example.net" |
Member
There was a problem hiding this comment.
This could just be example.net fwiw, if you wanted to do it that way :P
TheArcaneBrony
approved these changes
Feb 13, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Do not mention the DB
configtable. Instead explain how the JSON configuration file looks and how to tell spacebar where to find it