installation/sdnc-web/README.md

   1 # sdnc web image
   2
   3
   4 ## folder structure
   5
   6 | folder | description |
   7 | ------ | ----------- |
   8 | /opt/bitnami/nginx/conf/server_blocks/http(s)_site.conf | nginx config |
   9 | /opt/bitnami/nginx/conf/server_blocks/location.rules | forwarding rules for nginx |
  10 | /app/odlux | http content files (html, js, css, ...) |
  11 | /app/odlux.application.list | application list file |
  12 | /app/opm.py | Odlux package manager for install or uninstall apps |
  13 | /app/init.d/ | autoinstall folder for opm |
  14
  15 ## Default app order
  16
  17 | index | application |
  18 | ----- | ----------- |
  19 | 1 | connectApp |
  20 | 10 | faultApp |
  21 | 20 | maintenanceApp |
  22 | 30 | configurationApp |
  23 | 55 | performanceHistoryApp |
  24 | 70 | inventoryApp |
  25 | 75 | eventLogApp |
  26 | 90 | mediatorApp |
  27 | 200 | helpApp |
  28
  29
  30 ## usage
  31
  32 ### auto installation
  33
  34 To auto install additional applications for odlux they can be easily injected before startup into the ```/app/init.d/``` folder. There are two options of file format allowed.
  35
  36 [1] The first fileformat is e.g. 55linkCalculationApp.jar but also .zip is allowed. The important thing is that a number is leading the app package to specify the order number where the menu item is ordered in the menu bar. So the linkCalculationApp would be located between performanceApp and inventoryApp.
  37
  38 [2] The second is the default jar format, like it would be installed into the opendaylight karaf environment, including a blueprint and the sources. There the filename is not important because application name and index will be detected by the blueprint information.
  39
  40
  41 ### manual method
  42 ```
  43 opm install --name myApp --index 53 --file myarchive.zip
  44 ```
  45 ```
  46 opm install --url https://link-to-my-odlux-application.jar
  47 ```
  48
  49 ```
  50 opm uninstall --name myApp
  51 ```
  52
  53 ```
  54 opm list
  55 ```
  56