Deployed 168923df to release0 in public with MkDocs 1.5.3 and mike 2.0.0

    </span>

  </a>

</li>

          <li class="md-nav__item">

  <a href="#6-osscapi-container-tmf-api-service-conditional" class="md-nav__link">

    <span class="md-ellipsis">

      6. osscapi container (TMF API service) (conditional)

    </span>

  </a>

</li>

      </ul>

    </nav>

</li>

        <li class="md-nav__item">

  <a href="#configure-nginx" class="md-nav__link">

    <span class="md-ellipsis">

      Configure nginx

    </span>

  </a>

</li>

        <li class="md-nav__item">

    </span>

  </a>

</li>

          <li class="md-nav__item">

  <a href="#6-osscapi-container-tmf-api-service-conditional" class="md-nav__link">

    <span class="md-ellipsis">

      6. osscapi container (TMF API service) (conditional)

    </span>

  </a>

</li>

      </ul>

    </nav>

</li>

        <li class="md-nav__item">

  <a href="#configure-nginx" class="md-nav__link">

    <span class="md-ellipsis">

      Configure nginx

    </span>

  </a>

</li>

        <li class="md-nav__item">

<h3 id="2-configure-mysql-portal-container-optional">2. Configure mysql-portal container <em>(optional)</em></h3>

<ol>

<li>In folder <code>org.etsi.osl.main/compose/mysql-init</code> edit the file <code>01-databases.sql</code>.</li>

<li>In the <code>org.etsi.osl.main/compose/docker-compose.yaml</code> edit the credentials of the users that services use to connect to the databases, if you wish.</li>

<li>In the <code>org.etsi.osl.main/compose/docker-compose.yaml</code> edit the credentials of the users that services use to connect to the databases, if you wish.<ul>

<li>portaluser (default is 12345) and</li>

<li>keycloak (default is password)</li>

</ul>

</li>

</ol>

<h3 id="3-configure-keycloak-container-optional">3. Configure keycloak container <em>(optional)</em></h3>

<ol>

<li>If you made changes to keycloak's mysql credentials:</li>

</ol>

<li>

<p>If you made changes to keycloak's mysql credentials:</p>

<p>In folder <code>org.etsi.osl.main/compose/</code> edit the file <code>docker-compose.yaml</code>.</p>

<pre><code>```yaml

DB_DATABASE: keycloak

<p><code>DB_DATABASE: keycloak

 DB_USER: keycloak

DB_PASSWORD: password

```

</code></pre>

<ol>

<li>If you want to change the keycloak admin password:</li>

</ol>

 DB_PASSWORD: password</code></p>

</li>

<li>

<p>If you want to change the keycloak admin password:</p>

<p>In folder <code>org.etsi.osl.main/compose/</code> edit the file <code>docker-compose.yaml</code></p>

<p><code>yaml

   KEYCLOAK_PASSWORD: Pa55w0rd</code></p>

<p><code>KEYCLOAK_PASSWORD: Pa55w0rd</code></p>

</li>

</ol>

<h3 id="4-configure-bugzilla-container-optional">4. Configure bugzilla container <em>(optional)</em></h3>

<p>If you want to utilise the Bugzilla connector:</p>

<p>In folder <code>org.etsi.osl.main/compose/</code> edit the file <code>docker-compose.yaml</code>

  <code>yaml

  SPRING_APPLICATION_JSON: '{

        "spring.activemq.brokerUrl": "tcp://anartemis:61616?jms.watchTopicAdvisories=false",

        "spring.activemq.user": "artemis",

        "spring.activemq.password": "artemis",

        "bugzillaurl":"",

        "bugzillakey":"",

        "main_operations_product":""

      }'</code>

And add the provided Bugzilla installation information:</p>

<pre><code class="language-yaml">&quot;bugzillaurl&quot;:&quot;bugzillaurl.xx:443/bugzilla/&quot;,

<p>In folder <code>org.etsi.osl.main/compose/</code> edit the file <code>docker-compose.yaml</code></p>

<pre><code>SPRING_APPLICATION_JSON: '{

  "spring.activemq.brokerUrl": "tcp://anartemis:61616?jms.watchTopicAdvisories=false",

  "spring.activemq.user": "artemis",

  "spring.activemq.password": "artemis",

  "bugzillaurl":"",

  "bugzillakey":"",

  "main_operations_product":""

}'

</code></pre>

<p>And add the provided Bugzilla installation information:</p>

<pre><code>&quot;bugzillaurl&quot;:&quot;bugzillaurl.xx:443/bugzilla/&quot;,

"bugzillakey":"exampleKeyeqNNwxBlgxZgMEIne0Oeq0Bz",

"main_operations_product":"Main Site Operations" // this is the default product to issue tickets

</code></pre>

<li>If you want to change logging level (TRACE / DEBUG / INFO / WARN / ERROR).</li>

</ul>

<blockquote>

