Skip to main content

Deploy Metadata Capture

Deploy your own instance of the Metadata Capture application to give your organisation complete control over the application.

In this guide

Prerequisites
Configure your environment
Deploy the application

Prerequisites​

The Metadata Capture application integrates with your organisations existing tools and infrastructure as described in the architecture overview. Before you begin deployment, prepare your environment:

  • Provision a virtual machine (VM) or cloud instance to host the application.
  • Install Docker to build, run, and manage application containers.
  • Set up a managed PostgreSQL database instance. Ensure the database is accessible and configured for secure connections.
  • Configure an OpenID Connect (OIDC) provider to manage user authentication and access control.
  • Set up an SMTP server to send notification emails to users.

Configure your environment​

  1. Download and copy the environment configuration template to your deployment environment: .env.example.
  2. Rename the file to .env and update the mandatory environment variables to match your environment settings.
  3. Configure the application.

Deploy the application​

After you complete the configuration for the application, you can deploy Metadata Capture:

  1. Get the latest release:

    git checkout tags/v4.0.1

  2. Build the Docker image:

    docker build -t <your-app-name> .

    For example:

    docker build -t metadata-capture .

  3. Initialize the database:

    docker run --env-file .env <your-app-name> alembic upgrade head

  4. Start the application:

    docker run -d --env-file .env -p 8000:8000 <your-app-name>

    To open your Metadata Capture application, open your browser and go to http://localhost:8000.