Dashboard
MySQL & PostgreSQL
MySQL and PostgreSQL are currently not supported by cscli dashboard
. It means that you can run cscli dashboard only if you use SQLite
(default) as storage database with your local API.
The cscli command cscli dashboard setup
will use docker to install metabase docker image and fetch our metabase template to have a configured and ready dashboard.
Setup¶
Setup and Start crowdsec metabase dashboard
sudo cscli dashboard setup
Optional arguments:
-l
|--listen
: ip address to listen on for docker (default is127.0.0.1
)-p
|--port
: port to listen on for docker (default is8080
)--password
: password for metabase user (default is generated randomly)-f
|--force
: override existing setup
cscli dashboard setup
INFO[0000] Pulling docker image metabase/metabase
...........
INFO[0002] creating container '/crowdsec-metabase'
INFO[0002] Waiting for metabase API to be up (can take up to a minute)
..............
INFO[0051] Metabase is ready
URL : 'http://127.0.0.1:3000'
username : 'crowdsec@crowdsec.net'
password : '<RANDOM_PASSWORD>'
Protip
the dashboard setup
command will output generated credentials for metabase.
Those are stored in /etc/crowdsec/metabase/metabase.yaml
Now you can connect to your dashboard, sign-in with your saved credentials then click on Crowdsec-agent Dashboard to get this:
Dashboard docker image can be managed by cscli and docker cli also. Look at the cscli help command using
sudo cscli dashboard -h
Remove the dashboard¶
Remove crowdsec metabase dashboard
sudo cscli dashboard remove [-f]
Optional arguments:
-f
|--force
: will force remove the dashboard
Stop the dashboard¶
Stop crowdsec metabase dashboard
sudo cscli dashboard stop
Start the dashboard¶
Start crowdsec metabase dashboard
sudo cscli dashboard start