xref: /openbmc/phosphor-webui/README.md (revision 1ab0f7c1)
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- Inventory data
9- Sensor data
10- Power On/Off server operations
11- Reboot BMC
12- SOL console
13- Remote KVM
14- Virtual media
15- Date and time settings
16- IPv4 network settings
17- Manage and update BMC and Host firmware
18- LDAP
19- SSL certificates
20- Local user management
21
22## Requirements
23
24nodejs (>= 4.2.6)
25npm (>= 6.0.1)
26
27**Note** The default installation of your Linux distro may not come with the
28required versions above. See the following for more information on updating:
29
30https://docs.npmjs.com/troubleshooting/try-the-latest-stable-version-of-node
31https://docs.npmjs.com/troubleshooting/try-the-latest-stable-version-of-npm
32
33## Installation
34
35`npm install`
36
37**Note** This must be run from within the phosphor-webui git repository.
38
39## Running locally
40
41`npm run-script server`
42
43This will start a server instance and begin listening for connections at
44`http://localhost:8080`. This development server provides live reloading on
45code changes.
46NOTE: Browsing to `https://<BMC>` and accepting the self-signed certificate
47might be required to prevent your browser from blocking traffic to the BMC.
48
49## Logging in
50
51Enter the BMC Host or BMC IP address, username, and password.
52The default username and password are `root`/`0penBmc`.
53
54**Note** that some OpenBMC implementations use [bmcweb](https://github.com/openbmc/bmcweb)
55for its backend. For security reasons, bmcweb will need to be recompiled and
56loaded onto the target BMC Host before the above redirect command will work. The
57option to turn on within bmcweb is `BMCWEB_INSECURE_DISABLE_XSS_PREVENTION`. In
58order to test locally, you will also need to disable CSRF by turning on `BMCWEB_INSECURE_DISABLE_CSRF_PREVENTION`.
59