From 8b0523a7acfdfd90122ae8b2fb1225578fa55c50 Mon Sep 17 00:00:00 2001 From: Maximilian Wesener Date: Thu, 25 Jan 2024 10:39:54 +0100 Subject: [PATCH] chore(deployment): 552 updated doc --- .../docs/administration/configuration.adoc | 2 +- .../administration/portal-configuration.adoc | 46 +++++++++++++++++++ 2 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 docs/src/docs/administration/portal-configuration.adoc diff --git a/docs/src/docs/administration/configuration.adoc b/docs/src/docs/administration/configuration.adoc index 35c04df754..e8413e25be 100644 --- a/docs/src/docs/administration/configuration.adoc +++ b/docs/src/docs/administration/configuration.adoc @@ -2,8 +2,8 @@ = Configuration :toc: - include::frontend-configuration.adoc[leveloffset=+1] include::backend-configuration.adoc[leveloffset=+1] +include::portal-configuration.adoc[leveloffset=+1] diff --git a/docs/src/docs/administration/portal-configuration.adoc b/docs/src/docs/administration/portal-configuration.adoc new file mode 100644 index 0000000000..d204926784 --- /dev/null +++ b/docs/src/docs/administration/portal-configuration.adoc @@ -0,0 +1,46 @@ +[#_portal_configuration] += Portal Configuration +//:allow-uri-read: +:icons: font +:icon-set: fas + +The following process is required to successfully connect to the portal: + +== Company Registration +https://portal.int.demo.catena-x.net/documentation[How To] + +=== Additional info +Each instance of trace-x reflects an own company, which is associated with one BPN. + +== User Registration +https://portal.int.demo.catena-x.net/documentation/[How To] + +=== Additional info +The user registration is a self service. Each user can have one or multiple trace-x roles assigned. + +== Connector Registration +https://portal.int.demo.catena-x.net/documentation/[How To] + +=== Additional info +A connector in the context of trace-x is a Eclipse-Dataspace-Connector. This connector needs to be configured by the public controlplane url. + +== App Registration +https://portal.int.demo.catena-x.net/documentation/[How To] + +=== Additional info +A connector in the context of trace-x is a Eclipse-Dataspace-Connector. This connector needs to be configured by the public controlplane url. + +== Create App Subscription +https://portal.int.demo.catena-x.net/documentation/[How To] + +=== Additional info +An app subscription is necessary to be able to setup a frontend url which will be authorized through keycloak and accessible with the portal. + +== Activate App Subscription +https://portal.int.demo.catena-x.net/documentation/[How To] + +=== Additional info +The app subscription needs to be activated from all instances which want to participate in the trace-x use case. + +== Retrieve Wallet Configuration +https://portal.int.demo.catena-x.net/documentation/[How To]