Skip to main content
A workspace config describes one virtual terminal. mounts is the only required key:
workspace.yaml
Keys are snake_case; TypeScript constructor options use camelCase, such as commandLimits. Unknown keys are errors. A template saved on the server takes the same document.

Workspace settings

Mount settings

Each mount key is an absolute prefix, such as /data. Its value is a block of the keys below, or "@<machine>": that machine’s own files at the same path, as /tmp: "@gpu" shows the gpu machine’s /tmp. The name must be one under machines:. See Machine Files.

Network

  • A denied entry wins over an allowed one.
  • A refused connection fails like a closed port: curl exits 7.
  • Mounts connect under the same rules. A profile can narrow them, and routes redirect a host.
  • Programs on a machine connect under the machine’s own network. A host machine refuses to run while network limits anything.
  • In a browser or on an edge runtime, only host names are checked, and a denied_domains address or range is refused. Deny host names there.

System time

The clock starts at that time and runs forward. date, file times, find -mtime, git commits and the Monty, WASI, Pyodide and QuickJS runtimes see it. Programs on a host machine see it only through libfaketime. TZ picks the zone, UTC by default. Without system_time, the workspace uses the server’s clock.

CLI entries

Each clis key is the command name. An entry takes cli or script, and a machine:

State and caches

A cache or index block needs a type. A store without one keeps in memory each part (namespace, sessions, logs, execution) that names no store of its own.

Values and paths

  • ${NAME} takes the value from the environment when the config loads. A missing variable is an error. mirage workspace create fills it in before sending; the server never does.
  • Script paths resolve from the config file’s folder.

Sizes

A size is bytes, or a number with K, M or G and an optional B. K is 1024 bytes. 1.5GB, 100 MB and 100MiB are refused.