Getting Started

QuickStart screenshot

1. Download and configure Docker Desktop (4.32.0+)

In Docker Desktop click the cog icon , then resources. We recommend at minimum setting your CPU limit to 8, memory to 8GB, swap to 4GB, with 64GB of virtual disk space available. If you have Docker already installed ensure it is up to date.

2. Clone the QuickStart Repository

git clone https://github.com/overture-stack/composer.git && cd composer

3. Run the Docker Compose

docker compose up --attach conductor
Your portal will now be accessible from your: localhost:3000

Overture Quickstart screenshot

Explore Our Resources

Guides and documentation to get you started using our platform

Platform Guides

Stepwise tutorials for practical insight and hands-on experience using the Overture platform

  • Deployment: generalized instructions for deploying our platform from start to finish
  • Submission:stepwise instructions on submitting data to our platform
  • Download: stepwise instructions on downloading data from our platform
  • Administration: detailed stepwise instructions for customizing your platform

Product Documentation

Detailed product documentation for administrators and developers

  • Ego: authentication and authorization for users and applications
  • Song: data management with automated submission validations
  • Score: secure multipart file transfers to and from object storage
  • Maestro: indexes published Song metadata into Elastisearch
  • Arranger: search API generation with customizable UI component library
  • Stage: react-based portal UI made to integrate with Overture services

Help us make our docs better

If you can't find what you are looking for, please submit a GitHub request

Connect with Our Community

Join us in contributing software tools that accelerate scientific discovery.

Get help, share knowledge, and stay current.