Get started

Run Simault locally

The shortest path from a clone to a running instance. For a cluster, see Deploy.

What you need

1. Get the source

git clone https://github.com/AskMeiPaaS/simault.git
cd simault

2. Create a master key

The local key provider needs a 96-byte key file. It protects everything Simault stores.

openssl rand -out master-key.txt 96
chmod 600 master-key.txt

Losing this file makes every stored secret and registered public key unreadable. Keep a copy somewhere safe before you store anything you care about.

3. Set the admin key

This is the only setting without a default. Simault refuses to start without it.

export VAULT_ADMIN_API_KEY="$(openssl rand -hex 32)"

Everything else defaults to a local setup: MongoDB at mongodb://localhost:27017, the local key provider and master-key.txt in the current directory.

4. Build and run

mvn clean install
mvn spring-boot:run

The first build also runs the test suite, which downloads a MongoDB binary for its integration tests.

5. Check that it is up

curl http://localhost:8080/actuator/health

You should see {"status":"UP"} with the health groups listed.

6. Register an application and read its secret

The README has a complete walkthrough you can paste: register an application, create its key pair, exchange a signature for a token, and read the secret.

Open the walkthrough Deploy to a cluster

Where to go next