This repository provides a docker-compose.yml to build and run a terriamap instance for showcasing fair-ease results. It does so by providinga local config and local data files (and fair-ease branding changes)
We recommend using git+ssh -- see documentation on how to use ssh when connecting to github
To automate the build we use make. Check if you have it through
$ make --versionThis also uses docker and docker compose. You will want to make sure the latter has version 2 or higher.
$ docker compose version# git-checkout
$ git clone [email protected]:fair-ease/terria-config.git # note we recommend using proport git-ssh key setup - alternatively use the https://... uri
$ git submodule update --init --recursive # checks out the submodule - needed in case you want to use the local build image
# enter the project
$ cd terria-config
# copy and change .env and .secrets
$ cp example.dot.env .env && vi .env
$ cp example.dot.secrets .secrets && vi .secrets
# select / build the terriamap docker image by either option 1/2
# option 1. build locally
$ make dc
# option 2. select the published one
$ export REG_NS=ghcr.io/terriajs/terriamap #you could also add this to your local .env file
# run the stack
$ make dc-start
In the .secrets file you can specify any personal api_tokens or credentials to be injected through ${VARNAME} into the ./wwwroot/config.json
See example.dot.secrets for some available variables and their meaning.
In the .env file you can specify a number of distinct alternative to common defaults. Most of these are infecting the workings of the docker-compose.yml and can be verified over there.
See example.dot.env for some available variables and their meaning.