# phosphor-webui

**Repository Path**: obmc/phosphor-webui

## Basic Information

- **Project Name**: phosphor-webui
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-17
- **Last Updated**: 2023-11-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OpenBMC Web User Interface

phosphor-webui is a Web-based user interface for the OpenBMC firmware stack.

[webui-vue repository](https://github.com/openbmc/webui-vue) is a replacement
for phosphor-webui.

If you haven't switched to webui-vue, it is strongly recommended you do so now.
Reasons for switching:
 - phosphor-webui uses AngularJS which has gone [End of
     Life](https://en.wikipedia.org/wiki/AngularJS)
 - phosphor-webui uses the REST D-BUS API which has been [disabled by default in
     bmcweb](https://github.com/openbmc/bmcweb/commit/47c9e106e0057dd70133d50e928e48cbc68e709a)
 - webui-vue has many additional features not present in phosphor-webui
 - Very little active development is happening in phosphor-webui and at a later
     date phosphor-webui will move to ReadOnly

Features of this repository include:

- View system overview data such as model information and serial number
- View and manage event logs
- Inventory data
- Sensor data
- Power On/Off server operations
- Reboot BMC
- SOL console
- Remote KVM
- Virtual media
- Date and time settings
- IPv4 network settings
- Manage and update BMC and Host firmware
- LDAP
- SSL certificates
- Local user management

## Requirements

nodejs (>= 4.2.6)
npm (>= 6.0.1)

**Note** The default installation of your Linux distro may not come with the
required versions above. See the following for more information on updating:

https://docs.npmjs.com/troubleshooting/try-the-latest-stable-version-of-node
https://docs.npmjs.com/troubleshooting/try-the-latest-stable-version-of-npm

## Installation

`npm install`

**Note** This must be run from within the phosphor-webui git repository.

## Running locally

`npm run-script server`

This will start a server instance and begin listening for connections at
`http://localhost:8080`. This development server provides live reloading on
code changes.
NOTE: Browsing to `https://<BMC>` and accepting the self-signed certificate
might be required to prevent your browser from blocking traffic to the BMC.

## Logging in

Enter the BMC Host or BMC IP address, username, and password.
The default username and password are `root`/`0penBmc`.

**Note** that some OpenBMC implementations use [bmcweb](https://github.com/openbmc/bmcweb)
for its backend. For security reasons, bmcweb will need to be recompiled and
loaded onto the target BMC Host before the above redirect command will work. The
option to turn on within bmcweb is `BMCWEB_INSECURE_DISABLE_XSS_PREVENTION`. In
order to test locally, you will also need to disable CSRF by turning on `BMCWEB_INSECURE_DISABLE_CSRF_PREVENTION`.