Installation

Pilosa is currently available for MacOS and Linux.

Installing on MacOS

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

Use Homebrew

Update your Homebrew formulas:
```
brew update
```
Install Pilosa
```
brew install pilosa
```

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 https://www.pilosa.com/docs/.

Version: v0.10.1-64-gf053d9a5
Build Time: 2018-05-14T22:14:01+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 current configuration.
  export          Export data from pilosa.
  generate-config Print the default configuration.
  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.

Flags:
  -c, --config string   Configuration file to read from.
  -h, --help            help for pilosa

Use "pilosa [command] --help" for more information about a command.

You’re good to go!

Download the Binary

Download the latest release:

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

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

Extract the binary:

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

Move the binary into your PATH so you can run pilosa from any shell:
```
cp -i pilosa-v0.10.1-darwin-amd64/pilosa /usr/local/bin
```

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 https://www.pilosa.com/docs/.

Version: v0.10.1-64-gf053d9a5
Build Time: 2018-05-14T22:14:01+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 current configuration.
  export          Export data from pilosa.
  generate-config Print the default configuration.
  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.

Flags:
  -c, --config string   Configuration file to read from.
  -h, --help            help for pilosa

Use "pilosa [command] --help" for more information about a command.

You’re good to go!

Build from Source

For advanced instructions for building from source, view our Contributor's Guide.

Install the prerequisites:
- Go. Be sure to set the $GOPATH and $PATH environment variables as described here.
- Git

Clone the repo:

mkdir -p ${GOPATH}/src/github.com/pilosa && cd $_
git clone https://github.com/pilosa/pilosa.git

Build the Pilosa repo (the make generate-statik line isn’t necessary but builds a nice webUI into Pilosa):
```
cd $GOPATH/src/github.com/pilosa/pilosa
make install-build-deps
make generate-statik
make install
```

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 https://www.pilosa.com/docs/.

Version: v0.10.1-64-gf053d9a5
Build Time: 2018-05-14T22:14:01+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 current configuration.
  export          Export data from pilosa.
  generate-config Print the default configuration.
  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.

Flags:
  -c, --config string   Configuration file to read from.
  -h, --help            help for pilosa

Use "pilosa [command] --help" for more information about a command.

You’re good to go!

Use Docker

Install Docker for Mac.
Confirm that the Docker daemon is running in the background:
```
docker version
```
If you don’t see the server listed, start the Docker application.
Pull the official Pilosa image from Docker Hub:
```
docker pull pilosa/pilosa:latest
```

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

To install the latest version of Pilosa, download the latest release:
```
curl -L -O https://github.com/pilosa/pilosa/releases/download/v0.10.1/pilosa-v0.10.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.

Extract the binary:

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

Move the binary into your PATH so you can run pilosa from any shell:
```
cp -i pilosa-v0.10.1-linux-amd64/pilosa /usr/local/bin
```

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 https://www.pilosa.com/docs/.

Version: v0.10.1-64-gf053d9a5
Build Time: 2018-05-14T22:14:01+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 current configuration.
  export          Export data from pilosa.
  generate-config Print the default configuration.
  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.

Flags:
  -c, --config string   Configuration file to read from.
  -h, --help            help for pilosa

Use "pilosa [command] --help" for more information about a command.

You’re good to go!

Build from Source

For advanced instructions for building from source, view our Contributor's Guide.

Install the prerequisites:
- Go. Be sure to set the $GOPATH and $PATH environment variables as described here.
- Git

Clone the repo:

mkdir -p ${GOPATH}/src/github.com/pilosa && cd $_
git clone https://github.com/pilosa/pilosa.git

Build the Pilosa repo (the make generate-statik line isn’t necessary but builds a nice webUI into Pilosa):
```
cd $GOPATH/src/github.com/pilosa/pilosa
make install-build-deps
make generate-statik
make install
```

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 https://www.pilosa.com/docs/.

Version: v0.10.1-64-gf053d9a5
Build Time: 2018-05-14T22:14:01+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 current configuration.
  export          Export data from pilosa.
  generate-config Print the default configuration.
  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.

Flags:
  -c, --config string   Configuration file to read from.
  -h, --help            help for pilosa

Use "pilosa [command] --help" for more information about a command.

You’re good to go!

Use Docker

Install Docker.
Confirm that the Docker daemon is running in the background:
```
docker version
```
If you don’t see the server listed, start the Docker application.
Pull the official Pilosa image from Docker Hub:
```
docker pull pilosa/pilosa:latest
```

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.

View markdown source on Github. Last updated 3 weeks ago.