diff --git a/doc/deployment.md b/doc/deployment.md index 48aa4950f66ab2832035d882083496724d291e2e..df703d7c45cd06a954bcd341db50c587f4dbf5be 100644 --- a/doc/deployment.md +++ b/doc/deployment.md @@ -266,27 +266,54 @@ In the folder `org.etsi.osl.tmf.web/src/assets/config` there are 3 files availab The first 2 files above (i.e. config.prod.json, theming.scss) are essential for the successful deployment of OpenSlice, thus created automatically during the initial deployment at `org.etsi.osl.tmf.web/src/assets/config` directory as a copy of the default ones from the remote repository. -Ensure that you check the `config.prod.json` file and readjust to your deployment if needed. +Ensure that you check the `config.prod.json` and `theming.scss` files and readjust to your deployment if needed. ```bash # Starting from the root project directory cd org.etsi.osl.tmf.web/src/assets/config ``` -```bash -sudo cp config.theming.default.json config.theming.json -``` -E.g. Edit "TITLE" or "WIKI" property with your domain title +E.g. Edit "TITLE", "WIKI", etc properties with your domain title. Also configure TMF's API and Keycloak's location for the web application, if needed. + + ``` -{ - TITLE: "OpenSlice by ETSI", - WIKI: "https://osl.etsi.org/documentation/latest/deployment/", +{ + "TITLE": "OpenSlice by ETSI", + "PORTALVERSION":"2024-Q2 1.0.0-SNAPSHOT", + "WIKI": "https://osl.etsi.org/documentation", + "BUGZILLA": "{BASEURL}/bugzilla/", + "STATUS": "http://status.localhost/", + "WEBURL": "{BASEURL}", + "PORTAL_REPO_APIURL": "{BASEURL}/osapi", + "ASSURANCE_SERVICE_MGMT_APIURL": "{BASEURL}/oas-api", + "APITMFURL": "{BASEURL}/tmf-api", + "OAUTH_CONFIG" : { + "issuer": "{BASEURL}/auth/realms/openslice", + "loginUrl": "{BASEURL}/auth/realms/openslice/protocol/openid-connect/auth", + "tokenEndpoint": "{BASEURL}/auth/realms/openslice/protocol/openid-connect/token", + "userinfoEndpoint": "{BASEURL}/auth/realms/openslice/protocol/openid-connect/userinfo", + "redirectUri": "{BASEURL}/redirect", + "logoutUrl": "{BASEURL}/auth/realms/openslice/protocol/openid-connect/logout", + "postLogoutRedirectUri": "{BASEURL}", + + "responseType": "code", + "oidc": false, + "clientId": "osapiWebClientId", + "dummyClientSecret": "secret", + + "requireHttps": false, + "useHttpBasicAuth": true, + "clearHashAfterLogin": false, + + "showDebugInformation": true + } } ``` + > The {BASEURL} placeholder in the file automatically detects the Origin (Protocol://Domain:Port) of the deployment and applies it to every respective property. E.g. If you are attempting a local deployment of Openslice, then {BASEURL} is automatically translated to "http://localhost". Similarly, you may use {BASEURL} to translate to a public deployment configuration, e.g. "https://portal.openslice.io". -If further customization, apart from the default provided, is needed for branding (Logo, Footer) then config.theming.json needs to be created in io.openslice.tmf.web/src/assets/config directory, as follows: +If further customization, apart from the default provided, is needed for branding (Logo, Footer) then `config.theming.json` needs to be created in io.openslice.tmf.web/src/assets/config directory, as follows: ```bash # Starting from the root project directory