<p><strong>If you are using a non-local domain, replace everywhere the http://keycloak:8080 with the respective {{protocol://domain.name}}, as well as "spring.portal.main.domain" property.</strong></p>

</blockquote>

<p>In folder <code>org.etsi.osl.main/compose/</code> edit the file <code>docker-compose.yaml</code>

  <code>yaml

    SPRING_APPLICATION_JSON: '{

        "spring.datasource.username":"root",

        "spring.datasource.password":"letmein",

        "spring-addons.issuers[0].uri": "http://keycloak:8080/auth/realms/openslice",

        "spring.security.oauth2.resourceserver.jwt.issuer-uri": "http://keycloak:8080/auth/realms/openslice",

        "springdoc.oAuthFlow.authorizationUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth",

        "springdoc.oAuthFlow.tokenUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token",  

        "spring.portal.main.domain": "http://localhost",

        "logging.level.org.springframework" : "INFO"

      }'</code></p>

<h3 id="6-osscapi-container-tmf-api-service-conditional">6. osscapi container (TMF API service) <em>(conditional)</em></h3>

<p>Change the respective fields: </p>

<ul>

<li>If you made changes to mysql and keycloak credentials.</li>

<li>If you want to change logging level (TRACE / DEBUG / INFO / WARN / ERROR).</li>

</ul>

<blockquote>

<p><strong>If you are using a non-local domain, replace everywhere the http://keycloak:8080 with the respective {{protocol://domain.name}}.</strong></p>

<p><strong><em>If you are using a non-local domain, replace everywhere the http://keycloak:8080 with the respective {{protocol://domain.name}}, as well as "spring.portal.main.domain" property.</em></strong></p>

</blockquote>

<p>In folder <code>org.etsi.osl.main/compose/</code> edit the file <code>docker-compose.yaml</code></p>

<pre><code class="language-yaml">    SPRING_APPLICATION_JSON: '{

<pre><code>SPRING_APPLICATION_JSON: '{

  "spring.datasource.username":"root",

  "spring.datasource.password":"letmein",

  "spring-addons.issuers[0].uri": "http://keycloak:8080/auth/realms/openslice",

  "spring.security.oauth2.resourceserver.jwt.issuer-uri": "http://keycloak:8080/auth/realms/openslice",

  "springdoc.oAuthFlow.authorizationUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth",

  "springdoc.oAuthFlow.tokenUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token",  

  "spring.portal.main.domain": "http://localhost",

  "logging.level.org.springframework" : "INFO"

}'

  ```

### 6. osscapi container (TMF API service) *(conditional)*

Change the respective fields: 

- If you made changes to mysql and keycloak credentials.

- If you want to change logging level (TRACE / DEBUG / INFO / WARN / ERROR).

> **If you are using a non-local domain, replace everywhere the http://keycloak:8080 with the respective {{protocol://domain.name}}.**

In folder `org.etsi.osl.main/compose/` edit the file `docker-compose.yaml`

</code></pre>

<h2 id="configure-nginx">Configure nginx</h2>

<p>In folder <code>org.etsi.osl.main/compose/nginx</code> create a configuration specific <code>nginx.conf</code> file.</p>

<pre><code class="language-bash">cd org.etsi.osl.main/compose/nginx/

<p>SPRING_APPLICATION_JSON: '{

  "spring.datasource.username":"root",

  "spring.datasource.password":"letmein",

  "spring-addons.issuers[0].uri": "http://keycloak:8080/auth/realms/openslice",

  "spring.security.oauth2.resourceserver.jwt.issuer-uri": "http://keycloak:8080/auth/realms/openslice",

  "springdoc.oAuthFlow.authorizationUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth",

  "springdoc.oAuthFlow.tokenUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token",<br />

  "logging.level.org.springframework" : "INFO"

}'</p>

<pre><code>

## Configure nginx

In folder `org.etsi.osl.main/compose/nginx` create a configuration specific `nginx.conf` file.

```bash

cd org.etsi.osl.main/compose/nginx/

</code></pre>

<pre><code class="language-bash">sudo cp nginx.conf.default nginx.conf

</code></pre>

<pre><code class="language-bash">sudo cp config.js.default config.js

</code></pre>

<p>Edit the <code>config.js</code> file with the information of your domain</p>

