diff --git a/README.md b/README.md index c9f547043..00a02fa35 100644 --- a/README.md +++ b/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) +
+ User is assisted during setup, providing functional out-of-the-box setup + +
-### 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) +
+ Baseline detection is effective out-of-the-box, no fine-tuning required + +
+### Easy blocker deployment +
+ It's trivial to add blockers to enforce decisions of crowdsec + +
+ +### Easy dashboard access + +
+ It's easy to deploy a metabase interface to view your data simply with cscli + +
## About this repository diff --git a/config/user.yaml b/config/user.yaml new file mode 100644 index 000000000..addbdf726 --- /dev/null +++ b/config/user.yaml @@ -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" diff --git a/docs/assets/images/blocker-installation.gif b/docs/assets/images/blocker-installation.gif new file mode 100644 index 000000000..9846e97fc Binary files /dev/null and b/docs/assets/images/blocker-installation.gif differ diff --git a/docs/assets/images/cscli-metabase.gif b/docs/assets/images/cscli-metabase.gif new file mode 100644 index 000000000..b21d41191 Binary files /dev/null and b/docs/assets/images/cscli-metabase.gif differ diff --git a/docs/assets/images/out-of-the-box-protection.gif b/docs/assets/images/out-of-the-box-protection.gif index 427de63b2..a309f794c 100644 Binary files a/docs/assets/images/out-of-the-box-protection.gif and b/docs/assets/images/out-of-the-box-protection.gif differ diff --git a/wizard.sh b/wizard.sh index cd3063d31..4214d4e1a 100755 --- a/wizard.sh +++ b/wizard.sh @@ -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