Skip to content

Commit 8f3762b

Browse files
Merge branch 'main' into improve_community_blocklist
2 parents 0687ce1 + 445bbd3 commit 8f3762b

52 files changed

Lines changed: 3456 additions & 2554 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/build_doc.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ jobs:
1010
build:
1111
runs-on: ubuntu-latest
1212
steps:
13-
- uses: actions/checkout@v3
14-
- name: Use Node.js 18.x
15-
uses: actions/setup-node@v3
13+
- uses: actions/checkout@v4
14+
- name: Use Node.js 20.x
15+
uses: actions/setup-node@v4
1616
with:
17-
node-version: 18.x
17+
node-version: 20.x
1818
- name: Install dependencies
1919
run: npm ci
2020
working-directory: ./crowdsec-docs/

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
.vscode
1+
.vscode
2+
node_modules

amplify.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
version: 1
2+
frontend:
3+
phases:
4+
build:
5+
commands:
6+
- nvm use 20
7+
- cd crowdsec-docs
8+
- npm install
9+
- npm run build
10+
artifacts:
11+
baseDirectory: crowdsec-docs/build
12+
files:
13+
- "**/*"
14+
cache:
15+
paths:
16+
- crowdsec-docs/node_modules/**/*

crowdsec-docs/docs/appsec/installation.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,13 +102,13 @@ tcp 0 0 127.0.0.1:7422 0.0.0.0:* LISTEN
102102

103103
## Configuration : Remediation component
104104

