Installation

Pilosa is currently available for MacOS and Linux.

Installing on MacOS

There are three ways to install Pilosa on MacOS: download the binary (recommended), build from source, or use Docker.

Download the Binary

1. Download the latest release:

   curl -L -O https://github.com/pilosa/pilosa/releases/download/v0.3.1/pilosa-v0.3.1-darwin-amd64.tar.gz
   

   Other releases can be downloaded from our Releases page on Github.

2. Extract the binary:

   tar xfz pilosa-v0.3.1-darwin-amd64.tar.gz
   

3. Move the binary into your PATH so you can run pilosa from any shell:

   cp -i pilosa-v0.3.1-darwin-amd64/pilosa /usr/local/bin
   

4. Make sure Pilosa is installed successfully:

   pilosa
   

   If you see something like:

   Pilosa is a fast index to turbocharge your database.
   
   This binary contains Pilosa itself, as well as common
   tools for administering pilosa, importing/exporting data,
   backing up, and more. Complete documentation is available
   at http://pilosa.com/docs
   
   Version: v0.3.0-279-gcf7082f
   Build Time: 2017-04-21T15:36:08+0000
   
   Usage:
     pilosa [command]
   
   Available Commands:
     backup      Backup data from pilosa.
     bench       Benchmark operations.
     check       Do a consistency check on a pilosa data file.
     config      Print the default configuration.
     export      Export data from pilosa.
     help        Help about any command
     import      Bulk load data into pilosa.
     inspect     Get stats on a pilosa data file.
     restore     Restore data to pilosa from a backup file.
     server      Run Pilosa.
     sort        Sort import data for optimal import performance.
   
   Flags:
     -c, --config string   Configuration file to read from.
   
   Use "pilosa [command] --help" for more information about a command.
   

   You’re good to go!

Build from Source

1. Install the prerequisites:

   • Go. Be sure to set the $GOPATH and $PATH environment variables as described here (https://golang.org/doc/code.html#GOPATH).
   • Git
   • Glide

2. Clone the repo:

   go get -d github.com/pilosa/pilosa
   

3. Build the Pilosa repo:

   cd $GOPATH/src/github.com/pilosa/pilosa
   make install
   

4. Make sure Pilosa is installed successfully:

   pilosa
   

   If you see something like:

   Pilosa is a fast index to turbocharge your database.
   
   This binary contains Pilosa itself, as well as common
   tools for administering pilosa, importing/exporting data,
   backing up, and more. Complete documentation is available
   at http://pilosa.com/docs
   
   Version: v0.3.0-279-gcf7082f
   Build Time: 2017-04-21T15:36:08+0000
   
   Usage:
     pilosa [command]
   
   Available Commands:
     backup      Backup data from pilosa.
     bench       Benchmark operations.
     check       Do a consistency check on a pilosa data file.
     config      Print the default configuration.
     export      Export data from pilosa.
     help        Help about any command
     import      Bulk load data into pilosa.
     inspect     Get stats on a pilosa data file.
     restore     Restore data to pilosa from a backup file.
     server      Run Pilosa.
     sort        Sort import data for optimal import performance.
   
   Flags:
     -c, --config string   Configuration file to read from.
   
   Use "pilosa [command] --help" for more information about a command.
   

   You’re good to go!

Use Docker

1. Install Docker for Mac.

2. Confirm that the Docker daemon is running in the background:

   docker version
   

If you don’t see the server listed, start the Docker application.

1. Pull the official Pilosa image from Docker Hub:

   docker pull pilosa/pilosa:latest
   

2. Make sure Pilosa is installed successfully:

   docker run --rm pilosa/pilosa:latest help
   

What’s next?

Head over to the Getting Started guide to create your first Pilosa index.

Installing on Linux

There are three ways to install Pilosa on Linux: download the binary (recommended), build from source, or use Docker.

Download the Binary

1. To install the latest version of Pilosa, download the latest release:

   curl -L -O https://github.com/pilosa/pilosa/releases/download/v0.3.1/pilosa-v0.3.1-linux-amd64.tar.gz
   

   Note: This assumes you are using an amd64 compatible architecture. Other releases can be downloaded from our Releases page on Github.

2. Extract the binary:

   tar xfz pilosa-v0.3.1-linux-amd64.tar.gz
   

3. Move the binary into your PATH so you can run pilosa from any shell:

   cp -i pilosa-v0.3.1-linux-amd64/pilosa /usr/local/bin
   

4. Make sure Pilosa is installed successfully:

   pilosa
   

   If you see something like:

   Pilosa is a fast index to turbocharge your database.
   
   This binary contains Pilosa itself, as well as common
   tools for administering pilosa, importing/exporting data,
   backing up, and more. Complete documentation is available
   at http://pilosa.com/docs
   
   Version: v0.3.0-279-gcf7082f
   Build Time: 2017-04-21T15:36:08+0000
   
   Usage:
     pilosa [command]
   
   Available Commands:
     backup      Backup data from pilosa.
     bench       Benchmark operations.
     check       Do a consistency check on a pilosa data file.
     config      Print the default configuration.
     export      Export data from pilosa.
     help        Help about any command
     import      Bulk load data into pilosa.
     inspect     Get stats on a pilosa data file.
     restore     Restore data to pilosa from a backup file.
     server      Run Pilosa.
     sort        Sort import data for optimal import performance.
   
   Flags:
     -c, --config string   Configuration file to read from.
   
   Use "pilosa [command] --help" for more information about a command.
   

   You’re good to go!

Build from Source

1. Install the prerequisites:

   • Go. Be sure to set the $GOPATH and $PATH environment variables as described here (https://golang.org/doc/code.html#GOPATH).
   • Git
   • Glide

2. Clone the repo:

   go get -d github.com/pilosa/pilosa
   

3. Build the Pilosa repo:

   cd $GOPATH/src/github.com/pilosa/pilosa
   make install
   

4. Make sure Pilosa is installed successfully:

   pilosa
   

   If you see something like:

   Pilosa is a fast index to turbocharge your database.
   
   This binary contains Pilosa itself, as well as common
   tools for administering pilosa, importing/exporting data,
   backing up, and more. Complete documentation is available
   at http://pilosa.com/docs
   
   Version: v0.3.0-279-gcf7082f
   Build Time: 2017-04-21T15:36:08+0000
   
   Usage:
     pilosa [command]
   
   Available Commands:
     backup      Backup data from pilosa.
     bench       Benchmark operations.
     check       Do a consistency check on a pilosa data file.
     config      Print the default configuration.
     export      Export data from pilosa.
     help        Help about any command
     import      Bulk load data into pilosa.
     inspect     Get stats on a pilosa data file.
     restore     Restore data to pilosa from a backup file.
     server      Run Pilosa.
     sort        Sort import data for optimal import performance.
   
   Flags:
     -c, --config string   Configuration file to read from.
   
   Use "pilosa [command] --help" for more information about a command.
   

   You’re good to go!

Use Docker

1. Install Docker.

2. Confirm that the Docker daemon is running in the background:

   docker version
   

   If you don’t see the server listed, start the Docker application.

3. Pull the official Pilosa image from Docker Hub:

   docker pull pilosa/pilosa:latest
   

4. Make sure Pilosa is installed successfully:

   docker run --rm pilosa/pilosa:latest help
   

What’s next?

Head over to the Getting Started guide to create your first Pilosa index.

---