-
Notifications
You must be signed in to change notification settings - Fork 89
add documentaion for apache2 bouncer #726
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
39b88b6
add documentaion for apache2 bouncer
sabban ad325a2
typo fix
sabban f4a3e27
typo
sabban b52db0c
typo
sabban ea492a3
this will have to be merged after adding apache bouncer to final release
sabban 1dad4cf
typos
sabban e63a0b3
Merge branch 'main' into packaging/apache2
sabban 115cf28
change fallback default
sabban 96b2018
Merge branch 'packaging/apache2' of github.com:crowdsecurity/crowdsec…
sabban cb00d9f
typos thx @sbl
sabban f2c72f2
configuration files
sabban File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -47,27 +47,40 @@ At the back, this component uses `mod_proxy`, `mod_ssl` for requests to LAPI, an | |
|
|
||
| :::warning | ||
|
|
||
| There is not yet publicly available packages or this Remediation Component. | ||
| Packages are only available for debian like systems and | ||
|
|
||
| We are providing ways to build your own while we're working on packaging. | ||
| The module can be built and installed on other platform as well. | ||
|
|
||
| Please keep in mind that this bouncer only supports live mode. | ||
|
|
||
| ::: | ||
|
|
||
| Clone or download directly [from our GitHub repository](https://github.com/crowdsecurity/cs-apache2-bouncer). | ||
|
||
|
|
||
|
|
||
| <Tabs | ||
| defaultValue="nginx_debian" | ||
| defaultValue="apache_debian" | ||
| values={[ | ||
| { label: 'Debian/Ubuntu', value: 'nginx_debian' ,}, | ||
| { label: 'Debian/Ubuntu', value: 'apache_debian' ,}, | ||
| { label: 'Others (build from source)', value: 'others' ,}, | ||
| ] | ||
| }> | ||
| <TabItem value="nginx_debian"> | ||
| <TabItem value="apache_debian"> | ||
|
|
||
| ### Repository configuration | ||
|
|
||
| :::warning | ||
| Please note that the repository for this package is not the same as the one holding CrowdSec's binary packages, | ||
| ::: | ||
|
|
||
| ```bash | ||
| curl -s https://packagecloud.io/install/repositories/crowdsec/crowdsec-apache/script.deb.sh | sudo bash | ||
| ``` | ||
|
|
||
| ### Installation | ||
|
|
||
| ```bash | ||
| dpkg-buildpackage -us -uc | ||
| sudo dpkg -i ../crowdsec-apache2-bouncer_1.0.0_amd64.deb | ||
| sudo apt-get install crowdsec-apache2-bouncer | ||
| ``` | ||
|
|
||
| </TabItem> | ||
|
|
@@ -87,10 +100,6 @@ sudo mkdir -p /etc/crowdsec/bouncers/ | |
| sudo cp ./config/crowdsec-apache2-bouncer.conf /etc/crowdsec/bouncers/ | ||
| ``` | ||
|
|
||
| </TabItem> | ||
|
|
||
| </Tabs> | ||
|
|
||
| ### Initial Configuration | ||
blotus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Enable the mod_crowdsec module: | ||
|
|
@@ -110,7 +119,6 @@ Remediation Component config's is located in `/etc/crowdsec/bouncers/crowdsec-ap | |
| ```bash | ||
| ## Replace the API key with the newly generated one [1] | ||
| CrowdsecAPIKey this_is_a_bad_password | ||
| ... | ||
| ``` | ||
|
|
||
| :::info | ||
|
|
@@ -121,6 +129,10 @@ If needed, edit `CrowdsecURL` (and other parameters) | |
| sudo systemctl restart apache2 | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
|
|
||
| ## Configuration directives | ||
|
|
||
| ### `Crowdsec` | ||
|
|
@@ -138,9 +150,9 @@ Behavior can be overriden in any location. | |
| > fail|block|allow | ||
|
|
||
| How to respond if the Crowdsec API is not available: | ||
| - `fail` (**default**) returns a 500 Internal Server Error. | ||
| - `fail` returns a 500 Internal Server Error. | ||
| - `block` returns a 302 Redirect (or 429 Too Many Requests if CrowdsecLocation is unset). | ||
| - `allow` will allow the request through. | ||
| - `allow` (**default**) will allow the request through. | ||
|
|
||
| ### `CrowdsecBlockedHTTPCode` | ||
|
|
||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Additional and or sentence is not finished.