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