README.md
f534f997
 ![Photon](http://storage.googleapis.com/project-photon/vmw-logo-photon.svg "VMware Photon")
f4d17450
 
9eeca802
 # Photon OS: Linux Container Host
f4d17450
 
9eeca802
 ### Contents
ae982a4a
 - [What is Photon OS](#what-is-photon-os)
 - [Getting Photon OS](#getting-photon-os)
9eeca802
 - [Getting Started](#getting-started)
 - [Contributing](#contributing)
 - [License](#license)
ae982a4a
 - [Photon OS Resources](#photon-os-resources)
10ac0fc4
 
9eeca802
 ## What is Photon OS?
 Photon OS™ is an open source Linux container host optimized for cloud-native applications, cloud platforms, and VMware infrastructure. Photon OS provides a secure run-time environment for efficiently running containers. Some of the key highlights of Photon OS are:
 
1d7d68f8
 - **Optimized for VMware hypervisor:** The Linux kernel is tuned for performance when Photon OS runs on VMware ESXi.
9eeca802
 
1d7d68f8
 - **Support for containers:** Photon OS includes the Docker daemon and works with container orchestration frameworks, such as Mesos and Kubernetes.
9eeca802
 
1d7d68f8
 - **Efficient lifecycle management:** Photon OS is easy to manage, patch, and update, using the [tdnf package manager](https://github.com/vmware/photon/blob/master/docs/photon-admin-guide.md#tiny-dnf-for-package-management) and the [Photon Management Daemon (pmd)](https://github.com/vmware/pmd).
9eeca802
 
1d7d68f8
 - **Security hardened:** Photon OS provides secure and up-to-date kernel and other packages, and its policies are designed to govern the system securely.
9eeca802
 
 For an overview of Photon OS, see [https://vmware.github.io/photon/](https://vmware.github.io/photon/)
 
 ## Getting Photon OS
 
 Photon OS binaries are available in a number of formats, including ISO, OVA and cloud images such as Amazon AMI, Google Cloud GCE image and Azure VHD.
 
1d7d68f8
 For download instructions and links to Photon OS binaries, go to the [Download Guide](https://github.com/vmware/photon/wiki/Downloading-Photon-OS).
9eeca802
 
ba851489
 *Photon OS 4.0 GA is here!*
062e57f0
 --------------------------
ba851489
 Photon OS 4.0 provides support for the Real Time flavor of kernel linux-rt, SELinux , installer improvements, PMD role management improvements and critical updates to OSS packages including linux kernel, systemd, and glibc.
062e57f0
 
ba851489
 For an overview of changes, see [What's New in Photon OS 4.0](https://github.com/vmware/photon/wiki/What-is-New-in-Photon-OS-4.0).
9eeca802
 
 ## Getting Started
1d7d68f8
 Begin your Photon OS journey by browsing our extensive guides on getting started in the [Photon OS Wiki](https://github.com/vmware/photon/wiki).
9eeca802
 
 ## Contributing
 The Photon OS project team welcomes contributions from the community.
 
 If you wish to contribute code and you have not signed our Contributor License Agreement (CLA), our CLA-bot will take you through the process and update the issue when you open a [Pull Request](https://help.github.com/articles/creating-a-pull-request). If you have questions about the CLA process, see our CLA [FAQ](https://cla.vmware.com/faq) or contact us through the GitHub issue tracker.
 
 To help you get started making contributions to Photon OS, we have collected some helpful best practices in the [Contributing guidelines](https://github.com/vmware/photon/blob/master/contributing.md).
 
1d7d68f8
 Before you start to code, we recommend discussing your plans through a GitHub issue or discuss it first with the official project [maintainers](https://github.com/vmware/photon/blob/dev/AUTHORS.md) via the [#photon Slack Channel](https://vmwarecode.slack.com/messages/photon/), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
 
9eeca802
 ## License
ba851489
 The Photon OS ISO and OVA images are distributed under the [Photon OS EULA](https://github.com/vmware/photon/blob/master/EULA.txt).
9eeca802
 
ba851489
 With the exception of the 'libtdnf' source code, Photon OS source code is distributed under GNU GPL v2. The 'libtdnf' source code is distributed under GNU LGPL v2.1. For more details, please refer to the [Photon OS Open Source License file](https://github.com/vmware/photon/blob/master/LICENSE.md).
f4d17450
 
9eeca802
 ## Photon OS Resources
f4d17450
 
ba851489
 - **Documentation**: The Photon OS [Documentation](https://vmware.github.io/photon/docs/) provides information about how to install, configure, and use VMware Photon OS™.
6d3c7578
 - **Security Updates**: Visit [Security-Advisories](https://github.com/vmware/photon/wiki/Security-Advisories).
ba851489
 - **Vagrant box**: An official Vagrant box is available on Hashicorp Atlas, to get started: `vagrant init vmware/photon`. A plugin to support Photon OS guests in Vagrant is available at [https://github.com/vmware/vagrant-guests-photon](https://github.com/vmware/vagrant-guests-photon). Some users have found that our Vagrant box requires VirtualBox 4.3 or later. If you have issues, please check your version.