external
/
citus
mirror of https://github.com/citusdata/citus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1263 from citusdata/docker-engine 

Newer docker installation instructions

cr: @jasonmp85
pull/1272/head
Jason Petersen 2017-03-08 16:18:49 -07:00 committed by GitHub
parent c8c308c109 b2dd568dba
commit e060252431
1 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -46,25 +46,34 @@ Citus Cloud runs on top of AWS as a fully managed database as a service and has
If you're looking to get started locally, you can follow the following steps to get up and running. If you're looking to get started locally, you can follow the following steps to get up and running.
* Install docker-compose: [Mac][mac_install] | [Linux][linux_install] 1. Install Docker Community Edition and Docker Compose
* (Mac only) connect to Docker VM * Mac:
```bash 1. [Download](https://www.docker.com/community-edition#/download) and install Docker.
eval $(docker-machine env default) 2. Start Docker by clicking on the application’s icon.
``` * Linux:
```bash
curl -sSL https://get.docker.com/ | sh
sudo usermod -aG docker $USER && exec sg docker newgrp `id -gn`
sudo systemctl start docker
* Pull and start the docker images sudo curl -sSL https://github.com/docker/compose/releases/download/1.11.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
```
The above version of Docker Compose is sufficient for running Citus, or you can install the [latest version](https://github.com/docker/compose/releases/latest).
1. Pull and start the Docker images
```bash ```bash
wget https://raw.githubusercontent.com/citusdata/docker/master/docker-compose.yml curl -sSLO https://raw.githubusercontent.com/citusdata/docker/master/docker-compose.yml
docker-compose -p citus up -d docker-compose -p citus up -d
``` ```
* Connect to the master database 1. Connect to the master database
```bash ```bash
docker exec -it citus_master psql -U postgres -d postgres docker exec -it citus_master psql -U postgres
``` ```
* Follow the [first tutorial][tutorial] instructions 1. Follow the [first tutorial][tutorial] instructions
* To shut the cluster down, run 1. To shut the cluster down, run
```bash ```bash
docker-compose -p citus down docker-compose -p citus down
@ -78,7 +87,7 @@ If you're looking to get started locally, you can follow the following steps to
<tr> <tr>
<td>Documentation</td> <td>Documentation</td>
<td>Try the <a <td>Try the <a
href="https://docs.citusdata.com/en/v6.1/tutorials/tut-hash-distribution.html">Citus href="https://docs.citusdata.com/en/stable/tutorials/multi-tenant-tutorial.html">Citus
tutorial</a> for a hands-on introduction or <br/>the <a tutorial</a> for a hands-on introduction or <br/>the <a
href="https://docs.citusdata.com">documentation</a> for href="https://docs.citusdata.com">documentation</a> for
a more comprehensive reference.</td> a more comprehensive reference.</td>
@ -142,6 +151,4 @@ ___
Copyright © 2012–2017 Citus Data, Inc. Copyright © 2012–2017 Citus Data, Inc.
[faq]: https://www.citusdata.com/frequently-asked-questions [faq]: https://www.citusdata.com/frequently-asked-questions
[linux_install]: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-14-04 [tutorial]: https://docs.citusdata.com/en/stable/tutorials/multi-tenant-tutorial.html
[mac_install]: https://www.docker.com/products/docker-toolbox
[tutorial]: https://docs.citusdata.com/en/v6.1/tutorials/tut-hash-distribution.html