This is a multi-tenant, cloud-native app that allows organisations to manage their VeraId members and the issuance of their respective Member Bundles (which they'd subsequently use to produce VeraId signatures).
Documentation for operators and API client implementers is available on docs.relaycorp.tech.
This app requires the following system dependencies:
- Node.js 18.
- Kubernetes 1.22+ (we strongly recommend Minikube with Docker).
- Knative v1.9+.
- Skaffold v2.1+.
To start the app, simply get Skaffold to deploy the relevant Kubernetes resources by running:
npm start
The unit test suite can be run with the standard npm test.
If you'd like to run some tests against the real instance of the app managed by Skaffold, the simplest way to do that is to add/modify functional tests and then run npm run test:integration (alternatively, you can use your IDE to only run the test you're interested in).
If for whatever reason you want to manually test the app, you first need to get the local URLs to the services by running:
kn service list
To make authenticated requests to the API server, you need to get an access token from the mock authorisation server first. For example, to get an access token for the super admin ([email protected]) using the OAuth2 client credentials flow, run:
POST http://mock-authz-server.default.10.103.177.106.sslip.io/default/token
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&[email protected]&client_secret=s3cr3tYou can then make authenticated requests to the API server by setting the Authorization header to Bearer <access_token>.
We love contributions! If you haven't contributed to a Relaycorp project before, please take a minute to read our guidelines first.