FFC payment statement viewer
- Azure App Registration Setup
- Docker
- Docker Compose
Optional:
- Kubernetes
- Helm
This service has been integrated into Azure App Registration using the msal-node npm package
By default, authentication is disabled. It can be enabled by setting the AUTHENTICATION_ENABLED environment variable to true
If authentication is enabled, this service needs to be registered with Azure App Registration
The following environment varibles need to be set:
- AZUREID_CLIENT_ID
- AZUREID_TENANT_ID
- AZUREID_CLIENT_SECRET
These can be retrieved from the App Registration overview blade.
The following roles need setting up
- Payments.Holds.Admin
- Payments.Scheme.Admin
For users to access this service, the users need to be assigned to the relevant roles above through Azure Enterprise Applications.
The application is designed to run in containerised environments, using Docker Compose in development and Kubernetes in production.
- A Helm chart is provided for production deployments to Kubernetes.
Container images are built using Docker Compose, with the same images used to run the service with either Docker Compose or Kubernetes.
When using the Docker Compose files in development the local app folder will
be mounted on top of the app folder within the Docker container, hiding the CSS files that were generated during the Docker build. For the site to render correctly locally npm run build must be run on the host system.
By default, the start script will build (or rebuild) images so there will rarely be a need to build images manually. However, this can be achieved through the Docker Compose build command:
# Build container images
docker-compose build
Use Docker Compose to run service locally.
Additional Docker Compose files are provided for scenarios such as linking to other running services.
Link to other services:
docker-compose -f docker-compose.yaml -f docker-compose.link.yaml up
The tests have been structured into subfolders of ./test as per the
Microservice test approach and repository structure
A convenience script is provided to run automated tests in a containerised
environment. This will rebuild images before running tests via docker-compose,
using a combination of docker-compose.yaml and docker-compose.test.yaml.
The command given to docker-compose run may be customised by passing
arguments to the test script.
Examples:
# Run all tests
scripts/test
# Run tests with file watch
scripts/test -w
This service uses the FFC CI pipeline
THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3
The following attribution statement MUST be cited in your products and applications when using this information.
Contains public sector information licensed under the Open Government license v3
The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.
It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.