xref: /openbmc/phosphor-webui/README.md (revision c86ce3c9)
1# OpenBMC Web User Interface
2The OpenBMC WebUI is a Web-based user interface for the OpenBMC
3firmware stack. The WebUI uses AngularJS. Features include:
4* View system overview data such as model information and serial number
5* View and manage event logs
6* View inventory data
7* View sensor data
8* Power On/Off server operations
9* Reboot BMC
10* Manage and update BMC and Host firmware
11* IPv4 network settings
12* SoL console
13
14## Requirements
15nodejs (>= 4.2.6)
16npm (>= 5.6.0)
17
18**Note** The default installation of your Linux distro may not come with the
19required versions above. See the following for more information on updating:
20
21https://docs.npmjs.com/troubleshooting/try-the-latest-stable-version-of-node
22https://docs.npmjs.com/troubleshooting/try-the-latest-stable-version-of-npm
23
24## Installation
25`npm install`
26
27**Note** This must be run from within the phosphor-webui git repository.
28
29## Running locally
30`npm run-script server`
31
32This will start a server instance and begin listening for connections at
33`http://localhost:8080`. This development server provides live reloading on
34code changes.
35NOTE: Browsing to `https://<BMC>` and accepting the self-signed certificate
36might be required to prevent your browser from blocking traffic to the BMC.
37
38## Logging in
39Enter the BMC Host or BMC IP address, username, and password.
40The default username and password are `root`/`0penBmc`.
41
42**Note** that some OpenBMC implementations use [bmcweb](https://github.com/openbmc/bmcweb)
43for its backend. For security reasons, bmcweb will need to be recompiled and
44loaded onto the target BMC Host before the above redirect command will work. The
45option to turn on within bmcweb is `BMCWEB_INSECURE_DISABLE_XSS_PREVENTION`.
46