Discovery

Discovery takes a server and a path, reads the project’s files and returns proposed routes with labels and roles, plus advisories. It saves typing. It is not a requirement, and a project it knows nothing about works once you enter its ports. On a remote server the files are read over SFTP through the server’s SSH master. No shell commands run on the remote machine. For local they are read from disk.

What is read, in order

Later sources override the labels of earlier ones.

1. .env, then .env.local.
2. docker-compose.yml, docker-compose.yaml, compose.yml, compose.yaml.
3. vite.config.js, vite.config.ts, vite.config.mjs, vite.config.mts.
4. package.json. Only the presence of a vite dependency is used.

Framework presets

Compose files and Vite configs cover most projects without any preset. Laravel Sail is the first framework with one. Its variables map to labels and roles:

• APP_PORT
• VITE_PORT
• FORWARD_DB_PORT
• FORWARD_REDIS_PORT
• FORWARD_MAILPIT_PORT
• FORWARD_MAILPIT_DASHBOARD_PORT
• FORWARD_MEILISEARCH_PORT
• FORWARD_TYPESENSE_PORT
• FORWARD_MINIO_PORT
• FORWARD_MINIO_CONSOLE_PORT
• FORWARD_MONGODB_PORT

When a variable is absent but its service is present in Compose, the default from the Sail stubs applies. Outside Sail, a Compose port that reads a variable is labelled with the service and the variable name.

Compose ports

Each ports: entry is parsed for its host port. The ${VAR:-default} syntax is resolved against the values in .env. A literal port is labelled with its service name.

Vite config

The file is scanned with regular expressions for server.port, server.hmr, server.allowedHosts and server.https. No JavaScript is executed or parsed.

When nothing is found

Anything unrecognised is still listed, with the role ignore. If discovery finds nothing at all, the add-project wizard lets you enter ports by hand.

Discovery also produces advisories, which are shown and never applied. See Advisories.