Skip to content

Commit 83ce4b3

Browse files
authored
Merge pull request #726 from crowdsecurity/packaging/apache2
add documentaion for apache2 bouncer
2 parents 0c58e83 + f2c72f2 commit 83ce4b3

File tree

1 file changed

+30
-17
lines changed

1 file changed

+30
-17
lines changed

crowdsec-docs/unversioned/bouncers/apache.mdx

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -47,33 +47,45 @@ At the back, this component uses `mod_proxy`, `mod_ssl` for requests to LAPI, an
4747

4848
:::warning
4949

50-
There is not yet publicly available packages or this Remediation Component.
50+
Packages are only available for debian and ubuntu systems.
5151

52-
We are providing ways to build your own while we're working on packaging.
52+
The module can be built and installed on other platform as well.
5353

54-
:::
55-
56-
Clone or download directly [from our GitHub repository](https://github.com/crowdsecurity/cs-apache2-bouncer).
54+
Please keep in mind that this bouncer only supports live mode.
5755

56+
:::
5857

5958
<Tabs
60-
defaultValue="nginx_debian"
59+
defaultValue="apache_debian"
6160
values={[
62-
{ label: 'Debian/Ubuntu', value: 'nginx_debian' ,},
61+
{ label: 'Debian/Ubuntu', value: 'apache_debian' ,},
6362
{ label: 'Others (build from source)', value: 'others' ,},
6463
]
6564
}>
66-
<TabItem value="nginx_debian">
65+
<TabItem value="apache_debian">
66+
67+
### Repository configuration
68+
69+
:::warning
70+
Please note that the repository for this package is not the same as the one holding CrowdSec's binary packages,
71+
:::
72+
73+
```bash
74+
curl -s https://packagecloud.io/install/repositories/crowdsec/crowdsec-apache/script.deb.sh | sudo bash
75+
```
76+
77+
### Installation
6778

6879
```bash
69-
dpkg-buildpackage -us -uc
70-
sudo dpkg -i ../crowdsec-apache2-bouncer_1.0.0_amd64.deb
80+
sudo apt-get install crowdsec-apache2-bouncer
7181
```
7282

7383
</TabItem>
7484

7585
<TabItem value="others">
7686

87+
Clone or download directly [from our GitHub repository](https://github.com/crowdsecurity/cs-apache2-bouncer).
88+
7789
```bash
7890
aclocal
7991
autoconf
@@ -87,10 +99,6 @@ sudo mkdir -p /etc/crowdsec/bouncers/
8799
sudo cp ./config/crowdsec-apache2-bouncer.conf /etc/crowdsec/bouncers/
88100
```
89101

90-
</TabItem>
91-
92-
</Tabs>
93-
94102
### Initial Configuration
95103

96104
Enable the mod_crowdsec module:
@@ -110,7 +118,6 @@ Remediation Component config's is located in `/etc/crowdsec/bouncers/crowdsec-ap
110118
```bash
111119
## Replace the API key with the newly generated one [1]
112120
CrowdsecAPIKey this_is_a_bad_password
113-
...
114121
```
115122

116123
:::info
@@ -121,8 +128,14 @@ If needed, edit `CrowdsecURL` (and other parameters)
121128
sudo systemctl restart apache2
122129
```
123130

131+
</TabItem>
132+
</Tabs>
133+
134+
124135
## Configuration directives
125136

137+
The configuration file is stored in `/etc/crowdsec/bouncers/crowdsec-apache2-bouncer.conf` by default.
138+
126139
### `Crowdsec`
127140

128141
> on|off
@@ -138,9 +151,9 @@ Behavior can be overriden in any location.
138151
> fail|block|allow
139152
140153
How to respond if the Crowdsec API is not available:
141-
- `fail` (**default**) returns a 500 Internal Server Error.
154+
- `fail` returns a 500 Internal Server Error.
142155
- `block` returns a 302 Redirect (or 429 Too Many Requests if CrowdsecLocation is unset).
143-
- `allow` will allow the request through.
156+
- `allow` (**default**) will allow the request through.
144157

145158
### `CrowdsecBlockedHTTPCode`
146159

0 commit comments

Comments
 (0)