crowdsec/docs/observability/dashboard.md

57 lines
2 KiB
Markdown
Raw Normal View History

!!! warning "SQLite & MySQL"
The default database of {{crowdsec.Name}} is SQLite. While MySQL is supported as well (>= 0.3.0), it is not in the scope of this documentation.
The {{cli.name}} command `{{cli.bin}} dashboard setup` will use [docker](https://docs.docker.com/get-docker/) to install [metabase docker image](https://hub.docker.com/r/metabase/metabase/) and fetch our metabase template to have a configured and ready dashboard.
## Deployment
The metabase dashboard can be setup with :
```bash
{{cli.bin}} dashboard setup
```
`--listen` and `--port` options allow you to control on which address / port will the docker be binded.
<details>
<summary>{{cli.name}} dashboard setup output</summary>
```bash
INFO[0000] /var/lib/crowdsec/data/metabase.db exists, skip.
INFO[0000] Downloaded metabase DB
INFO[0000] Pulling docker image metabase/metabase
...
INFO[0001] Creating container
INFO[0001] Starting container
INFO[0002] Started metabase
INFO[0002] Waiting for metabase API to be up (can take up to a minute)
...........
INFO[0034] Metabase API is up
INFO[0034] Successfully authenticated
INFO[0034] Changed password !
INFO[0034] Setup finished
INFO[0034] url : http://127.0.0.1:3000
INFO[0034] username: metabase@crowdsec.net
INFO[0034] password: W1XJb8iw1A02U5nW7xxxxXXXxxXXXxXXxxXXXxxxXxXxXxXPdbvQdLlshqqPg8pf
```
</details>
!!! tip "Protip"
the `dashboard setup` command will output generated credentials for metabase.
Don't forget to save those !
Now you can connect to your dashboard, sign-in with your saved credentials then click on {{crowdsec.Name}} Dashboard to get this:
![Dashboard_view](../assets/images/dashboard_view.png)
Dashboard docker image can be managed by {{cli.name}} and docker cli also. Look at the {{cli.name}} help command using
```bash
{{cli.bin}} dashboard -h
```