Seiso is alpha software.

For now, if you want to try it out, you'll have to do "dev mode" stuff, like building from source and running the app locally.

We'll provide binary downloads and more production-focused resources as the project matures.

This is a no-nonsense guide to getting up and running with Seiso as quickly as possible. If you need a more general background to Seiso, see the About Seiso page.

1 Download Seiso

For now, it's source only . So get the software by cloning the Git repo:

$ git clone

As we get closer to bona fide releases, we'll make binary downloads available.

2 Set up your environment

Here are some things you'll need to do before you can build and run Seiso.


  • Install Java 8 if you don't already have it.


  • Install MySQL 5.6.x. It may work with other versions; we haven't tried.
  • Create the Seiso database schema by running src/main/sql/create-tables.sql.
  • Insert the reference data using src/main/sql/insert-reference-data.sql.
  • If you want to load some sample data (recommended if you are just taking a look around), run src/main/sql/insert-sample-data.sql.


Seiso pushes data change notifications out over RabbitMQ. This allows other services to react to changes. It also allows us to push websocket messages to the UI in load-balanced Seiso deployments. So:

  • Install RabbitMQ.
  • Optional For visibility we recommend installing the RabbitMQ management plugin as well.

3 Configure Seiso

Create a copy of conf-sample/application.yml and modify it as appropriate.

To run Seiso in development mode, you can place it directly in src/main/resources.

4 Build Seiso

Build Seiso using Gradle. On *nix:

$ ./gradlew clean build

If the build succeeds, then you should see a fat, executable JAR at build/libs/seiso-0.2.0.SNAPSHOT.jar. That's the Seiso app.

5 Run Seiso

You can run Seiso from Gradle like this:

$ ./gradlew bootRun

Then point your HTML5-enabled browser to https://localhost:8443 or whatever scheme/port combination you happened to choose during configuration.

You should see a home page with a list of services. Browse around.


If that worked, congratulations: Seiso is running. To learn how to use the app (whether UI, API or management features), check out the Seiso User Manual.

Questions & Comments