Commit 9996aea7 authored by Dimitrios Giannopoulos's avatar Dimitrios Giannopoulos
Browse files

Deployed 918a8622 to release0 in public with MkDocs 1.5.3 and mike 2.0.0

parent 1a7a8250
Loading
Loading
Loading
Loading
+33 −8
Original line number Original line Diff line number Diff line
@@ -1741,22 +1741,47 @@ DB_PASSWORD: password
<li>config.theming.json (HTML configuration - Logo, Favicon, Footer)</li>
<li>config.theming.json (HTML configuration - Logo, Favicon, Footer)</li>
</ul>
</ul>
<p>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 <code>org.etsi.osl.tmf.web/src/assets/config</code> directory as a copy of the default ones from the remote repository.</p>
<p>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 <code>org.etsi.osl.tmf.web/src/assets/config</code> directory as a copy of the default ones from the remote repository.</p>
<p>Ensure that you check the <code>config.prod.json</code> file and readjust to your deployment if needed.</p>
<p>Ensure that you check the <code>config.prod.json</code> and <code>theming.scss</code> files and readjust to your deployment if needed.</p>
<pre><code class="language-bash"># Starting from the root project directory
<pre><code class="language-bash"># Starting from the root project directory
cd org.etsi.osl.tmf.web/src/assets/config
cd org.etsi.osl.tmf.web/src/assets/config
</code></pre>
</code></pre>
<pre><code class="language-bash">sudo cp config.theming.default.json config.theming.json
<p>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.</p>
</code></pre>
<p>E.g. Edit "TITLE" or "WIKI" property with your domain title</p>
<pre><code>{         
<pre><code>{         
  TITLE: &quot;OpenSlice by ETSI&quot;,
    &quot;TITLE&quot;: &quot;OpenSlice by ETSI&quot;,
  WIKI: &quot;https://osl.etsi.org/documentation/latest/deployment/&quot;,
    &quot;PORTALVERSION&quot;:&quot;2024-Q2 1.0.0-SNAPSHOT&quot;,
    &quot;WIKI&quot;: &quot;https://osl.etsi.org/documentation&quot;,
    &quot;BUGZILLA&quot;: &quot;{BASEURL}/bugzilla/&quot;,
    &quot;STATUS&quot;: &quot;http://status.localhost/&quot;,
    &quot;WEBURL&quot;: &quot;{BASEURL}&quot;,
    &quot;PORTAL_REPO_APIURL&quot;: &quot;{BASEURL}/osapi&quot;,
    &quot;ASSURANCE_SERVICE_MGMT_APIURL&quot;: &quot;{BASEURL}/oas-api&quot;,
    &quot;APITMFURL&quot;: &quot;{BASEURL}/tmf-api&quot;,
    &quot;OAUTH_CONFIG&quot; : {
        &quot;issuer&quot;: &quot;{BASEURL}/auth/realms/openslice&quot;,
        &quot;loginUrl&quot;: &quot;{BASEURL}/auth/realms/openslice/protocol/openid-connect/auth&quot;,
        &quot;tokenEndpoint&quot;: &quot;{BASEURL}/auth/realms/openslice/protocol/openid-connect/token&quot;,
        &quot;userinfoEndpoint&quot;: &quot;{BASEURL}/auth/realms/openslice/protocol/openid-connect/userinfo&quot;,
        &quot;redirectUri&quot;: &quot;{BASEURL}/redirect&quot;,
        &quot;logoutUrl&quot;: &quot;{BASEURL}/auth/realms/openslice/protocol/openid-connect/logout&quot;, 
        &quot;postLogoutRedirectUri&quot;: &quot;{BASEURL}&quot;,

        &quot;responseType&quot;: &quot;code&quot;,
        &quot;oidc&quot;: false,
        &quot;clientId&quot;: &quot;osapiWebClientId&quot;,
        &quot;dummyClientSecret&quot;: &quot;secret&quot;,

        &quot;requireHttps&quot;: false,
        &quot;useHttpBasicAuth&quot;: true,
        &quot;clearHashAfterLogin&quot;: false,

        &quot;showDebugInformation&quot;: true
    }
}
}
</code></pre>
</code></pre>
<blockquote>
<blockquote>
<p>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".</p>
<p>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".</p>
</blockquote>
</blockquote>
<p>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:</p>
<p>If further customization, apart from the default provided, is needed for branding (Logo, Footer) then <code>config.theming.json</code> needs to be created in io.openslice.tmf.web/src/assets/config directory, as follows:</p>
<pre><code class="language-bash"># Starting from the root project directory
<pre><code class="language-bash"># Starting from the root project directory
cd org.etsi.osl.tmf.web/src/assets/config
cd org.etsi.osl.tmf.web/src/assets/config
</code></pre>
</code></pre>
+1 −1

File changed.

Preview size limit exceeded, changes collapsed.

(397 B)

File changed.

No diff preview for this file type.