<commit_before>include::variables.adoc[]

[[installing-minishift]]
= Installing {project}
:icons:
:toc: macro
:toc-title:
:toclevels: 1

toc::[]

[[installing-overview]]
== Overview

The following section describes how to install {project} and the required dependencies.

[[install-prerequisites]]
== Prerequisites

{project} requires a hypervisor to start the virtual machine on which the OpenShift cluster is provisioned.
Verify that the hypervisor of your choice is installed and enabled on your system before you start {project}.

Depending on your host operating system, you have the choice of the following hypervisors:

macOS::
- link:https://github.com/mist64/xhyve[xhyve] (default)
+
NOTE: xhyve requires specific installation and configuration steps that are described in the xref:../getting-started/setting-up-driver-plugin.adoc#[Setting Up the Driver Plug-in] section.

- link:https://www.virtualbox.org/wiki/Downloads[VirtualBox]
- link:https://www.vmware.com/products/fusion[VMware Fusion]

GNU/Linux::
- link:https://en.wikipedia.org/wiki/Kernel-based_Virtual_Machine[KVM] (default)
+
NOTE: KVM requires specific installation and configuration steps that are described in the xref:../getting-started/setting-up-driver-plugin.adoc#[Setting Up the Driver Plug-in] section.

- link:https://www.virtualbox.org/wiki/Downloads[VirtualBox]

Windows::
- link:https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v[Hyper-V] (default)
+
[NOTE]
====
To use {project} with Hyper-V ensure that, after you link:https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v[install Hyper-V], you also link:https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/connect-to-network[add a Virtual Switch] using the Hyper-V Manager.
For specific configuration steps see the xref:../getting-started/setting-up-driver-plugin.adoc#[Setting Up the Driver Plug-in] section.
====

- link:https://www.virtualbox.org/wiki/Downloads[VirtualBox]
+
[NOTE]
====
It is recommended to use VirtualBox 5.1.12 or later on Windows to avoid the issue xref:../troubleshooting/troubleshooting-driver-plugins.adoc#machine-doesnt-exist[Error: machine does not exist].
If you encounter issues related to the hypervisor, see the xref:../troubleshooting/troubleshooting-driver-plugins.adoc#[Troubleshooting Driver Plug-ins] section.
====

[[installing-instructions]]
== Installing {project}

=== Manually

.  Download the archive for your operating system from the link:https://github.com/minishift/minishift/releases[{project} releases page] and unpack it.

.  Copy the contents of the directory to your preferred location.

.  Add the *minishift* binary to your `PATH` environment variable.

[NOTE]
====
- On Windows operating system, due to issue link:https://github.com/minishift/minishift/issues/236[#236], you need to execute the {project} binary from your local C:/ drive.
You cannot run {project} from a network drive.

- Automatic update of the {project} binary and the virtual machine ISO is currently disabled.
See also issue link:https://github.com/minishift/minishift/issues/204[#204].
====

[[homebrew-install-minishift]]
=== With Homebrew

[[homebrew-stable-install]]
==== Stable

On macOS you can also use link:https://caskroom.github.io[Homebrew Cask] to install the stable version of {project}:

----
  $ brew cask install minishift
----

To update the binary, run following command:

----
  $ brew cask install --force minishift
----
<commit_msg>Issue #1611 Remove outdated installation note<commit_after>include::variables.adoc[]

[[installing-minishift]]
= Installing {project}
:icons:
:toc: macro
:toc-title:
:toclevels: 1

toc::[]

[[installing-overview]]
== Overview

The following section describes how to install {project} and the required dependencies.

[[install-prerequisites]]
== Prerequisites

{project} requires a hypervisor to start the virtual machine on which the OpenShift cluster is provisioned.
Verify that the hypervisor of your choice is installed and enabled on your system before you start {project}.

Depending on your host operating system, you have the choice of the following hypervisors:

macOS::
- link:https://github.com/mist64/xhyve[xhyve] (default)
+
NOTE: xhyve requires specific installation and configuration steps that are described in the xref:../getting-started/setting-up-driver-plugin.adoc#[Setting Up the Driver Plug-in] section.

- link:https://www.virtualbox.org/wiki/Downloads[VirtualBox]
- link:https://www.vmware.com/products/fusion[VMware Fusion]

GNU/Linux::
- link:https://en.wikipedia.org/wiki/Kernel-based_Virtual_Machine[KVM] (default)
+
NOTE: KVM requires specific installation and configuration steps that are described in the xref:../getting-started/setting-up-driver-plugin.adoc#[Setting Up the Driver Plug-in] section.

- link:https://www.virtualbox.org/wiki/Downloads[VirtualBox]

Windows::
- link:https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v[Hyper-V] (default)
+
[NOTE]
====
To use {project} with Hyper-V ensure that, after you link:https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v[install Hyper-V], you also link:https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/connect-to-network[add a Virtual Switch] using the Hyper-V Manager.
For specific configuration steps see the xref:../getting-started/setting-up-driver-plugin.adoc#[Setting Up the Driver Plug-in] section.
====

- link:https://www.virtualbox.org/wiki/Downloads[VirtualBox]
+
[NOTE]
====
It is recommended to use VirtualBox 5.1.12 or later on Windows to avoid the issue xref:../troubleshooting/troubleshooting-driver-plugins.adoc#machine-doesnt-exist[Error: machine does not exist].
If you encounter issues related to the hypervisor, see the xref:../troubleshooting/troubleshooting-driver-plugins.adoc#[Troubleshooting Driver Plug-ins] section.
====

[[installing-instructions]]
== Installing {project}

=== Manually

.  Download the archive for your operating system from the link:https://github.com/minishift/minishift/releases[{project} releases page] and unpack it.

.  Copy the contents of the directory to your preferred location.

.  Add the *minishift* binary to your `PATH` environment variable.

[NOTE]
====
- On Windows operating system, due to issue link:https://github.com/minishift/minishift/issues/236[#236], you need to execute the {project} binary from your local C:/ drive.
You cannot run {project} from a network drive.
====

[[homebrew-install-minishift]]
=== With Homebrew

[[homebrew-stable-install]]
==== Stable

On macOS you can also use link:https://caskroom.github.io[Homebrew Cask] to install the stable version of {project}:

----
  $ brew cask install minishift
----

To update the binary, run following command:

----
  $ brew cask install --force minishift
----

{'fraction_non_alphanumeric': 0.12514450867052024, 'fraction_numerical': 0.005202312138728324, 'mean_word_length': 4.8454391891891895, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 25, 'lorem ipsum': 0, 'www.': 8, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1679686', 'n_tokens_mistral': 2176, 'n_tokens_neox': 2054, 'n_words': 623}