- java -cp config:target/ric-dash-be-1.2.0-SNAPSHOT.jar \
- -Dloader.main=org.oransc.ric.portal.dashboard.DashboardApplication \
- org.springframework.boot.loader.PropertiesLauncher
+On-Board Dashboard to ONAP Portal
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When on-boarding the Dashboard to the ONAP Portal the administrator
+must supply the following information about the deployed instance:
+
+- Dashboard URL that is reachable by a user's browser. The domain of
+ this host name must match the Portal URL that is similarly reachable
+ by a user's browser for cookie-based authentication to function as
+ expected. This should be a value like
+ ``http://dashboard.simpledemo.onap.org:8080``
+- Dashboard REST URL that is reachable by the Portal back-end server.
+ This can be a host name or an IP address, because it does not use
+ cookie-based authentication. This must be a URL with suffix "/api/v3"
+ for example ``http://192.168.1.1:8080/api/v3``.
+
+The Dashboard server only listens on a single port, so the examples
+above both use the same port number. Different port numbers might be
+required if an ingress controller or other proxy server is used.
+
+After the on-boarding process is complete, the administrator must
+enter values from the Portal for the following properties explained
+above:
+
+- ``portalapi.password``
+- ``portalapi.username``
+- ``ueb_app_key``
+
+Launch Server
+^^^^^^^^^^^^^