featurebase/docs/installation.md at ba0eff4ffefe6489323c49bfe66e573c19b82817

scriptoriumadmin/featurebase

Fork 0

mirror of https://github.com/featurebasedb/featurebase.git synced 2026-08-28 10:54:59 +00:00

Ben Johnson 1c34ea7f8f

Add sorting flag to import command.

2017-06-08 11:00:02 -06:00

9.8 KiB

Raw Blame History

+++ title = "Installation" +++

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

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.

Extract the binary:

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

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
```

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.

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

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
Clone the repo:
```
go get -d github.com/pilosa/pilosa
```

Build the Pilosa repo:

cd $GOPATH/src/github.com/pilosa/pilosa
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 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.

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

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.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.

Extract the binary:

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

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
```

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.

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

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
Clone the repo:
```
go get -d github.com/pilosa/pilosa
```

Build the Pilosa repo:

cd $GOPATH/src/github.com/pilosa/pilosa
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 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.

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

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.

9.8 KiB Raw Blame History

Installation

Installing on MacOS

Download the Binary

Build from Source

Use Docker

What's next?

Installing on Linux

Download the Binary

Build from Source

Use Docker

What's next?

9.8 KiB

Raw Blame History