sgabe/scirius repository overview

⁠Scirius

Scirius Community Edition is a web interface dedicated to Suricata IDS⁠ ruleset management and was originally developed⁠ and dockerized⁠ by Stamus Networks⁠. This Docker image has been created for a fork⁠ of the original project instead of using the official image provided by the authors.

⁠Usage

docker run -p 127.0.0.1:8000:8000 \
    -e "SECRET_KEY=<YOUR SECRET KEY>" \
    -v /path/to/scirius/data:/data \
    -v /path/to/scirius/logs:/logs \
    -v /path/to/scirius/static:/static \
    -v /path/to/suricata/rules:/rules \
    -v /path/to/suricata/suricata.socket:/var/run/suricata.socket \
    sgabe/scirius

⁠Environment variables

Most of the configuration options defined in the built-in settings.py shipped with the original project are exposed via environment variables in the local_settings.py file used in the container. This allows you to customize Scirius without creating or modifying configuration files. The below table summarizes the available environment variables and their default settings. For more information on how to configure Scirius, please refer to the original project documentation available here⁠.

⁠Volumes

The below table summarizes the volumes available to be shared with the host or other containers. Mainly the /rules folder should be available to Suricata while resources in the /static directory should be served through a reverse proxy.

⁠Link with Suricata

To interact with Suricata, you need to bind-mount Suricata's command socket into the Scirius container. By default, Scirius will expect the Unix socket file to be available at /var/run/suricata.socket, however, you can specify another path in the SURICATA_UNIX_SOCKET environment variable.

-v /path/to/suricata/suricata-command.socket:/var/run/suricata.socket