Improved readme (#36)
This commit is contained in:
parent
12c877b41b
commit
8e2c9bc705
6 changed files with 40 additions and 4 deletions
26
README.md
26
README.md
|
@ -34,15 +34,33 @@ Besides detecting and stopping attacks in real time based on your logs, it allow
|
|||
|
||||
## Key points
|
||||
|
||||
### Easy installation, no technical barrier
|
||||
### Fast assisted installation, no technical barrier
|
||||
|
||||
![](https://github.com/crowdsecurity/crowdsec/blob/master/docs/assets/images/crowdsec_install.gif)
|
||||
<details open>
|
||||
<summary>User is assisted during setup, providing functional out-of-the-box setup</summary>
|
||||
<img src="https://github.com/crowdsecurity/crowdsec/blob/master/docs/assets/images/crowdsec_install.gif">
|
||||
</details>
|
||||
|
||||
### Out of the box protection
|
||||
### Out of the box detection
|
||||
|
||||
![](https://github.com/crowdsecurity/crowdsec/blob/master/docs/assets/images/out-of-the-box-protection.gif)
|
||||
<details>
|
||||
<summary>Baseline detection is effective out-of-the-box, no fine-tuning required</summary>
|
||||
<img src="https://github.com/crowdsecurity/crowdsec/blob/master/docs/assets/images/out-of-the-box-protection.gif">
|
||||
</details>
|
||||
|
||||
### Easy blocker deployment
|
||||
|
||||
<details>
|
||||
<summary>It's trivial to add blockers to enforce decisions of crowdsec</summary>
|
||||
<img src="https://github.com/crowdsecurity/crowdsec/blob/master/docs/assets/images/blocker-installation.gif">
|
||||
</details>
|
||||
|
||||
### Easy dashboard access
|
||||
|
||||
<details>
|
||||
<summary>It's easy to deploy a metabase interface to view your data simply with cscli</summary>
|
||||
<img src="https://github.com/crowdsecurity/crowdsec/blob/master/docs/assets/images/cscli-metabase.gif">
|
||||
</details>
|
||||
|
||||
## About this repository
|
||||
|
||||
|
|
17
config/user.yaml
Normal file
17
config/user.yaml
Normal file
|
@ -0,0 +1,17 @@
|
|||
working_dir: /tmp/
|
||||
data_dir: ${DATA}
|
||||
config_dir: ${CFG}
|
||||
pid_dir: ${PID}
|
||||
log_dir: /var/log/
|
||||
cscli_dir: ${CFG}/cscli
|
||||
log_mode: stdout
|
||||
log_level: info
|
||||
profiling: false
|
||||
sqlite_path: ${DATA}/crowdsec.db
|
||||
apimode: true
|
||||
daemon: false
|
||||
prometheus: true
|
||||
#for prometheus agent / golang debugging
|
||||
http_listen: 127.0.0.1:6060
|
||||
plugin:
|
||||
backend: "/etc/crowdsec/plugins/backend"
|
BIN
docs/assets/images/blocker-installation.gif
Normal file
BIN
docs/assets/images/blocker-installation.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 2 MiB |
BIN
docs/assets/images/cscli-metabase.gif
Normal file
BIN
docs/assets/images/cscli-metabase.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 3.7 MiB |
Binary file not shown.
Before Width: | Height: | Size: 385 KiB After Width: | Height: | Size: 691 KiB |
|
@ -288,6 +288,7 @@ install_crowdsec() {
|
|||
install -v -m 600 -D ./config/api.yaml "${CROWDSEC_CONFIG_PATH}" || exit
|
||||
mkdir -p ${PID_DIR} || exit
|
||||
PID=${PID_DIR} DATA=${CROWDSEC_DATA_DIR} CFG=${CROWDSEC_CONFIG_PATH} envsubst < ./config/prod.yaml > ${CROWDSEC_CONFIG_PATH}"/default.yaml"
|
||||
PID=${PID_DIR} DATA=${CROWDSEC_DATA_DIR} CFG=${CROWDSEC_CONFIG_PATH} envsubst < ./config/user.yaml > ${CROWDSEC_CONFIG_PATH}"/user.yaml"
|
||||
CFG=${CROWDSEC_CONFIG_PATH} PID=${PID_DIR} BIN=${CROWDSEC_BIN_INSTALLED} envsubst < ./config/crowdsec.service > "${SYSTEMD_PATH_FILE}"
|
||||
install_bins
|
||||
systemctl daemon-reload
|
||||
|
|
Loading…
Reference in a new issue