Deplexo Configuration

Add a deplexo.yaml file to your application’s root directory to configure how Deplexo builds and runs your app. All fields are optional — Deplexo auto-detects your framework and picks sensible defaults.

Quick start

Create deplexo.yaml in your application’s root directory:

# deplexo.yaml
framework: auto    # or node, python, go, ruby, rust, java, php, elixir, static
port: 3000
install: npm ci
build: npm run build
start: npm start

Commit and push. On next deploy, Deplexo reads this file and uses your settings. Dashboard framework and command settings override the corresponding values in deplexo.yaml. For a monorepo, choose the Root directory in the dashboard.

Configuration priority

For framework selection and install, build and start commands, the highest priority wins:

Dashboard>deplexo.yaml>Auto-detect

All fields

FieldTypeDescription
frameworkstringFramework to use for building. Options: auto, node, python, go, ruby, rust, java, php, elixir, static, dockerfile. Default: auto (detects from repo files).
portnumberPort used in generated build configuration. Set the PORT environment variable in the dashboard to match your app’s listener and routing port.
installstringCustom install command. Replaces the auto-detected install step (e.g. npm ci, pip install).
buildstringCustom build command. Runs after install (e.g. npm run build, go build).
startstringCustom start command. Becomes the container CMD (e.g. node server.js, gunicorn app:app).
dockerfilestringPath to a custom Dockerfile. When set, skips framework detection and uses this file directly.

Framework examples

Choose a framework to see an example build configuration. Select a framework to see its deplexo.yaml example.

Auto-detects npm, yarn, pnpm, or bun from lock files. Detects Next.js, Vite, and Express for smart defaults.

framework: node
install: npm ci
build: npm run build
start: npm start
port: 3000

Build caching

Deplexo can reuse dependencies and unchanged build layers to speed up repeat deployments. Cache availability and build times depend on your framework, configuration and changes.

Keep dependency files separate from frequently changing source files to make better use of caching.

Tips

  • Set the PORT environment variable in the dashboard to match the port your app listens on. Routing defaults to 3000 if it is not set.
  • Environment variables set in the dashboard are injected at runtime, not during build. Keep committed build commands free of passwords, tokens and other secrets.
  • If auto-detection picks the wrong framework, set framework explicitly in deplexo.yaml or choose it in the dashboard when deploying.
  • For full control, set framework: dockerfile or add a Dockerfile to your repo and select "Dockerfile" as the build method.
  • Never put secrets in deplexo.yaml — it's committed to your repo. Use the dashboard's environment variables (encrypted at rest) for API keys, database URLs, etc.

Cookie choices

We use essential cookies to keep the site working. Cookieless page counts run automatically. Performance measurements are optional and only run with your consent.

Cookie policy