This page will walk you through installing Score using Docker. Ensure you've completed all the applicable prerequisite steps before starting the installation.
Before you proceed with the Score installation, be aware that there are several configurations for a Score server:
Component | Description | Requirement |
---|---|---|
Run Profiles | Define how your Score server operates. | Required |
Song | Connect Score with your Song server. | Required |
Object Storage | Integrate your object storage provider with Score. | Required |
HashiCorp's Vault | Configure HashiCorp Vault to manage and protect your keys. | Optional |
For detailed information on configuration options and guidelines, including setting up your environment variables file, see our section on Configurations section.
Based on your configuration, create an .env.score
file with the necessary environment variables. Replace placeholders like {{ego-host-url}}
with your actual values. Here's an example of the .env.score
file:
# ============================# Spring Run Profiles (Required)# ============================# Active profiles to determine app behavior & configsSPRING_PROFILES_ACTIVE=prod,aws,secure# Server configurationSERVER_PORT=8087SERVER_SSL_ENABLED=false# LoggingLOGGING_LEVEL_ORG_SPRINGFRAMEWORK_WEB=INFOLOGGING_LEVEL_BIO_OVERTURE_SCORE_SERVER=INFOLOGGING_LEVEL_ROOT=INFO# ============================# Server Authentication integration (Required)# ============================AUTH_SERVER_URL=http://host.docker.internal:9082/o/check_api_key/AUTH_SERVER_TOKENNAME={{API-Key}}AUTH_SERVER_CLIENTID=scoreAUTH_SERVER_CLIENTSECRET=abc123AUTH_SERVER_SCOPE_STUDY_PREFIX=score.AUTH_SERVER_SCOPE_UPLOAD_SUFFIX=.WRITEAUTH_SERVER_SCOPE_DOWNLOAD_SUFFIX=.READAUTH_SERVER_SCOPE_DOWNLOAD_SYSTEM=score.READAUTH_SERVER_SCOPE_UPLOAD_SYSTEM=score.WRITE# ============================# Song Integration (Required)# ============================METADATA_URL=http://host.docker.internal:8080# ============================# Storage Integration (Required)# ============================S3_ENDPOINT=http://host.docker.internal:8085S3_ACCESSKEY=minioS3_SECRETKEY=minio123S3_SIGV4ENABLED=trueOBJECT_SENTINEL=heliographBUCKET_NAME_OBJECT=oicr.icgc.testBUCKET_NAME_STATE=oicr.icgc.testCOLLABORATORY_DATA_DIRECTORY=dataUPLOAD_PARTSIZE=1073741824UPLOAD_CONNECTION_TIMEOUT=1200000
This environment variable file is subject to change depending on your deployment scenario, details can be found within the configuration section
Following the configuration of your environment variables, start the Score container using the docker run
command, specifying your mounted .env.score
file:
For Linux (Recommended)
docker run --env-file .env.score --network=host -d -p 8087:8087 ghcr.io/overture-stack/score-server:latest
For Mac and Windows
docker run --env-file .env.score -d -p 8087:8087 ghcr.io/overture-stack/score-server:latest
Score should now be running with the swagger-ui accessible from: http://localhost:8087/swagger-ui.html#/
To facilitate interactions between your local machine and the Score server we recommend setting up the Score Client.