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