crowdsec/docs/getting_started/installation.md
erenJag 4f9d252a15
Add the documentation into crowdsec repo (#3)
Add the documentation into crowdsec repo
2020-05-15 16:58:24 +02:00

1.6 KiB

Installation

Fetch {{crowdsec.name}}'s latest version here.

tar xvzf crowdsec-release.tgz
cd crowdsec-v0.X.X

A {{wizard.name}} is provided to help you deploy {{crowdsec.name}} and {{cli.name}}.

Using the interactive wizard

sudo {{wizard.bin}} -i

crowdsec

The {{wizard.name}} is going to guide you through the following steps :

  • detect services that are present on your machine
  • detect selected services logs
  • suggest collections (parsers and scenarios) to deploy
  • deploy & configure {{crowdsec.name}} in order to watch selected logs for selected scenarios

The process should take less than a minute, please report if there are any issues.

You are then ready to take a tour of your freshly deployed {{crowdsec.name}} !

Using unattended mode

you of little faith

sudo {{wizard.bin}} --bininstall

This will deploy a valid/empty {{crowdsec.name}} configuration files and binaries. Beware, in this state, {{crowdsec.name}} won't monitor/detect anything unless configured.

From source

!!! warning "Requirements"

* [Go](https://golang.org/doc/install) v1.13+
* `git clone {{crowdsec.url}}`

Go in {{crowdsec.name}} folder and build the binaries :

cd crowdsec
make build

{{crowdsec.name}} bin will be located in ./cmd/crowdsec/crowdsec and {{cli.name}} bin in cmd/crowdsec-cli/{{cli.bin}}

Now, you can install either with interactive wizard or the unattended mode.