Project Title
Sample microservice description.
Introduction
TODO: Replace with introduction
Features
TODO: Description of features
- Include a list of
- all the many beautiful
- web server features
Requirements
The application can be run locally or in a docker container, the requirements for each setup are listed below.
EGO
A running instance of EGO is required to generate the Authorization tokens and to provide the verification key.
EGO can be cloned and run locally if no public server is available.
Local
Docker
Quick Start
Make sure the JWT Verification Key URL is configured, then you can run the server in a docker container or on your local machine.
Configure JWT Verification Key
Update application.yml. Set auth.jwt.publicKeyUrl to the URL to fetch the JWT verification key. The application will not start if it can’t set the verification key for the JWTConverter.
The default value in the application.yml file is set to connect to EGO running locally on its default port 8081.
Run Local
$ mvn spring-boot:run
Application will run by default on port 1234
Configure the port by changing server.port in application.yml
Run Docker
First build the image:
$ docker-compose build
When ready, run it:
$ docker-compose up
Application will run by default on port 1234
Configure the port by changing services.api.ports in docker-compose.yml. Port 1234 was used by default so the value is easy to identify and change in the configuration file.
Testing
TODO: Additional instructions for testing the application.
API
TODO: API Reference with examples, or a link to a wiki or other documentation source.
Acknowledgements
TODO: Show folks some love.
