Meltano UI

Meltano is optimized for usage through the meltano CLI and direct changes to the meltano.yml project file.

However, a web-based UI is also available for when you want to quickly check the status and most recent logs of your project’s scheduled pipelines, or if you want to give less technical team members or clients the option to configure their extractors, loaders, and pipelines themselves.

Various settings are available that let you configure the Meltano UI server, enable and disable features, and customize its appearance.

Current status #

Basic functionality around managing and configuring plugins and monitoring pipelines is available, as is an experimental Analysis feature, but many (newer) features of the CLI do not yet have a UI equivalent.

Missing functionality and other improvements are being tracked in the “Pipeline management and monitoring UI” epic, and new issues and contributions from the community are more than welcome, but the team is not currently prioritizing improvements to the UI because of the heavy focus on the CLI.

Usage during development #

Start the Meltano UI web server using meltano ui:

meltano ui

Unless configured otherwise, the UI will now be available at http://localhost:5000.

Docker Compose #

If you’d like to use Docker Compose to manage the Meltano UI application lifecycle, you can add the appropriate docker-compose.yml file to your project by adding the docker-compose file bundle:

# For these examples to work, ensure that
# Docker Compose has been installed
docker-compose --version

# Add Docker Compose files to your project
meltano add files files-docker-compose

# Start the `meltano-ui` service in the background
docker-compose up -d

Unless configured otherwise, the UI will now be available at http://localhost:5000.

For more details and instructions, refer to README contained in the file bundle.