Configuring Score for Docker Install

Prerequisite

The following sections outline configuring and running Score as a docker image. Before beginning, please make sure that you have Docker installed and running. You can follow the Official Docker Engine download & installation instructions or download and install the Docker desktop application.

Song Setup

Score interacts with a required companion application, Song, which validates, catalogues and manages all the metadata associated with the file data that Score transfers. Please note that although both services are needed, there is no necessary order of installation required.

Configuration Overview

All configurations for Score are centralized in a single environment variable file (.env.score). These configurations are essential for linking Score with other services.

There are three primary steps for a successful Score configuration:

  1. Integrating Score with a Song Server
  2. Connecting Score with your Object Storage provider
  3. Setting up Score with an authentication and authorization service

Optionally, Score can also be configured to work with HashiCorp's Vault service.

Setting up your environment variables

To begin, create a file and name it .env.score. Copy an paste the following template.

ENV
# ============================
# Spring Run Profiles (Required)
# ============================
# Active profiles to determine app behaviour & configs
SPRING_PROFILES_ACTIVE=collaboratory,prod,secure
# Server configuration
SERVER_PORT=8087
SERVER_SSL_ENABLED=false

The following sections will provide details to expand and complete your env.score file.