Newer
Older
[](https://jenkins.openbmc.org/job/latest-master/)
OpenBMC is a Linux distribution for management controllers used in devices such
as servers, top of rack switches or RAID appliances. It uses
[Yocto](https://www.yoctoproject.org/),
[OpenEmbedded](https://www.openembedded.org/wiki/Main_Page),
[systemd](https://www.freedesktop.org/wiki/Software/systemd/), and
[D-Bus](https://www.freedesktop.org/wiki/Software/dbus/) to allow easy
customization for your platform.
See the [Yocto documentation](https://docs.yoctoproject.org/ref-manual/system-requirements.html#required-packages-for-the-build-host)
for the latest requirements
#### Ubuntu
$ sudo apt install git python3-distutils gcc g++ make file wget \
gawk diffstat bzip2 cpio chrpath zstd lz4 bzip2
$ sudo dnf install git python3 gcc g++ gawk which bzip2 chrpath cpio
hostname file diffutils diffstat lz4 wget zstd rpcgen patch
git clone https://github.com/openbmc/openbmc
Any build requires an environment set up according to your hardware target.
There is a special script in the root of this repository that can be used
to configure the environment as needed. The script is called `setup` and
takes the name of your hardware target as an argument.
The script needs to be sourced while in the top directory of the OpenBMC
repository clone, and, if run without arguments, will display the list
of supported hardware targets, see the following example:
```
Target machine must be specified. Use one of:
bletchley mori s8036
dl360poc mtjade swift
e3c246d4i mtmitchell tatlin-archive-x86
ethanolx nicole tiogapass
evb-ast2500 olympus-nuvoton transformers
evb-ast2600 on5263m5 vegman-n110
evb-npcm750 p10bmc vegman-rx20
f0b palmetto vegman-sx20
fp5280g2 qcom-dc-scm-v1 witherspoon
g220a quanta-q71l witherspoon-tacoma
gbs romed8hm3 x11spi
greatlakes romulus yosemitev2
gsj s2600wf zaius
kudo s6q
lannister s7106
```
Once you know the target (e.g. romulus), source the `setup` script as follows:
```
bitbake obmc-phosphor-image
```
Additional details can be found in the [docs](https://github.com/openbmc/docs)
repository.
## OpenBMC Development
The OpenBMC community maintains a set of tutorials new users can go through
to get up to speed on OpenBMC development out
[here](https://github.com/openbmc/docs/blob/master/development/README.md)
## Build Validation and Testing
Commits submitted by members of the OpenBMC GitHub community are compiled and
tested via our [Jenkins](https://jenkins.openbmc.org/) server. Commits are run
through two levels of testing. At the repository level the makefile `make
check` directive is run. At the system level, the commit is built into a
firmware image and run with an arm-softmmu QEMU model against a barrage of
[CI tests](https://jenkins.openbmc.org/job/CI-MISC/job/run-ci-in-qemu/).
Commits submitted by non-members do not automatically proceed through CI
testing. After visual inspection of the commit, a CI run can be manually
performed by the reviewer.
Automated testing against the QEMU model along with supported systems are
performed. The OpenBMC project uses the
[Robot Framework](http://robotframework.org/) for all automation. Our
complete test repository can be found
[here](https://github.com/openbmc/openbmc-test-automation).
Support of additional hardware and software packages is always welcome.
Please follow the [contributing guidelines](https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md)
when making a submission. It is expected that contributions contain test
cases.
[Issues](https://github.com/openbmc/openbmc/issues) are managed on
GitHub. It is recommended you search through the issues before opening
## Questions
First, please do a search on the internet. There's a good chance your question
has already been asked.
For general questions, please use the openbmc tag on
[Stack Overflow](https://stackoverflow.com/questions/tagged/openbmc).
Please review the [discussion](https://meta.stackexchange.com/questions/272956/a-new-code-license-the-mit-this-time-with-attribution-required?cb=1)
on Stack Overflow licensing before posting any code.
For technical discussions, please see [contact info](#contact) below for
Discord and mailing list information. Please don't file an issue to ask a
question. You'll get faster results by using the mailing list or Discord.
* Host management: Power, Cooling, LEDs, Inventory, Events, Watchdog
* Full IPMI 2.0 Compliance with DCMI
* Code Update Support for multiple BMC/BIOS images
* Web-based user interface
* REST interfaces
* D-Bus based interfaces
* SSH based SOL
* Remote KVM
* Hardware Simulation
* Automated Testing
* Verified Boot
**Features Requested but need help**
* OpenBMC performance monitoring
Dive deeper into OpenBMC by opening the
[docs](https://github.com/openbmc/docs) repository.
## Technical Steering Committee
The Technical Steering Committee (TSC) guides the project. Members are:
* Roxanne Clarke, IBM
* Nancy Yuen, Google
* Patrick Williams, Meta
* Terry Duncan, Intel
* Sagar Dharia, Microsoft
* Samer El-Haj-Mahmoud, Arm
- Mail: openbmc@lists.ozlabs.org [https://lists.ozlabs.org/listinfo/openbmc](https://lists.ozlabs.org/listinfo/openbmc)
- Discord: https://discord.gg/69Km47zH98