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

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

Minishift uses libmachine for provisioning 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, see the Minishift releases page.

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

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

Minishift documentation is published as a part of the OpenShift 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 for writing documentation, see the Contributing to Minishift topics.

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