Official bootstrap for spinning up your own Metamapper instance with Docker and Docker-Compose.

To get started, we recommend you fork this repo and run the following command:

./setup.sh

Once the bootstrap has completed, you should be able to run:

docker-compose up -d

Then you can access the web UI from whatever port (default: 5050) is specified in your gunicorn.py configuration.

We publish to two separate Docker Hub repositories during our build process.

Stable builds are published as point releases to getmetamapper/metamapper. We recommend this as your starting point when deploying your own Metamapper instance.

You can specify what image of Metamapper you want to install with the METAMAPPER_IMAGE variable.

METAMAPPER_IMAGE=getmetamapper/metamapper METAMAPPER_VERSION=latest ./setup.sh

We also maintain a development image at metamapper/preview. These builds contain the latest – but potentially unstable – features available. Use this if you want to be on the bleeding edge and help us debug our codebase before an official release.

Preview releases are tagged with the first 7 characters of the last commit hash.

You can specify what version of Metamapper you want to install with the METAMAPPER_VERSION variable:

METAMAPPER_IMAGE=getmetamapper/preview METAMAPPER_VERSION=35b182c ./setup.sh

We offer some configuration files to some of the libraries that Metamapper uses to function. These files are generated and placed in the conf directory as part of setup.sh script.

Metamapper uses gunicorn to serve web requests. You can customize any aspect of Gunicorn via the gunicorn.py configuration file.

Metamapper uses celery to handle async task processing. You can customize the Celery configuration via the celery.py configuration file.

Metamapper is a Django application. Much of the configuration is done in the django.conf.settings module.

You can override any setting in this file using the settings.py file generated during the installation process. However, do this with extreme caution, as it could break your build.

Code that is added into this module is added directly into the Metamapper source code on your Docker image. This means that it is accessible by different parts of the application.

For example, Metamapper uses Elasticsearch for quickly searching all of your data assets.

You could, however, roll out your own search backend, place it in the contrib module, and update the reference to that module using the METAMAPPER_SEARCH_BACKEND environment variable. Regardless of what happens behind the scenes, it should work as expected as long as the backend exposes the same abstract interface.

We currently expose the following backends as configurable:

We provide an empty requirements.txt that you can update with an dependencies that your contrib module needs. It is automatically installed via pip at the end of the Docker build process:

RUN if [ -s /usr/local/metamapper/metamapper/requirements.txt ]; \
    then pip install -r /usr/local/metamapper/metamapper/requirements.txt; fi

• Issue Tracker
• Code