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