Orchestration

In addition to the commands described in the getting started guide, Mutagen provides two automation and orchestration mechanisms: integration with Docker® Compose and a more generic project mechanism.

Compose

If you’re using a Compose-based containerized development workflow, then the best way to use Mutagen is by integrating it with your Docker Compose workflow. Mutagen provides a wrapper around Docker Compose that uses x-mutagen attributes in your Compose YAML files to automatically start and stop synchronization and forwarding sessions that target your Compose volumes and networks. This allows you to replace bind mounts and exposed ports and enables you to run your project on a cloud-based Docker host while still editing code and accessing your application locally.

Projects

If you’re not using Docker Compose, or if you have more specific requirements, Mutagen also offers a more generic project mechanism that allows you to automate the creation and termination of synchronization and forwarding sessions.