Skip to content

Installation

Setup for Devs

git clone git@github.com:Woosmap/zoidberg.git
cd zoidberg

Build it and install it in your $GOPATH/bin:

make install

Or run it from the source code:

go run ./cmd/zoidberg --help

Setup for non-Devs

You can find the latest release on the releases page. Download the .tgz matching the version you want and your OS architecture. The archive contains a binary named zoidberg, a README.md and a .env file that you have to edit.

Open a terminal in the directory where you extracted the binary and run:

./zoidberg --help

Configure your keys

To run the tests Zoidberg needs your Woosmap API keys (one per environment). You can set them via OS environment variables, or in a .env-style file. When loading from a file, Zoidberg checks these locations in order and uses the first one it finds:

  1. zoidberg.env in the directory passed to --dataDir
  2. .env in the directory passed to --dataDir
  3. .env in the working directory

Values already present in the OS environment are always used.

WOOSMAP_DEVELOP_API_KEY=change_me
WOOSMAP_PROD_API_KEY=change_me

For a custom environment (e.g. your local one), set both the key and the base URL:

WOOSMAP_ENVNAME_API_KEY=change_me
WOOSMAP_ENVNAME_BASEURL=http://localhost