Usage

The following usage docs provide instructions for common tasks and workflows in Score:

📄️ File Upload

Data uploads using the Client or API.

📄️ File Download

Data download using the Score Client.

📄️ Object Storage Setup

To set up your object storage for Score:

📄️ Configuring Keycloak

There are multiple methods of deploying Keycloak. Documentation on Keycloak deployment can be found on the Official Keycloak website.

📄️ Vault Integration

HashiCorp's Vault provides secure secret management and can be integrated with Score for enhanced security. This section covers how to configure Score to work with Vault.

📄️ API Reference

Scores API is a RESTful API that uses JSON for request and response bodies. It follows standard HTTP methods and status codes, providing a robust interface for managing score-related data in the Overture platform.

📄️ Client Reference

Commands and options supported by the Score client.

Score Terminology

Whether you're new to these tools or looking to refresh your understanding, this glossary is here as a reference of key terms and concepts.

• Score Client: A command-line tool used to interact with the Score server for uploading and downloading data files.

• Manifest: A file that establishes a link between an analysis ID and the data files on your local system, used by Score for file uploads and downloads.

• Object ID: A unique identifier assigned to each file object stored in object storage.

• MD5 Checksum: A cryptographic hash function used to verify the integrity of files during upload and download processes.