Skip to content

Latest commit

 

History

History
157 lines (103 loc) · 10.4 KB

README.md

File metadata and controls

157 lines (103 loc) · 10.4 KB
Raw

Admin Portal UI

The Admin Portal UI (admin-portal-ui) is an administrative user interface component of Consent2Share (C2S) used to create and manage patient accounts. Administrative staff can use this to log in, visit their home page, create patient accounts, and manage patient information.

Build

Prerequisites

Structure

There are two main modules in this project:

  • client: This folder contains all frontend user interface code which is written using Angular v1.5.
  • server: This folder contains a Spring Boot project, which is primarily responsible for packaging and serving the static resources that are built from the client module. This is also an Apache Maven project and utilizes Frontend Maven Plugin to:
    1. locally install Node.js and the client module Node.js dependencies;
    2. build the client module using locally installed Grunt Node.js package. Finally, it uses Apache Maven Resources Plugin to copy the resources that are built from the client module into the server module that will be eventually packaged as a build artifact in jar format. Therefore, there is no need to install Node.js or Grunt globally if server module is built with Maven.

Commands

This Maven project requires Apache Maven 3.3.3 or greater to build it. It is recommended to use the Maven Wrapper scripts provided with this project. Maven Wrapper requires an internet connection to download Maven and project dependencies for the very first build.

To build the project, navigate to the folder that contains pom.xml file using the terminal/command line.

  • To build a JAR:
    • For Windows, run mvnw.cmd clean install
    • For *nix systems, run mvnw clean install
  • To build a Docker Image (this will create an image with bhits/admin-portal-ui:latest tag):
    • For Windows, run mvnw.cmd clean package docker:build
    • For *nix systems, run mvnw clean package docker:build

Note: Frontend developers can build client and server modules separately and save build time by skipping the full Grunt build when not needed. This option requires Grunt to be installed globally.

  1. Build the client module: run grunt build:dist in the client folder
  2. Start Grunt watch task to monitor the changes in the client module: run grunt watch in the client folder
  3. Manually repackage the jar file from the server module when Grunt watch re-compiles a resource: run mvnw.cmd clean install -PskipGrunt in the server folder

Run

Commands

This is a Spring Boot project and serves the project via an embedded Tomcat instance. Therefore there is no need for a separate application server to run it.

  • Run as a JAR file: java -jar admin-portal-ui-x.x.x-SNAPSHOT.jar <additional program arguments>
  • Run as a Docker Container: docker run -d bhits/admin-portal-ui:latest <additional program arguments>

NOTE: In order for this application to fully function as a microservice in C2S application, it is also required to setup the dependency microservices and support level infrastructure. Please refer to the Consent2Share Deployment Guide for instructions to setup the C2S infrastructure.

Debug TypeScript

TypeScript is used to write code in Angular 2. The default build task in the client module only generates JavaScript files without source maps when transpiling TypeScript.

In order to debug TypeScript, we need source maps to be generated as well:

  1. Run Grunt build debug task in the client module to generate source maps along with transpiled JavaScript: run grunt build:debug in the client folder
  2. Run the application and use browser development tools to set breakpoints in related TypeScript files to start debugging.

NOTE: The source maps set correspondence between lines in the TypeScript code and in the generated JavaScript code.

Configure

This API utilizes Configuration Server which is based on Spring Cloud Config to manage externalized configuration, which is stored in a Configuration Data Git Repository. We provide a Default Configuration Data Git Repository.

The server module runs with the default configuration, which is targeted for a local development environment. Default configuration data is from three places: bootstrap.yml, application.yml, and the data which Configuration Server reads from Configuration Data Git Repository. Both bootstrap.yml and application.yml files are located in the resources folder of this source code.

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

Also, please refer to Spring Cloud Config Documentation to see how the config server works, Spring Boot Externalized Configuration documentation to see how Spring Boot applies the order to load the properties, and Spring Boot Common Properties documentation to see the common properties used by Spring Boot.

Examples for Overriding a Configuration in Spring Boot

Override a Configuration Using Program Arguments While Running as a JAR:

  • java -jar admin-portal-ui-x.x.x-SNAPSHOT.jar --c2s.admin-ui.oauth2.client.secret=strongpassword

NOTE: The oauth2.client.client-id and oauth2.client.secret value are used for User Account and Authentication (UAA) Password Grant type. The configuration uses the format client_id:client_secret to be Base 64 encoded. The client_id refers to the OAuth2 Client ID assigned to the Admin Portal UI by UAA. C2S uses admin-portal-ui as the default client_id for this application.

Override a Configuration Using Program Arguments While Running as a Docker Container:

  • docker run -d bhits/admin-portal-ui:latest --c2s.admin-ui.oauth2.client.secret=strongpassword

  • In a docker-compose.yml, this can be provided as:

version: '2'
services:
...
  admin-portal-ui.c2s.com:
    image: "bhits/admin-portal-ui:latest"
    command: ["--c2s.admin-ui.oauth2.client.secret=strongpassword"]
...

NOTE:

  • Please note that these additional arguments will be appended to the default ENTRYPOINT specified in the Dockerfile unless the ENTRYPOINT is overridden.
  • The Admin Portal UI uses HTML5 mode for the URL format in the browser address bar and it also uses /fe as the base for all Angular routes. Therefore, the server component forwards all paths that starts with /fe to root. In the AdminUIApplication.java:
...
  @RequestMapping(value = "/fe/**")
      public String redirect() {
          return "forward:/";
      }
...

Enable SSL

For simplicity in development and testing environments, SSL is NOT enabled by default configuration. SSL can easily be enabled following the examples below:

Enable SSL While Running as a JAR

  • java -jar admin-portal-ui-x.x.x-SNAPSHOT.jar --spring.profiles.active=ssl --server.ssl.key-store=/path/to/ssl_keystore.keystore --server.ssl.key-store-password=strongkeystorepassword

Enable SSL While Running as a Docker Container

  • docker run -d -v "/path/on/dockerhost/ssl_keystore.keystore:/path/to/ssl_keystore.keystore" bhits/admin-portal-ui:latest --spring.profiles.active=ssl --server.ssl.key-store=/path/to/ssl_keystore.keystore --server.ssl.key-store-password=strongkeystorepassword
  • In the docker-compose.yml, this can be provided as:
...
  admin-ui.c2s.com:
    image: "bhits/admin-portal-ui:latest"
    command: ["--spring.profiles.active=ssl","--server.ssl.key-store=/path/to/ssl_keystore.keystore", "--server.ssl.key-store-password=strongkeystorepassword"]
    volumes:
      - /path/on/dockerhost/ssl_keystore.keystore:/path/to/ssl_keystore.keystore
...

NOTE: As seen in the examples above, /path/to/ssl_keystore.keystore is made available to the container via a volume mounted from the Docker host running this container.

Override Java CA Certificates Store In Docker Environment

Java has a default CA Certificates Store that allows it to trust well-known certificate authorities. For development and testing purposes, one might want to trust additional self-signed certificates. In order to override the default Java CA Certificates Store in Docker container, one can mount a custom cacerts file over the default one in the Docker image as follows: docker run -d -v "/path/on/dockerhost/to/custom/cacerts:/etc/ssl/certs/java/cacerts" bhits/admin-portal-ui:latest

NOTE: The cacerts references given in the both sides of volume mapping above are files, not directories.

License

View license information for the software contained in this repository.

Contact

If you have any questions, comments, or concerns please see Consent2Share page

Report Issues

Please use GitHub Issues page to report issues.