105-
Configuring the AppSec component [accross remediation components](/appsec/installation#pre-requisites) can vary:
105+
Configuring the AppSec component [accross remediation components](appsec/installation.md#pre-requisites) can vary:
106106

107-
| Name | Minimum Version | Public Doc |
108-
| --------- | --------------- | ----------- |
109-
| nginx | 1.0.6rc | [Public Doc](/u/bouncers/nginx#application-security-component-configuration) |
110-
| openresty | 1.0.1rc | [Public Doc](/u/bouncers/openresty#application-security-component-configuration) |
111-
| traefik | 1.2.0 | [Public Doc](https://github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin/blob/main/examples/appsec-enabled/README.md) |
107+
| Name | Minimum Version | Public Doc |
108+
| --------- | --------------- | ------------------------------------------------------------------------------------------------------------------------- |
109+
| nginx | 1.0.6rc | [Public Doc](/u/bouncers/nginx#application-security-component-configuration) |
110+
| openresty | 1.0.1rc | [Public Doc](/u/bouncers/openresty#application-security-component-configuration) |
111+
| traefik | 1.2.0 | [Public Doc](https://github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin/blob/main/examples/appsec-enabled/README.md) |
112112

113113

114114
:::info
@@ -138,4 +138,4 @@ And if we look at it in a browser, the user is presented with the HTML page emit
138138
## Et Voila !
139139

140140
Your application should now be protected from the most common exploitation attempts.
141-
[If you have already enrolled your instance in the console](/docs/next/console/enrollment), you will see alerts appearing there too!
141+
[If you have already enrolled your instance in the console](/u/getting_started/post_installation/console#engines-page), you will see alerts appearing there too!

crowdsec-docs/docs/appsec/intro.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ This component capitalizes on existing remediation functions in web servers (suc
2424
![appsec-global](/img/appsec-global.svg)
2525

2626
1. The Web Server receives the HTTP request
27-
2. The HTTP Request is intercepted and passed to the CrowdSec Security Engine via [the HTTP API](/appsec/protocol.md)
27+
2. The HTTP Request is intercepted and passed to the CrowdSec Security Engine via [the HTTP API](appsec/protocol.md)
2828
3. The Security Engine answers to the Web Server once the Appsec inband rules have been processed.
29-
4. Based on the [Security Engine answer](/appsec/protocol#response-code), the Web Server either blocks the HTTP Request or processes it as usual
29+
4. Based on the [Security Engine answer](appsec/protocol.md#response-code), the Web Server either blocks the HTTP Request or processes it as usual
3030

3131
## Inband Rules and Out-Of-Band Rules
3232

@@ -70,7 +70,8 @@ You can follow our quick start guides depending on your web server:
7070
Or consider learning more about the AppSec capabilities:
7171

7272
- **Rules**: [How to read, write and debug rules](/appsec/rules_syntax.md)
73-
- **Scenarios**: [How to create scenarios that leverage the AppSec Component events](#TODO)
73+
<!-- TODO -->
74+
- **Scenarios**: How to create scenarios that leverage the AppSec Component events
7475
- **Hooks**: [For advanced use let's talk about possible Hooks](/appsec/hooks.md)
7576
- **Troubleshoot**: [How to troubleshoot the behavior of the AppSec Component](/appsec/troubleshooting.md)
7677
- **AppSec Protocol**: [if you're maintaining or creating a remedation component and want to add the AppSec capabilities](/appsec/protocol.md)

crowdsec-docs/docs/appsec/quickstart/nginxopenresty.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Steps:
8181

8282
The two important directives in this configuration file are:
8383

84-
- `appsec_config` is the name of the [*AppSec Configuration*](/appsec/configuration.md#appsec-configuration) that was included in the [Collection](/concepts.md#colleccollectionstion) we just installed.
84+
- `appsec_config` is the name of the [*AppSec Configuration*](appsec/configuration.md#appsec-configuration) that was included in the [Collection](/concepts.md#collections) we just installed.
8585
- the `listen_addr` is the IP and port the AppSec Component will listen to.
8686

8787
:::warning

crowdsec-docs/docs/appsec/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ DEBU[2023-12-06 15:40:26] Finish evaluating rule band=inb
6363
## Authenticating with the AppSec Component
6464

6565
:::note
66-
We are assuming the AppSec engine is running on `127.0.0.1:7422`. See [installation directives](/docs/next/appsec/install)
66+
We are assuming the AppSec engine is running on `127.0.0.1:7422`. See [installation directives](/docs/next/appsec/installation)
6767
:::
6868

6969
> Create a valid API Key

crowdsec-docs/docs/concepts.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The `labels` part is here to tag the incoming logs with a type. `labels.type` ar
6565

6666
## Application Security Component
6767

68-
[[References](/appsec/intro.md)]
68+
[[References](appsec/intro)]
6969

7070
The Application Security Component is a special datasource that allows the supported remediation components to forward HTTP requests to crowdsec for analysis, before they can reach the application.
7171
Because CrowdSec can analyse the request and take a decision before it reaches the application, the combo of the Application Security Component and the remediation components acts as a Web Application Firewall (WAF).
@@ -142,9 +142,9 @@ You can as well [write your own](/scenarios/create.md)!
142142

143143
## AppSec Rules
144144

145-
[[References](/appsec/intro.md)]
145+
[[References](appsec/intro)]
146146

147-
An AppSec rule is a YAML configuration file that describe a rule for the [Application Security Component](/appsec/intro.md).
147+
An AppSec rule is a YAML configuration file that describe a rule for the [Application Security Component](appsec/intro).
148148

149149
An AppSec rule can match on various aspect of an HTTP request, such as the verb, the URI, the headers, the parameters, the body, etc.
150150
You can use them to detect and block exploitation of specific vulnerabilities (virtual patching) or to write more generic WAF rules.
@@ -153,12 +153,12 @@ Contrary to scenarios, appsec rules can block a request before it reaches the ap
153153

154154
## AppSec Configs
155155

156-
An Appsec Config file is a YAML configuration file that tell the [Application Security Component](/appsec/intro.md) which rules should be loaded, and in which band (in-band or out-of-band).
156+
An Appsec Config file is a YAML configuration file that tell the [Application Security Component](appsec/intro) which rules should be loaded, and in which band (in-band or out-of-band).
157157

158158
The config also expose hooks allowing you to customize at runtime the behavior of the AppSec component (disable a rule on a specific URL, apply a captcha if a specific rule is triggered, etc.)
159159

160160

161-
[[References](/appsec/intro.md)]
161+
[[References](appsec/intro)]
162162

163163
## Collections
164164

crowdsec-docs/docs/data_sources/appsec.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ title: Application Security Component
66

77
This module allows you to enable the `Application Security Component` as a data source.
88

9-
A more detailed documentation is available [here](/appsec/intro.md).
9+
A more detailed documentation is available [here](/docs/next/appsec/intro).
1010

11-
A quickstart tutorial is available [here](/appsec/quickstart.md).
11+
A quickstart tutorial is available for [Nginx/OpenResty](/docs/next/appsec/quickstart/nginxopenresty) and [Traefik](/docs/next/appsec/quickstart/traefik).
1212

1313
## Configuration example
1414

crowdsec-docs/docs/getting_started/install_opnsense.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Do not enable/start the services from the terminal like you would on a standard
2727

2828
Refresh the page and go to `Services > CrowdSec > Overview` to verify the running services and installed configurations.
2929

30-
Great, you now have CrowdSec installed on your system. Have a look at the [post installation steps](/getting_started/next_steps.md) to see how to to configure and optimize it,
30+
Great, you now have CrowdSec installed on your system. Have a look at the [post installation steps](/u/getting_started/next_steps) to see how to to configure and optimize it,
3131
these recommendations are valid for any system.
3232

3333

0 commit comments

Comments
 (0)