github.com/emc-advanced-dev/unik@v0.0.0-20190717152701-a58d3e8e33b7/docs/install.md (about)

     1  # Installing UniK
     2  
     3  #### Prerequisites:
     4  - [Docker](http://www.docker.com/) installed and running (Docker machine and Docker for Mac are supported)
     5  - [`jq`](https://stedolan.github.io/jq/)
     6  - [`make`](https://www.gnu.org/software/make/)
     7  - [Virtualbox](https://www.virtualbox.org/) (if using the [virtualbox provider](providers/virtualbox.md))
     8  - [go-bindata](https://github.com/jteeuwen/go-bindata)
     9  
    10  ---
    11  #### Install
    12  ```
    13  $ git clone https://github.com/solo-io/unik.git
    14  $ cd unik
    15  $ make # or 'make binary'; see the notes below
    16  $ _build/unik
    17  Unik is a tool for compiling application source code
    18  into bootable disk images. Unik also runs and manages unikernel
    19  instances across infrastructures.
    20  ...
    21  ```
    22  
    23  Note that `make` will pre-pull a number of large docker containers unik needs in order to run. In order to skip pre-pulling (as you may not require all of these containers), you can replace `make` with `make binary`. Note that the first time unik requires a specific docker image, it will pull that image.
    24  
    25  This will place the `unik` executable at **unik/_build/unik**. Run UniK commands with `./_build/unik`, or move the binary to somewhere in your path, such as `/usr/local/bin` to run commands from anywhere with `unik [command]`
    26  
    27  Continue to [configuration](configure.md) to learn how to configure your UniK setup
    28  ---
    29  #### Building Containers from Source
    30  By default, `make` will pull all of the necessary container images from [Docker Hub](https://hub.docker.com/).
    31  If you wish to build containers from sources, you will need:
    32  - [Golang](https://golang.org/) v1.5 or later
    33  - `$GOPATH` should be set and `$GOPATH/bin` should be part of your `$PATH` (see https://golang.org/doc/code.html#GOPATH)
    34  - [Apache Maven](https://maven.apache.org/)
    35  Verify that `mvn` and `go` are installed, and your `$GOPATH` is set correctly. Then simply:
    36  
    37  ```
    38  $ make containers
    39  ```
    40  
    41  ---
    42  #### Uninstall
    43  
    44  ##### `unik` binary
    45  ```
    46  $ make uninstall
    47  ```
    48  
    49  ##### UniK docker containers
    50  ```
    51  $ make remove-containers
    52  ```