Suricate

Download • Install • Widgets • DevTool

Visualize IT platforms data within a single, centralized monitoring system.

Build customizable dashboards using various widgets, sourcing data from IT platform REST APIs. Suricate uses WebSockets to control and update dashboards on external displays.

Table of Contents

• Download
• Install
• Configuration
  • Database
    • H2
    • PostgreSQL
    • Initialization with Flyway
  • Authentication
    • Database
    • LDAP
    • Social Login
      • GitHub
      • GitLab
      • Redirection to Front-End
      • Name Parsing Strategy
    • Personal Access Token
  • Widgets
    • Encryption
    • Repositories
• Swagger
• Contribution

Download

You can download Suricate as a JAR from the GitHub releases page (requires Java 21).

Additionally, a Docker image is available on Docker Hub.

Install

Suricate is built on the Spring Boot framework and can be configured using a Spring Boot configuration file, which includes a sample file located at src/main/resources/application.yml.

If necessary, you can override the properties from the default application.yml file by following the Spring Boot externalized configuration guide. For example, you can create a custom /config/application.yml or set the --spring.config.location system property when running the fat jar file:

java -jar suricate.jar --spring.config.location=classpath:\,file:C:\myCustomLocation\

Alternatively, you can use the provided docker-compose file to run the application and use a volume to override the default properties:

docker-compose up -d

After running the command, the application will be accessible on http://localhost:8080/.

Configuration

Database

Suricate supports multiple database management systems:

• H2 (default)
• PostgreSQL

H2

By default, Suricate runs on an H2 file database, activated through the h2 profile in application.yml:

spring:
  profiles:
    active: 'h2'

This activates the application-h2.yml file, which contains the necessary H2 configuration.

PostgreSQL

To switch to PostgreSQL, activate the postgresql profile:

spring:
  profiles:
    active: 'postgresql'

This enables the application-postgresql.yml file, which contains the PostgreSQL-specific configuration.

Additionally, you need to provide your database connection details in an external configuration file:

spring:
  datasource:
    url: '<your-database-url>'
    username: '<your-username>'
    password: '<your-password>'

Initialization with Flyway

Suricate uses Flyway for database initialization.

By default, Flyway:

• Automatically sets up the database structure (tables, constraints, etc.).
• Populates the database with the minimum required functional data on the first startup.

It applies the appropriate scripts based on your database management system. These scripts are located in src/main/resources/flyway.

Flyway maintains the database version in a table named schema_version, configured as:

spring:
  flyway:
    table: 'schema_version'

If needed, it can be disabled by setting:

spring:
  flyway:
    enabled: false

Authentication

Suricate supports multiple authentication methods:

• Database Authentication
• LDAP Authentication
• Social Login (OIDC - OpenID Connect)

Regardless of the method used, Suricate issues a JWT token to authenticate users on the backend.

You can configure the JWT token using the following properties:

application:
  authentication:
    jwt:
      signingKey: 'changeitchangeitchangeitchangeit'
      tokenValidityMs: 86400000

The signing key should be at least 256 bits long (since Suricate v2.8.0) and should be changed for each environment.

Database

After signing up, you can log in to Suricate using database authentication.

To enable this authentication mode, set the following YAML property:

application:
  authentication:
    provider: 'database'

When this mode is activated, a "Register now" button will appear on the login page, allowing users to create an account.

LDAP

You can log in to Suricate an LDAP.

To enable this authentication mode, set the following YAML property:

application:
  authentication:
    provider: 'ldap'

If you choose the ldap authentication mode, you must specify the following additional properties:

application:
  authentication:
    ldap:
      firstNameAttributeName: ''
      lastNameAttributeName: ''
      mailAttributeName: ''
      password: ''
      url: ''
      userDnPatterns: ''
      userSearchBase: ''
      userSearchFilter: ''
      username: ''

Social Login

Suricate supports authentication with GitHub and GitLab. You can configure social login using the application-social-login.yml file, which you can activate by running the application with the social-login profile.

When you activate social login, you can activate or deactivate a social login mode by adding or removing it from the property:

application:
  authentication:
    socialProviders: 'gitlab,github'

GitHub

To log in using GitHub, you must specify the following properties:

spring:
  security:
    oauth2:
      client:
        registration:
          github:
            client-id: '<github-client-id>'
            client-secret: '<github-client-secret>'

