Commit 168923df authored by Kostis Trantzas's avatar Kostis Trantzas
Browse files

Changed indentation in text to display properly

parent 1f017d0b
Loading
Loading
Loading
Loading
Loading
+67 −60
Original line number Diff line number Diff line
@@ -114,7 +114,7 @@ sudo cp docker-compose.yaml.configure docker-compose.yaml

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

    ```yaml
     ```
     DB_DATABASE: keycloak
     DB_USER: keycloak
     DB_PASSWORD: password
@@ -124,7 +124,8 @@ sudo cp docker-compose.yaml.configure docker-compose.yaml

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

   ```yaml

    ```
    KEYCLOAK_PASSWORD: Pa55w0rd
    ```

@@ -133,7 +134,8 @@ sudo cp docker-compose.yaml.configure docker-compose.yaml
If you want to utilise the Bugzilla connector:

In folder `org.etsi.osl.main/compose/` edit the file `docker-compose.yaml`
  ```yaml
  
```
SPRING_APPLICATION_JSON: '{
  "spring.activemq.brokerUrl": "tcp://anartemis:61616?jms.watchTopicAdvisories=false",
  "spring.activemq.user": "artemis",
@@ -143,8 +145,10 @@ In folder `org.etsi.osl.main/compose/` edit the file `docker-compose.yaml`
  "main_operations_product":""
}'
```

And add the provided Bugzilla installation information:
```yaml

```
"bugzillaurl":"bugzillaurl.xx:443/bugzilla/",
"bugzillakey":"exampleKeyeqNNwxBlgxZgMEIne0Oeq0Bz",
"main_operations_product":"Main Site Operations" // this is the default product to issue tickets
@@ -166,10 +170,11 @@ 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}}, as well as "spring.portal.main.domain" property.**
> ***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.***

In folder `org.etsi.osl.main/compose/` edit the file `docker-compose.yaml`
  ```yaml
  
```
SPRING_APPLICATION_JSON: '{
  "spring.datasource.username":"root",
  "spring.datasource.password":"letmein",
@@ -192,7 +197,8 @@ Change the respective fields:
> **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`
```yaml

```
SPRING_APPLICATION_JSON: '{
  "spring.datasource.username":"root",
  "spring.datasource.password":"letmein",
@@ -232,7 +238,7 @@ sudo cp config.js.default config.js
Edit the `config.js` file with the information of your domain


```yaml
```
{	  
    TITLE: "OpenSlice by ETSI",
    WIKI: "https://openslice.readthedocs.io/en/stable/",
@@ -267,7 +273,7 @@ sudo cp config.theming.default.json config.theming.json
```

E.g. Edit "TITLE" or "WIKI" property with your domain title
```yaml
```
{	  
    TITLE: "OpenSlice by ETSI",
    WIKI: "https://osl.etsi.org/documentation/latest/deployment/",
@@ -287,12 +293,7 @@ sudo cp config.theming.default.json config.theming.json
```

> ***IMPORTANT NOTE:***
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 `org.etsi.osl.tmf.web/dist/io-openslice-portal-web/assets/config` 
directory. Although, it is <u>mandatory</u> to also apply these changes to the `org.etsi.osl.tmf.web/src/assets/config`
for <u>persistancy</u>, as after any future rebuild of OpenSlice the `/dist` 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 `org.etsi.osl.tmf.web/src/assets/config` and rebuild the application.
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 `org.etsi.osl.tmf.web/dist/io-openslice-portal-web/assets/config` directory. Although, it is <u>mandatory</u> to also apply these changes to the `org.etsi.osl.tmf.web/src/assets/config` for <u>persistancy</u>, as after any future rebuild of OpenSlice the `/dist` 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 `org.etsi.osl.tmf.web/src/assets/config` and rebuild the application.

## Deploy OpenSlice via Docker Compose

@@ -387,7 +388,7 @@ Hosts File Location:
2 - Replace http://localhost/auth/ with http://keycloak:8080/auth/ in your Keycloak config for AngularJS and Angular (see examples below).


Explanation:
> Explanation

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.
@@ -396,15 +397,18 @@ Explanation:


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

   ```bash
   # Starting from the root project directory
   cd org.etsi.osl.tmf.web/src/assets/config
   ```

   ```bash
   nano config.prod.json
   ```

   After editing it should look like the example bellow:

   ```yaml
   {	      
      "TITLE": "OpenSlice by ETSI",
@@ -444,16 +448,19 @@ Explanation:
  > 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

- For the AngularJS configuration (NVF portal UI), navigate to org.etsi.osl.portal.web/src/js and edit config.js
   
   ```bash
   # Starting from the root project directory
   cd org.etsi.osl.portal.web/src/js
   ```
   
   ```bash
   nano config.js
   ```
   
   after editing it should look like the example bellow:

   ```js
   ```
   var appConfig = angular.module('portalwebapp.config',[]);