scriptoriumadmin/featurebase
1
0
Fork 0
mirror of https://github.com/featurebasedb/featurebase.git synced 2026-08-28 10:54:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

made docker its own section

Browse source
This commit is contained in:
Yuce Tekol 2019-01-16 20:58:52 +03:00
parent e4e338e7f9
commit 0542f79442
No known key found for this signature in database
GPG key ID: CB59E46D2FB90573
1 changed files with 54 additions and 71 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

125
docs/installation.md
View file

@ -14,7 +14,7 @@ Pilosa is currently available for [MacOS](#installing-on-macos) and [Linux](#ins
### Installing on MacOS
There are four ways to install Pilosa on MacOS: Use [Homebrew](https://brew.sh/) (recommended), download the binary, build from source, or use Docker.
There are four ways to install Pilosa on MacOS: Use [Homebrew](https://brew.sh/) (recommended), download the binary, build from source, or use [Docker](#docker).
#### Use Homebrew
@ -188,53 +188,6 @@ There are four ways to install Pilosa on MacOS: Use [Homebrew](https://brew.sh/)
You're good to go!
#### Use Docker
1. Install Docker for your platform. On Linux, Docker is available via your package manager. On MacOS, you can use Docker for Mac or Docker Toolbox. On Windows, you can use Docker for Windows or Docker Toolbox.
2. **This step is necessary only if you are using Docker Toolbox**, otherwise skip to step 3:
a. Start the Docker support using `docker-machine start` in a terminal. The environment variables of the terminal should be updated accordingly, run `docker-machine env` to display the necessary commands.
b. Set up port forwarding in the VirtualBox GUI or on the command line. Guest port should be 10101. For the host port, 10101 is recommended. If the `VBoxManage` command is in your `PATH`, you can use the following command (assuming you use the default VM):
```
VBoxManage modifyvm "default" --natpf1 "pilosa,tcp,,10101,,10101"
```
3. Confirm that the Docker daemon is running in the background:
```
docker version
```
If you are getting a "command not found" or similar, check that `docker` command is in your path. If you don't see the server listed, start the Docker application.
4. Pull the official Pilosa image from Docker Hub:
```
docker pull pilosa/pilosa:latest
```
5. Make sure Pilosa is installed successfully, and make it accessible:
```
docker run -d --rm --name pilosa -p 10101:10101 pilosa/pilosa:latest server --bind 0.0.0.0:10101
```
6. Check that it is accessible from outside the container.
Run the following in a separate terminal:
```
curl localhost:10101/schema
```
If that returns `{"indexes":null}` or similar, then Pilosa is accessible from outside the container. Otherwise check that you have correctly typed `-p 10101:10101` when running the Pilosa container and the port mappings in VirtualBox is correct (Docker Toolbox only).
7. When you want to terminate the Pilosa container, you can run the following:
```
docker stop pilosa
```
#### What's next?
Head over to the [Getting Started](../getting-started/) guide to create your first Pilosa index.
@ -242,7 +195,7 @@ Head over to the [Getting Started](../getting-started/) guide to create your fir
### Installing on Linux
There are three ways to install Pilosa on Linux: download the binary (recommended), build from source, or use Docker.
There are three ways to install Pilosa on Linux: download the binary (recommended), build from source, or use [Docker](#docker).
#### Download the Binary
@ -365,28 +318,6 @@ There are three ways to install Pilosa on Linux: download the binary (recommende
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](../getting-started/) guide to create your first Pilosa index.
@ -397,3 +328,55 @@ Head over to the [Getting Started](../getting-started/) guide to create your fir
Windows is currently not supported as a target deployment platform for Pilosa, but developing and running Pilosa is made possible by Docker. See the [Docker](#docker) documentation for using Docker for Windows and Docker Toolbox.
Windows Subsystem for Linux is currently not supported.
### Docker
1. Install Docker for your platform. On Linux, Docker is available via your package manager. On MacOS, you can use Docker for Mac or Docker Toolbox. On Windows, you can use Docker for Windows or Docker Toolbox.
2. **This step is necessary only if you are using Docker Toolbox**, otherwise skip to step 3:
a. Start the Docker support using `docker-machine start` in a terminal. The environment variables of the terminal should be updated accordingly, run `docker-machine env` to display the necessary commands.
b. Set up port forwarding in the VirtualBox GUI or on the command line. Guest port should be 10101. For the host port, 10101 is recommended. If the `VBoxManage` command is in your `PATH`, you can use the following command (assuming you use the default VM):
```
VBoxManage modifyvm "default" --natpf1 "pilosa,tcp,,10101,,10101"
```
3. Confirm that the Docker daemon is running in the background:
```
docker version
```
If you are getting a "command not found" or similar, check that `docker` command is in your path. If you don't see the server listed, start the Docker application.
4. Pull the official Pilosa image from Docker Hub:
```
docker pull pilosa/pilosa:latest
```
5. Make sure Pilosa is installed successfully, and make it accessible:
```
docker run -d --rm --name pilosa -p 10101:10101 pilosa/pilosa:latest server --bind 0.0.0.0:10101
```
6. Check that it is accessible from outside the container.
Run the following in a separate terminal:
```
curl localhost:10101/schema
```
If that returns `{"indexes":null}` or similar, then Pilosa is accessible from outside the container. Otherwise check that you have correctly typed `-p 10101:10101` when running the Pilosa container and the port mappings in VirtualBox is correct (Docker Toolbox only).
7. When you want to terminate the Pilosa container, you can run the following:
```
docker stop pilosa
```
#### What's next?
Head over to the [Getting Started](../getting-started/) guide to create your first Pilosa index.