Skip to content
lokl

Config File

lokl uses a YAML configuration file, typically named lokl.yaml, to define your development environment.

Basic Structure

Section titled “Basic Structure”
name: my-project
version: "1"


proxy:
  domain: myproject.dev


env:
  NODE_ENV: development


services:
  service-name:
    command: ...
    port: ...

Top-level Fields

Section titled “Top-level Fields”

name

Section titled “name”

Required. Project name used for identification and DNS markers.

name: my-awesome-project

version

Section titled “version”

Config file version. Currently "1".

version: "1"

proxy

Section titled “proxy”

Proxy configuration for HTTPS routing.

proxy:
  domain: myproject.dev

env

Section titled “env”

Global environment variables inherited by all services.

env:
  NODE_ENV: development
  DEBUG: "true"

services

Section titled “services”

Map of service definitions. See Services for details.