Skip to content

Commit 4b2a104

Browse files
committed
merge main
2 parents 3d97f77 + 8f24d8b commit 4b2a104

File tree

97 files changed

+18527
-26417
lines changed

Some content is hidden

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

97 files changed

+18527
-26417
lines changed

.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

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,29 @@
22

33
This repository holds the documentation for the [crowdsec project](https://github.com/crowdsecurity/crowdsec).
44

5-
Online version of this documentation is available here: https://doc.crowdsec.net/
5+
Online version of this documentation is available here: https://doc.crowdsec.net/
6+
7+
The documentation is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
8+
9+
## Installation
10+
11+
```console
12+
npm install
13+
```
14+
15+
## Local Development
16+
17+
```console
18+
npm run start
19+
```
20+
21+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
22+
23+
## Build
24+
25+
```console
26+
npm run build
27+
```
28+
29+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
30+
you can also use the `npm run serve` command to test the build locally.

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/README.md

Lines changed: 0 additions & 33 deletions
This file was deleted.

crowdsec-docs/blog/2020-08-04-crowdsec_firewall_freebsd.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
slug: crowdsec_firewall_freebsd
33
title: How to install CrowdSec Firewall Bouncer on FreeBSD
4-
author: Sofian Brabez
5-
author_url: https://github.com/sbz
4+
authors: [sbz]
65
tags: [bouncer, firewall, crowdsec]
76
---
87

crowdsec-docs/blog/2021-08-30-metabase_without_docker.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
slug: metabase_without_docker
33
title: How to configure metabase dasbhoard without docker
4-
author: Crowdsec Team
5-
author_url: https://github.com/crowdsecurity
4+
authors: crowdsec
65
tags: [dashboard, metabase]
76
---
87

crowdsec-docs/blog/2024-06-11-cscli_dashboard_deprecation.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
slug: cscli_dashboard_deprecation
33
title: Cscli dashboard deprecation
4-
author: Crowdsec Team
5-
author_url: https://github.com/crowdsecurity
4+
authors: crowdsec
65
tags: [dashboard, Metabase]
76
---
87

crowdsec-docs/blog/authors.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
sbz:
2+
name: Sofian Brabez
3+
url: https://github.com/sbz
4+
5+
crowdsec:
6+
name: Crowdsec Team
7+
url: https://github.com/crowdsecurity
8+
image_url: /img/crowdsec_logo.png

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!

0 commit comments

Comments
 (0)