Skip to content

Commit 5a050e6

Browse files
Fix broken links (#658)
* fix sidebar links problem * fix appsec broken links * fix broken links pointing to unversioned doc * remove link with todo in favor of todo comments * various broken links (typo,bad anchors...) * enhance: Fix broken links that actually link to nowhere --------- Co-authored-by: Laurence <laurence.jones@live.co.uk>
1 parent 952bcc8 commit 5a050e6

46 files changed

Lines changed: 846 additions & 863 deletions

File tree

Some content is hidden

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

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

crowdsec-docs/docs/getting_started/install_pfsense.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,7 @@ and `crowdsec-firewall-bouncer.log`.
141141

142142
## Service Management
143143

144-
Both services, Security Engine (crowdsec) and Remediation (crowdsec-firewall-bouncer) can be
145-
controlled from [Status/Services](/status_services.php).
144+
Both services, Security Engine (crowdsec) and Remediation (crowdsec-firewall-bouncer) can be controlled from `Status/Services`.
146145
The equivalent shell commands are `service crowdsec.sh start/stop/restart` and `service crowdsec_firewall.sh start/stop/restart`. Note the ending **.sh**!
147146

148147
## Viewing blocked IPs

crowdsec-docs/docs/getting_started/install_pyagent.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 1
66

77
# Using our Python SDK
88

9-
This python SDK is designed for signal sharing partners to send signals and benefit from the community blocklist. Learn more about [signal sharing](TODO).
9+
This python SDK is designed for signal sharing partners to send signals and benefit from the community blocklist. <!-- Learn more about [signal sharing](TODO). -->
1010

1111
Our SDK does the heavy lifting of the CAPI connectivity so you can simply, sendSignals and getDecisions, as well as enroll your soft-agent into the console.
1212

@@ -82,7 +82,7 @@ decisions = client.get_decisions(
8282

8383
```
8484

85-
To obtain attachment key for enrolling a machine see [this doc](../console/enrollment/#where-can-i-find-my-enrollment-key)
85+
To obtain attachment key for enrolling a machine see [this doc](/u/getting_started/post_installation/console/#engines-page)
8686

8787
See reference section for more details.
8888

crowdsec-docs/docs/intro.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ In addition to the core "detect and react" mechanism, CrowdSec is committed to s
4949

5050
Under the hood, the Security Engine has various components:
5151

52-
- The Log Processor is in charge of detection: it analyzes logs from [various data sources](/docs/data_sources/intro) or [HTTP requests](/appsec/intro.md) from web servers.
53-
- The [Appsec](/appsec/intro.md) feature is part of the Log Processor and filters HTTP Requests from the compatible web servers.
52+
- The Log Processor is in charge of detection: it analyzes logs from [various data sources](data_sources/intro) or [HTTP requests](appsec/intro) from web servers.
53+
- The [Appsec](appsec/intro) feature is part of the Log Processor and filters HTTP Requests from the compatible web servers.
5454
- The [Local API](/local_api/intro.md) acts as a middle man:
5555
- Between the [Log Processors](/docs/data_sources/intro) and the [Remediation Components](/u/bouncers/intro) which are in charge of enforcing decisions.
5656
- And with the [Central API](/central_api/intro.md) to share alerts and receive blocklists.
@@ -64,7 +64,7 @@ This architecture allows for both simple/standalone setups, or more distributed
6464
- Already have a log pit (such as rsyslog or loki)? Run crowdsec next to it, not on the production workloads
6565
- Running Kubernetes? Have a look at [our helm chart](/u/getting_started/installation/kubernetes)
6666
- Running containers? The [docker data source](/docs/data_sources/docker) might be what you need
67-
- Just looking for a WAF? Look at [our quickstart](/appsec/intro.md)
67+
- Just looking for a WAF? Look at [our quickstart](appsec/intro)
6868

6969
Distributed architecture example:
7070

0 commit comments

Comments
 (0)