Document Management is a backend service to store and retrieve documents.
It uses:
- Java8
- Spring boot
- Junit, Mockito and SpringBootTest and Powermockito
- Gradle
- lombok project - Lombok project
- lombok plugin - Lombok IDEA plugin
The following environment variables are required:
| Name | Default | Description |
|---|---|---|
| IDAM_USER_BASE_URI | - | Base URL for IdAM's User API service (idam-app). http://localhost:4501 for the dockerised local instance or tunneled dev instance. |
| IDAM_S2S_BASE_URI | - | Base URL for IdAM's S2S API service (service-auth-provider). http://localhost:4502 for the dockerised local instance or tunneled dev instance. |
| MAX_FILE_SIZE | 100MB | Max file size |
Note: The MAX_FILE_SIZE enforces limit on the document upload in the document management backend service. Additionally, the max request content length (including file sizes) need to be configured for the IIS web server (on Azure) via maxAllowedContentLength property for request filter in web.config (config file within source repository).
# Get the connection string for Azure Blob Store and put it in place of getOneFromPortalAzure in application.yaml
# Do not commit it!!!
azure:
storage:
connection-string: ${STORAGEACCOUNT_PRIMARY_CONNECTION_STRING:getOneFromPortalAzure}# Cloning repo and running though docker
git clone https://github.com/hmcts/document-management-store-app.git
cd document-management-store-app/
./buildrundm-docker.sh# Run this script to aquire IDAM credentials required for DM API.
./idam.shThere is currently a Java Client available here: https://github.com/hmcts/document-management-client
To view our REST API go to {HOST}:{PORT}/swagger-ui.html
A list of our endpoints can be found here