In order to run the service the following software/APIs are required
- A MongoDB database
- The Mailgun API for email verification
- The reCAPTCHA v2 API for the registration captcha
Container images are published to the GitHub Packages repository attached to this repository, they are also published under releases.
The following environment variables need to be populated in order for the service to work correctly.
| Name | Description | Constraints |
|---|---|---|
| SPRING_DATA_MONGODB_HOST | A MongoDB host | - |
| SPRING_DATA_MONGODB_PORT | The MongoDB port | - |
| SPRING_DATA_MONGODB_AUTHENTICATION-DATABASE | The Authentication database to use for login | - |
| SPRING_DATA_MONGODB_DATABASE | MongoDB database to use | - |
| SPRING_DATA_MONGODB_USERNAME | A MongoDB username authorized on the previous database | - |
| SPRING_DATA_MONGODB_PASSWORD | The password for the user | - |
| MAILGUN_APIURL | The Mailgun api endpoint to use (e.g. https://api.eu.mailgun.net/v3) | - |
| MAILGUN_APIKEY | The Mailgun api key | - |
| MAILGUN_DOMAIN | The Mailgun domain to use | - |
| MAILGUN_SENDER | The email address to use for sending | - |
| RECAPTCHA_KEY_SITE | A reCAPTCHA v2 sitekey | - |
| RECAPTCHA_KEY_SECRET | The matching reCAPTCHA v2 secret for the used sitekey | - |
| KNAG_KEY_PRIV | Private key used for signing JWTs | PKCS #8 Syntax |
| KNAG_KEY_PUB | Public key used for verifying JWTs | X.509 Syntax |
The service is exposed on the port 8080
There are kubernetes probes exposed on the port 3000