scottbell / openmct-quickstart

Get started with Open MCT

Open MCT QuickStart

This repository contains a quick way to get started with Open MCT, integrated with:

• Open MCT
• CouchDB
• YAMCS
• Apache HTTP Server

Prerequisites

• Docker

Getting Started

1. Clone this repository
2. cd to the repository directory (usually openmct-quickstart)
3. Run docker compose up
4. Wait a bit for the containers to start ⏱️
5. Open a browser to http://localhost:8040
6. Enter the username/password testuser/NasaIsCool!

Nuts and Bolts

The docker-compose.yml file in this repository defines a set of containers that work together to provide a complete Open MCT environment. The containers are:

• openmct - Builds the Open MCT web application into a shared volume (and quits)
• couchdb - The CouchDB database used by Open MCT to persist objects created by the operator.
• yamcs - The YAMCS telemetry & commanding server used by Open MCT to retrieve telemetry data.
• simulator - A simple python simulator that generates telemetry data for YAMCS to serve.
• apache - The Apache HTTP server used to serve the Open MCT web application, and to proxy requests to YAMCS and CouchDB.

Hosted websites are available at the following URLs:

• The OpenMCT web application is served from http://localhost:8040
• The YAMCS web application is served from http://localhost:8040/yamcs
• The Apache server status is served from http://localhost:8040/server-status
• The CouchDB web application is served from http://localhost:8040/couchdb/_utils (with username admin and password password)

Diagram

graph TD
    A[Apache HTTP Server] -- serves --> B[Open MCT Web Application]
    A -- proxies --> C[CouchDB Database]
    A -- proxies --> D[YAMCS Telemetry & Commanding Server]
    E[Python Simulator] -- generates telemetry data --> D
    F[Docker Compose] -- orchestrates --> A
    F -- orchestrates --> B
    F -- orchestrates --> C
    F -- orchestrates --> D
    F -- orchestrates --> E

    B -- "HTTP Traffic & JSON Storage" --> C
    D -- "HTTP Traffic & JSON Storage" --> B

    click B "http://localhost:8040" "OpenMCT Web Application"
    click C "http://localhost:8040/couchdb/_utils" "CouchDB"
    click D "http://localhost:8040/yamcs" "YAMCS"
    click A "http://localhost:8040/server-status" "Apache Server Status"