This project is archived and is no longer being developed or maintained.

Suricate Widget Tester

Download • Install • Suricate • Widgets

Build and validate your Suricate widgets in a sandboxed setup before integrating it into a Suricate instance.

Table of Contents

• Download
• Install
• Configuration
  • Repository
• Contribution

Download

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

Install

The Suricate Widget Tester 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-widget-tester.jar --spring.config.location=classpath:\,file:C:\myCustomLocation\

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

Configuration

Repository

The Suricate Widget Tester reads the content of a widget repository. The repository must follow the required structure (see the official open-source widgets GitHub repository).

The repository location can be configured with the following property:

application:
  widgets:
    repository: '<path-to-repository>'

It is set to /tmp by default.

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.