<pre><code class="language-yaml">{     

<pre><code>{     

    TITLE: "OpenSlice by ETSI",

    WIKI: "https://openslice.readthedocs.io/en/stable/",

    BUGZILLA: "ROOTURL/bugzilla/",

<pre><code class="language-bash">sudo cp config.theming.default.json config.theming.json

</code></pre>

<p>E.g. Edit "TITLE" or "WIKI" property with your domain title</p>

<pre><code class="language-yaml">{     

<pre><code>{     

    TITLE: "OpenSlice by ETSI",

    WIKI: "https://osl.etsi.org/documentation/latest/deployment/",

}

</code></pre>

<blockquote>

<p><strong><em>IMPORTANT NOTE:</em></strong>

If you want to apply changes to the JSON configuration files without the need to rebuild the

application, you have to apply the changes at the <code>org.etsi.osl.tmf.web/dist/io-openslice-portal-web/assets/config</code> 

directory. Although, it is <u>mandatory</u> to also apply these changes to the <code>org.etsi.osl.tmf.web/src/assets/config</code>

for <u>persistancy</u>, as after any future rebuild of OpenSlice the <code>/dist</code> directory is being overwritten along with its

contents. The OpenSlice team strongly recommends to always apply your changes to the TMF web UI configuration files

at <code>org.etsi.osl.tmf.web/src/assets/config</code> and rebuild the application.</p>

If you want to apply changes to the JSON configuration files without the need to rebuild the application, you have to apply the changes at the <code>org.etsi.osl.tmf.web/dist/io-openslice-portal-web/assets/config</code> directory. Although, it is <u>mandatory</u> to also apply these changes to the <code>org.etsi.osl.tmf.web/src/assets/config</code> for <u>persistancy</u>, as after any future rebuild of OpenSlice the <code>/dist</code> directory is being overwritten along with its contents. The OpenSlice team strongly recommends to always apply your changes to the TMF web UI configuration files at <code>org.etsi.osl.tmf.web/src/assets/config</code> and rebuild the application.</p>

</blockquote>

<h2 id="deploy-openslice-via-docker-compose">Deploy OpenSlice via Docker Compose</h2>

<p>After configuring the services, and editing the docker compose file accordingly, the docker compose instantiation command can be performed.</p>

</li>

<li>

<p>Login with the credentials from section <a href="#Configure-keycloak-container">Configure keycloak container</a>. Default values are:</p>

</li>

<ul>

<li>user: admin and </li>

<li>password: KEYCLOAK_PASSWORD</li>

</ul>

</li>

</ul>

<blockquote>

<p>if you are running in HTTP you will get a message: HTTPS required.</p>

</blockquote>

</li>

</ul>

<p>2 - Replace http://localhost/auth/ with http://keycloak:8080/auth/ in your Keycloak config for AngularJS and Angular (see examples below).</p>

<p>Explanation:</p>

<pre><code>Nginx uses the http://keycloak:8080 URL, which is accessible via the internal docker system's network.

<blockquote>

<p>Explanation</p>

</blockquote>

<p>Nginx uses the http://keycloak:8080 URL, which is accessible via the internal docker system's network.

The Front-end (TS/Angular) shall also use the http://keycloak:8080.

This way, you will not get the invalid token error, as the API is acquiring the token from http://keycloak:8080 (internally) and the Front-end is getting verified by an issuer at the same URL, as well.

</code></pre>

This way, you will not get the invalid token error, as the API is acquiring the token from http://keycloak:8080 (internally) and the Front-end is getting verified by an issuer at the same URL, as well.</p>

<ul>

<li>For the Angular configuration (TMF portal UI), navigate to  org.etsi.osl.tmf.web/src/assets/config and edit config.prod.json

   <code>bash

   # Starting from the root project directory

   cd org.etsi.osl.tmf.web/src/assets/config</code>

   <code>bash

   nano config.prod.json</code></li>

<li>For the Angular configuration (TMF portal UI), navigate to  org.etsi.osl.tmf.web/src/assets/config and edit config.prod.json</li>

</ul>

<p>After editing it should look like the example bellow:

   ```yaml

<p><code>bash

   # Starting from the root project directory

   cd org.etsi.osl.tmf.web/src/assets/config</code></p>

<p><code>bash

   nano config.prod.json</code></p>

<p>After editing it should look like the example bellow:</p>

<p>```yaml

   {        <br />

      "TITLE": "OpenSlice by ETSI",

      "PORTALVERSION":"2023-Q3 1.2.0-SNAPSHOT",

<p>If you want the changes to take place immediately without rebuilding the project, then repeat the process for org.etsi.osl.tmf.web/dist/org.etsi.osl.tmf.web/assets/config/config.prod.json</p>

</blockquote>

<ul>

<li>For the AngularJS configuration (NVF portal UI), navigate to org.etsi.osl.portal.web/src/js and edit config.js

   <code>bash

   # Starting from the root project directory

   cd org.etsi.osl.portal.web/src/js</code>

   <code>bash

   nano config.js</code>

   after editing it should look like the example bellow:</li>

<li>For the AngularJS configuration (NVF portal UI), navigate to org.etsi.osl.portal.web/src/js and edit config.js</li>

</ul>

<p>```js

<p><code>bash

   # Starting from the root project directory

   cd org.etsi.osl.portal.web/src/js</code></p>

<p><code>bash

   nano config.js</code></p>

<p>after editing it should look like the example bellow:</p>

<p>```

   var appConfig = angular.module('portalwebapp.config',[]);</p>

<p>appConfig.factory('APIEndPointService', function() {

      return {      <br />