https://github.com/relaycorp/veraid-authority
Cloud-native app that allows organisations to manage their VeraId members and the issuance of their respective bundles.
https://github.com/relaycorp/veraid-authority
vera veraid
Last synced: 6 months ago
JSON representation
Cloud-native app that allows organisations to manage their VeraId members and the issuance of their respective bundles.
- Host: GitHub
- URL: https://github.com/relaycorp/veraid-authority
- Owner: relaycorp
- License: other
- Created: 2023-02-16T11:09:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-22T04:55:23.000Z (6 months ago)
- Last Synced: 2025-04-23T15:15:20.478Z (6 months ago)
- Topics: vera, veraid
- Language: TypeScript
- Homepage: https://docs.relaycorp.tech/veraid-authority/
- Size: 4.09 MB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VeraId Authority
This is a multi-tenant, cloud-native app that allows organisations to manage their [VeraId](https://veraid.net) members and the issuance of their respective Member Bundles (which they'd subsequently use to produce VeraId signatures).
## Installation and usage
Documentation for operators and API client implementers is available on [docs.relaycorp.tech](https://docs.relaycorp.tech/veraid-authority/).
## Development
This app requires the following system dependencies:
- Node.js 22.
- Docker and Docker Compose.
To start the app, simply run:
```
docker compose up -d
```
### Automated testing
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, the simplest way to do that is to add/modify [functional tests](./src/functionalTests) and then run `npm run test:integration` (alternatively, you can use your IDE to only run the test you're interested in).
### Manual testing
If for whatever reason you want to manually test the app, you can access the services at:
- API server: http://localhost:8080
- Awala service: http://localhost:8081
- Queue service: http://localhost:8082
- Mock authorization server: http://localhost:8083
- MongoDB: localhost:27017
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 (`admin@veraid.example`) using the OAuth2 client credentials flow, run:
```http
POST http://localhost:8083/default/token
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&client_id=super-admin&client_secret=s3cr3t&scope=default
```
You can then make authenticated requests to the API server by setting the `Authorization` header to `Bearer `.
Alternatively, use `client_id=user` to get an access token for a regular user.
## Contributions
We love contributions! If you haven't contributed to a Relaycorp project before, please take a minute to [read our guidelines](https://github.com/relaycorp/.github/blob/master/CONTRIBUTING.md) first.
## Licence
This project is fair source. See [LICENSE](./LICENSE) for details.