Update snapshot and/or references of policy/gui to latest snapshots

[policy/gui.git] / README.md

diff --git a/README.md b/README.md
index 17bbf95..26487e9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,41 @@
+# Summary
+
 Copyright 2017-2018 AT&T Intellectual Property. All rights reserved.
+Copyright (C) 2021-2022 Nordix Foundation.
 This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
 Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
 
 This source repository contains the ONAP Policy GUI code.
 
-To build it using Maven 3, run: mvn clean install
+To build it using Maven 3, run: mvn clean install -P docker
+
+
+# Docker image
+
+Maven produces a single docker image containing the policy GUIs.
+These are exposed on the same port (2443) using different URLs:
+- Apex Policy Editor: https://localhost:2443/apex-editor/
+- CLAMP Designer UI: https://localhost:2443/clamp/
+
+## Building
+You can use the following command to build the policy-gui docker image:
+```
+mvn clean install -P docker
+```
+
+## Running
+The gui-server module contains a server that hosts the GUIs.
+There are helper scripts for running the gui-server JAR and Docker image.
+They may be found under gui/gui-server/extra/bin-for-dev/
+
+These scripts assume the clamp backend is running at https://localhost:8443
+
+## Client Credentials
+For integration with AAF, gui-server requests client SSL cert.
+
+A certificate must be added in the browser and is required to log in properly:
+
+[org.onap.clamp.p12 (from clamp master)](URL "https://gerrit.onap.org/r/gitweb?p=clamp.git;a=blob_plain;f=src/main/resources/clds/aaf/org.onap.clamp.p12;hb=refs/heads/master")
+(Password: "China in the Spring")
+
+See onap/clamp repo README for details.