Flowmaker SDK [beta]Docs
search
GitHub

Start Instance (./fm up)

Starts a FlowMaker instance using Docker Compose with optional worker.

./fm up <name> [options]

Options

Option Description
--workers Start worker services from docker-compose.workers.yml
--local Skip image pulls (--pull never)

Examples

Start Core Services Only

$ ./fm up dev
✓ Instance 'dev' is running

Available services:
  Frontend:   https://frontend.dev.flowmaker.localhost
  ConfigHub:  https://confighub.dev.flowmaker.localhost
  Logger:     https://logger.dev.flowmaker.localhost

Start with Workers

$ ./fm up dev --workers
✓ Instance 'dev' is running

Available services:
  Frontend:   https://frontend.dev.flowmaker.localhost

Behavior

[WARNING!warning/WORKERS NOT INCLUDED BY DEFAULT] Worker services are not started unless you use --workers.

Compose Files Used:

  • docker-compose.yml (always)
  • docker-compose.datacatalog.yml (always)
  • docker-compose.workers.yml (if --workers)
  • instances/<name>/docker-compose.override.yml (if exists)

Docker Compose Project Name: fm-<instance> (e.g., fm-dev)

Service URLs

Service URL Pattern
Frontend frontend.<domain>
ConfigHub confighub.<domain>
Logger logger.<domain>
Scheduler scheduler.<domain>
DataCatalog API datacatalog-api.<domain>
CDN cdn.<domain>

Common Workflows

Development with Full Stack

Offline Development

./fm up dev --workers

Troubleshooting

Services Not Starting

./fm up dev --workers 2>&1 | tee /tmp/fm-up.log
docker images | grep flowmaker

Caddy Not Routing

./fm caddy:rebuild
./fm caddy:logs

References