Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
10 changes: 4 additions & 6 deletions .github/workflows/build_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,11 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Use Node.js 18.x
uses: actions/setup-node@v3
- uses: actions/checkout@v4
- name: Use Node.js 20.x
uses: actions/setup-node@v4
with:
node-version: 18.x
node-version: 20
- name: Install dependencies
run: npm ci
working-directory: ./crowdsec-docs/
- run: npm run build --if-present
working-directory: ./crowdsec-docs/
21 changes: 20 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,20 @@
.vscode
.vscode
node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,29 @@

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

Online version of this documentation is available here: https://doc.crowdsec.net/
Online version of this documentation is available here: https://doc.crowdsec.net/

The documentation is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

## Installation

```console
npm install
```

## Local Development

```console
npm run start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

## Build

```console
npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
you can also use the `npm run serve` command to test the build locally.
15 changes: 15 additions & 0 deletions amplify.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
version: 1
frontend:
phases:
build:
commands:
- nvm use 20
- npm install
- npm run build
artifacts:
baseDirectory: build
files:
- "**/*"
cache:
paths:
- node_modules/**/*
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
slug: crowdsec_firewall_freebsd
title: How to install CrowdSec Firewall Bouncer on FreeBSD
author: Sofian Brabez
author_url: https://github.com/sbz
authors: [sbz]
tags: [bouncer, firewall, crowdsec]
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
slug: metabase_without_docker
title: How to configure metabase dasbhoard without docker
author: Crowdsec Team
author_url: https://github.com/crowdsecurity
authors: crowdsec
tags: [dashboard, metabase]
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
slug: cscli_dashboard_deprecation
title: Cscli dashboard deprecation
author: Crowdsec Team
author_url: https://github.com/crowdsecurity
authors: crowdsec
tags: [dashboard, Metabase]
---

Expand Down
8 changes: 8 additions & 0 deletions blog/authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
sbz:
name: Sofian Brabez
url: https://github.com/sbz

crowdsec:
name: Crowdsec Team
url: https://github.com/crowdsecurity
image_url: /img/crowdsec_logo.png
20 changes: 0 additions & 20 deletions crowdsec-docs/.gitignore

This file was deleted.

6 changes: 0 additions & 6 deletions crowdsec-docs/.prettierrc

This file was deleted.

33 changes: 0 additions & 33 deletions crowdsec-docs/README.md

This file was deleted.

Loading