xref: /openbmc/phosphor-webui/README.md (revision cc619bdb)
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
16npm
17
18## Installation
19`npm install`
20
21**Note** This must be run from within the phosphor-webui git repository.
22
23## Running locally
24`npm run-script server`
25
26This will start a server instance and begin listening for connections at
27`http://localhost:8080`. This development server provides live reloading on
28code changes.
29NOTE: Browsing to `https://<BMC>` and accepting the self-signed certificate
30might be required to prevent your browser from blocking traffic to the BMC.
31
32## Logging in
33Enter the BMC Host or BMC IP address, username, and password.
34The default username and password are `root`/`0penBmc`.
35
36**Note** that some OpenBMC implementations use [bmcweb](https://github.com/openbmc/bmcweb)
37for its backend. For security reasons, bmcweb will need to be recompiled and
38loaded onto the target BMC Host before the above redirect command will work. The
39option to turn on within bmcweb is `BMCWEB_INSECURE_DISABLE_XSS_PREVENTION`.
40