feat: basic auth for all api endpoints #22
Merged
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.
Description
Allows users to secure all endpoints on the API port using Basic Auth. See also: DarkAtra/v-rising-discord-bot#105.
Warning
Enabling basic auth will secure all endpoints on the API port, including the default ones from Stunlock and endpoints that other plugins might've added.
How to use it
After installing the bot companion and starting the v rising server once, you should find a file
v-rising-discord-bot-companion.cfg
inBepInEx\config
with the following content:To enable basic auth for all api endpoints (including the default endpoints, such as
/metrics
) just put the desired username and password afterBasicAuthUsers =
. For example, the following config would configure a usermyuser
with1234
as its password:You can also add more than one user like this: