Skip to content

Latest commit

 

History

History
82 lines (60 loc) · 2.72 KB

DOCKER_README.MD

File metadata and controls

82 lines (60 loc) · 2.72 KB
Raw

This guide shows our recommended recommended way of installing Docker on your OS X machine.

Install docker

First install Docker using Homebrew

$ brew install docker

You can install Docker Desktop if you wish, or use the docker-machine command to work with your Docker containers. This guide assumes you use the docker-machine command.

Setup your Docker

Install docker-machine

$ brew install docker-machine

Then install VirtualBox using Homebrew Cask to get a driver for your Docker machine

$ brew cask install virtualbox

You may need to enter your password and authorize the application through System Settings > Security & Privacy.

Create a new machine, and set it up as default, and connect your shell to the machine with the following commands:

$ docker-machine create --driver virtualbox default
$ docker-machine env default
$ eval "$(docker-machine env default)"

Now you're all setup to use our provided Docker image!

Build the image

docker build -t algolia-go .

Run the image

You need to provide few environment variables at runtime to be able to run the Common Test Suite. You can set them up directly in the command

docker run -it --rm --env ALGOLIA_APPLICATION_ID_1=XXXXXX [...] algolia-go bash

But we advise you export them in your .bashrc or .zshrc. That way, you can use Docker's shorten syntax to retrieve your variables.

### For external contributors, only the following env variables should be enough
docker run -it --rm --env ALGOLIA_APPLICATION_ID_1 \
                    --env ALGOLIA_ADMIN_KEY_1 \
                    --env ALGOLIA_SEARCH_KEY_1 \
algolia-go bash

### This is needed only to run the full test suite
docker run -it --rm --env ALGOLIA_APPLICATION_ID_1 \
                    --env ALGOLIA_ADMIN_KEY_1 \
                    --env ALGOLIA_SEARCH_KEY_1 \
                    --env ALGOLIA_APPLICATION_ID_2 \
                    --env ALGOLIA_ADMIN_KEY_2 \
                    --env ALGOLIA_APPLICATION_ID_MCM \
                    --env ALGOLIA_ADMIN_KEY_MCM \
algolia-go bash

Once the container is up, you can edit files directly in your IDE: changes will be mirrored in the image.

Lastly to launch the tests, you can use one of the following commands

# run the unit tests
make unit-tests

# run the integration tests
make integration-tests

Feel free to contact us if you have any questions.