• Welcome to Minishift!
• Getting started
• Documentation
• Community

Minishift is a tool that helps you run OpenShift locally by running asingle-node OpenShift cluster inside a VM. You can try out OpenShift ordevelop with it, day-to-day, on your local host.

Minishift uses libmachine forprovisioning VMs, and OpenShift Origin for running the cluster. The code base is forked from the Minikube project.

To download the latest binary and review release notes, seethe Minishift releases page.

Minishift requires a hypervisor to start the virtual machine on which the OpenShift clusteris provisioned. Make sure that the hypervisor of your choice is installed and enabled onyour system before you start Minishift.

For detailed installation instructions for Minishift and the required dependencies, seethe Getting started documentation.

Minishift documentation is published as a part of theOpenShift Origin documentation library.Check out the latest official Minishift documentation for information about getting started,using, and contributing to Minishift:

• Getting started with Minishift

• Using Minishift

• Developing and contributing to Minishift

• Command Reference

In addition, you can review the release notes and project roadmap here on GitHub:

• Release Notes

• Roadmap

Contributions, questions, and comments are all welcomed and encouraged!

You can reach the Minishift community by:

• Signing up to our mailing list

• Joining the #minishift channel on Freenode IRC

For information about contributing, building, and releasing Minishift, as well as guidelines forwriting documentation, see the Contributing to Minishift topics.

If you want to contribute, make sure to follow the contribution guidelineswhen you open issues or submit pull requests.