|Number of watchers on Github||19|
|Number of open issues||43|
|Average time to close an issue||about 2 months|
|Average time to merge a PR||1 day|
|Open pull requests||4+|
|Closed pull requests||2+|
|Last commit||over 2 years ago|
|Repo Created||over 3 years ago|
|Repo Last Updated||about 2 years ago|
|Organization / Author||intel|
|Do you use ciao-webui? Leave a review!|
|View open issues (43)|
|View on github|
|Fresh, new opensource launches 🚀🚀🚀|
Trendy new open source projects in your inbox! View examples
Running Ciao Web UI requires Node.js v5.9.0 or greater. Third party sofware packages can be found in the package.json file.
$ node --version
The ciao_config.json file is a file in JSON format which contains the
information of the ciao-controller and keystone servers the Web UI is
going to connect to.
The root of the ciao_config.json is the
environment, and should match
the NODE_ENV environment variable. Then the parameters controller,
storage, keystone and ui will follow.
Note: an alternate configuration file may be used by running npm start with a
....npm start -- config_file=
Path to configuration file
Refers to the ciao-controller that the Web UI will connect to, it has the following parameters:
The following fields will determine how the Ciao Web UI will beconfigured.
Note: if https protocol is set on ui options, Web UI will require a signed ssl certificate with a passphrase. A self-signed certificate may be generated using the following command: openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 365
certificates - this is field is required for https protocol, pem key and certificate files will also be required.
Note: application can be started with this information specified on npm start parameters, see Run application*.
In order to build application the 'install.sh' must be executed. This script will intsall dependencies using the npm package manager and also build minified JS scripts used with browser compatibility. Note: this process is only necessary for development as minified scripts and dependencies are already provided by the application.
# install while setting a "development" environment $ ./install.sh development # In this case NODE_ENV will be set to "development"
In order to run the application use the deployment script 'deploy.sh'. Deployment supports using a configuration file located on config/ciao_config. Otherwise, parameters may be passed on to deploy.sh to specify controller, keystone and ui settings. deploy.sh also requires NODE_ENV as a first parameter, and will set it as the environment variable for running the UI (valid values for NODE_ENV are 'development' or 'production'). Usage with valid configuration file:
$ ./deploy.sh [NODE_ENV]
Usage without configuration file: To run UI with specific set of configuration regardless of ciao_config.json's content, use the following paramters:
https, the UI will run on https, and also controller and keystone are assumed to use this protocol as well.
....$ ./deploy.sh [NODE_ENV] [protocol=protocol] [controller_addr=ip_address] [controller_port=port] [keystone_addr=ip_address] [key_path=pem_file] [cert_path=pem_file] [passphrase=certificate_passphrase]
$ deploy.sh development protocol=https controller_addr=127.0.0.1 controller_port=8774 keystone_addr=127.0.0.1 keystone_port=35357 key_path=certs/key-pass.pem cert_path=certs/cert.pem passphrase=asecurepassphrase
App will then run on protocol://localhost:3000 To serve the UI on an alternativa port set the PORT environment variable with the value of the desired port. Example.
$ export PORT=80 $ ./deploy.sh development