bhits/c2s-ui-api repository overview

⁠Supported Source Code Tags and Current Dockerfile Link

0.1.0 (latest)⁠

Current Dockerfile⁠

For more information about this image, the source code, and its history, please see the GitHub repository⁠.

⁠What is C2S-UI-API?

The Consent2Share User Interface API (c2s-ui-api) is a Backend For Frontends(BFF) component of Consent2Share (C2S)

For more information and related downloads for Consent2Share, please visit Consent2Share⁠.

⁠How to Use This Image

⁠Start a C2S-UI-API Instance

Be sure to familiarize yourself with the repository's README.md⁠ file before starting the instance.

docker run --name c2s-ui-api -d bhits/c2s-ui-api:latest <additional program arguments>

NOTE: In order for this project to fully function as a microservice in the Consent2Share application, it is required to setup the dependency microservices and the support level infrastructure. Please refer to the Consent2Share Deployment Guide in the corresponding Consent2Share release (see Consent2Share Releases Page⁠) for instructions to setup the Consent2Share infrastructure.

⁠Configure

The Spring profiles application-default and docker are activated by default when building images.

This project can run with the default configuration which is from three places: bootstrap.yml, application.yml, and the data which the Configuration Server⁠ reads from the Configuration Data Git Repository. Both bootstrap.yml and application.yml files are located in the class path of the running application.

We recommend overriding the configuration as needed in the Configuration Data Git Repository, which is used by the Configuration Server.

Also, Spring Boot⁠ supports other ways to override the default configuration to configure the project for a certain deployment environment.

The following is an example to override the default database password:

docker run -d bhits/c2s-ui-api:latest --spring.datasource.password=strongpassword

⁠Environment Variables

When you start the C2S-UI-API image, you can edit the configuration of the C2S-UI-API instance by passing one or more environment variables on the command line.

⁠JAR_FILE

This environment variable is used to setup which jar file will run. You need to mount the jar file to the root of container.

docker run --name c2s-ui-api -e JAR_FILE="c2s-ui-api-latest.jar" -v "/path/on/dockerhost/c2s-ui-api-latest.jar:/c2s-ui-api-latest.jar" -d bhits/c2s-ui-api:latest

⁠JAVA_OPTS

This environment variable is used to setup a JVM argument, such as memory configuration.

docker run --name c2s-ui-api -e "JAVA_OPTS=-Xms512m -Xmx700m -Xss1m" -d bhits/c2s-ui-api:latest

⁠DEFAULT_PROGRAM_ARGS

This environment variable is used to setup an application argument. The default value is: "--spring.profiles.active=application-default, docker".

docker run --name c2s-ui-api -e DEFAULT_PROGRAM_ARGS="--spring.profiles.active=application-default,ssl,docker" -d bhits/c2s-ui-api:latest

⁠Supported Docker Versions

This image is officially supported on Docker version 1.13.0.

Support for older versions (down to 1.6) is provided on a best-effort basis.

Please see the Docker installation documentation⁠ for details on how to upgrade your Docker daemon.

⁠License

View license⁠ information for the software contained in this image.

⁠User Feedback

⁠Documentation

Documentation for this image is stored in the bhits/c2s-ui-api⁠ GitHub repository. Be sure to familiarize yourself with the repository's README.md file before attempting a pull request.

⁠Issues

If you have any problems with or questions about this image, please contact us through a GitHub issue⁠.