dlux-web/src/README.md

   1 # OpenDaylight DLUX
   2
   3 OpenDaylight DLUX is a Javascript-based stateless user interface that communicates with the service backend to provide a consistent and user-friendly interface to interact with OpenDaylight projects and base controller.
   4
   5
   6 ## Build DLUX code with Karaf feature and distribution
   7
   8 All necessary modules mentioned above such as nodesjs, bower etc. will be installed automatically, when you run the dlux build for first time.  Run following command at dlux home directory /dlux to build dlux feature and distribution along with code.
   9 Once successful, It will make dlux feature available to install and also create dlux karaf distribution. You can find karaf distribution at dlux/distribution-dlux.
  10
  11     $  mvn clean install
  12
  13 __NOTE__: Some people reported about node related error while maven build. Those errors are usually environment related, mostly happens because of the permission issues or node is not installed properly. Try to reinstall node manually.
  14
  15 ### Install NodeJS manually if needed
  16
  17 __For Windows and Mac without brew:__
  18
  19     Go to http://www.nodejs.org
  20     Download and install NodeJS
  21
  22 __For Mac with brew installed:__
  23
  24     $ brew update
  25     $ brew install node
  26
  27 __Verify NodeJS is installed:__
  28
  29     $ npm --version
  30
  31 __Run DLUX in karaf distribution__
  32
  33 Once you have dlux distribution or you have karaf distribution from integration repository. You can turn on the dlux feature to access the UI.
  34 We will take example of dlux distribution here. Navigate to directory dlux/distribution-dlux/target/assembly/bin and start the karaf via following command -
  35
  36     ./karaf
  37
  38 On the karaf shell, install dlux core feature via running following command -
  39
  40     feature:install odl-dlux-core
  41
  42
  43 It will internally install odl-restconf and dlux topology application along with core dlux components. once this feature is successfully installed.
  44 Access the dlux UI at __http://localhost:8181/index.html__. Default credentials are admin/admin for login.
  45
  46 All the applications in dlux are now karaf features. You can install other dlux applications such as nodes, yang-ui from karaf console using commands such as
  47
  48     feature:install odl-dlux-node
  49     feature:install odl-dlux-yangui
  50
  51 For more details - follow the wiki at  [dlux opendaylight](https://wiki.opendaylight.org/view/OpenDaylight_dlux:Getting_started)