README.md

   1 # OpenDaylight DLUX \r
   2 \r
   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.\r
   4 \r
   5 \r
   6 ## Build DLUX code with Karaf feature and distribution\r
   7 \r
   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.\r
   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.\r
  10 \r
  11     $  mvn clean install\r
  12 \r
  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.\r
  14 \r
  15 ### Install NodeJS manually if needed\r
  16 \r
  17 __For Windows and Mac without brew:__\r
  18 \r
  19     Go to http://www.nodejs.org\r
  20     Download and install NodeJS\r
  21 \r
  22 __For Mac with brew installed:__\r
  23 \r
  24     $ brew update\r
  25     $ brew install node\r
  26 \r
  27 __Verify NodeJS is installed:__\r
  28 \r
  29     $ npm --version\r
  30 \r
  31 __Run DLUX in karaf distribution__\r
  32 \r
  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.\r
  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 -\r
  35 \r
  36     ./karaf\r
  37 \r
  38 On the karaf shell, install dlux core feature via running following command -\r
  39 \r
  40     feature:install odl-dlux-core\r
  41 \r
  42 \r
  43 It will internally install odl-restconf and dlux topology application along with core dlux components. once this feature is successfully installed.\r
  44 Access the dlux UI at __http://localhost:8181/index.html__. Default credentials are admin/admin for login.\r
  45 \r
  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\r
  47 \r
  48     feature:install odl-dlux-node\r
  49     feature:install odl-dlux-yangui\r
  50 \r
  51 For more details - follow the wiki at  [dlux opendaylight](https://wiki.opendaylight.org/view/OpenDaylight_dlux:Getting_started)\r