Update README to mirror easier crowdsec api key setup #964
Conversation
This file contains 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
|
PR build pushed to |
thespad
reviewed
Oct 7, 2024
paul-arthurthiery
force-pushed
the
swag-crowdsec-api-key-readme-update
branch
from
94c891d to
78c1192
Compare
|
PR build pushed to |
thespad
approved these changes
Oct 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
Update README to reflect changes following this PR.
Crowdsec API keys can now be generated outside of crowdsec and fed to both
crowdsecandswag-crowdsecvia environement variables, removing a step and simplifying the setup.Benefits of this PR and context:
Guides users to pass an arbitrary string as the crowdsec-swag API key to both the crowdsec and swag images, thus removing the need to generate the API key from crowdsec.
How Has This Been Tested?
Crowdsec-side update should already have been tested in the previously mentioned PR.
I created a new docker compose file, added the
CROWDSEC_API_KEYenv variable to one, andBOUNCER_KEY_swagto the other. Built and ran the containers and both ran fine, correctly reporting the bouncer had been registered.Ran on DSM 7
Source / References:
crowdsecurity/crowdsec#1341
https://www.linuxserver.io/blog/blocking-malicious-connections-with-crowdsec-and-swag