GitLab

To log in using GitLab with OIDC, you must specify the following properties:

spring:
  security:
    oauth2:
      client:
        provider:
          gitlab:
            issuer-uri: 'https://gitlab.com'
        registration:
          gitlab:
            authorization-grant-type: 'authorization_code'
            client-id: '<gitlab-client-id>'
            client-secret: '<gitlab-client-secret>'
            redirect-uri: 'http://localhost:8080/login/oauth2/code/gitlab'
            scope: 'read_user,openid,profile,email'

To log in using GitLab with OAuth2, you must specify the following properties:

spring:
  security:
    oauth2:
      client:
        provider:
          gitlab:
            issuer-uri: 'https://gitlab.com'
            user-info-uri: 'https://gitlab.com/api/v4/user'
            user-name-attribute: 'username'
        registration:
          gitlab:
            authorization-grant-type: 'authorization_code'
            client-id: '<gitlab-client-id>'
            client-secret: '<gitlab-client-secret>'
            redirect-uri: 'http://localhost:8080/login/oauth2/code/gitlab'
            scope: 'read_user'

Redirection to Front-End

The social login is based on OAuth2/OIDC and is handled by the Back-End. After a successful or failed authentication with a social network, the Back-End redirects to the Front-End.

The Back-End uses the following methods to redirect to the Front-End in this order:

• A given redirect_uri query parameter provided by the Front-End to the Back-End in the authorization request ( e.g., http://localhost:8080/api/oauth2/authorization/github?redirect_uri=/login). The host can even be different (e.g., http://localhost:8080/api/oauth2/authorization/github?redirect_uri=http://localhost:4200/login)
• The referer in this authorization, but it can be hidden or lost after a redirection to the ID provider.
• A default target URL defined in the Back-End.

The first option is currently used.

The other options are defined by the following properties:

application:
  authentication:
    oauth2:
      defaultTargetUrl: 'http://localhost:4200/login'
      useReferer: false

Name Parsing Strategy

By default, Suricate parses the user's first name and last name from the ID provider using the format "Firstname Lastname". However, you can also configure Suricate to parse the first name and last name based on the case ( upper/lower) using the following property:

application:
  authentication:
    socialProvidersConfig:
      <provider>:
        nameCaseParse: true

Simply replace <provider> with the appropriate social provider, such as github or gitlab.

Personal Access Token

The application allows for the generation of personal access tokens, which can be used for authentication. The following properties are used for token generation and verification:

application:
  authentication:
    pat:
      checksumSecret: 'changeit'
      prefix: 'sup'

It is recommended to update the checksumSecret with a different secret for each environment, to enhance security.

The prefix is used by the application to identify the token type and parse it.

Widgets

Here is given the guidelines to configure the widgets.

Encryption

Sensitive widget parameters such as passwords or tokens are encrypted in the database. You must change the encryption key for each environment using the following property:

jasypt:
  encryptor:
    password: 'changeitchangeitchangeitchangeit'

Repositories

The first time you start the application, you'll need to configure a repository of widgets. To do this, navigate to the repositories tab and add a new repository. You can choose to add either a local or remote repository (such as GitLab or GitHub).

If you don't have a repository yet, you can create your own widgets repository by following the instructions provided in the official open-source widgets GitHub repository, or use this repository directly.

To configure this repository in Suricate, use the following settings:

Name: [ Enter a name of your choice ]
URL: https://github.com/michelin/suricate-widgets.git
branch: master
login: [ Your GitHub login ]
password: [ Your GitHub password ]

Swagger

Suricate uses Springdoc to generate an API documentation.

By default:

• The Swagger UI page is available at http://localhost:8080/swagger-ui/index.html.
• The OpenAPI description is available at http://localhost:8080/v3/api-docs.

Both can be customized by using the Springdoc properties.

You can authenticate using the POST /api/v1/auth/signin endpoint and then use the Authorize button to add the JWT token in the Authorization header.

Note: The authentication through social login is not supported yet by the Swagger UI.

Contribution

We welcome contributions from the community! Before you get started, please take a look at our contribution guide to learn about our guidelines and best practices. We appreciate your help in making Suricate a better tool for everyone. If anyone requires it, we can provide partial extracts of your data before the shutdown.