YAML for sandboxes
Complete YAML reference for defining Buddy Sandboxes - resources, boot commands, apps, fetch sources, endpoints, variables, and permissions.
YAML examples for YAML for sandboxes
Minimal sandbox
yaml
- sandbox: my-sandbox
name: My Sandbox
os: noble
Sandbox with endpoints, variables, fetch, backup and permissions
yaml
- sandbox: prod-box
name: Production Box
os: ubuntu:24.04
resources: 3x6
first_boot_commands: |
#!/bin/bash
apt-get update
apt-get install -y nginx
tags:
- backend
- prod
app_dir: /app
apps:
- app: web
run_command: npm run start
path: /app/web
timeout: 3600
backup: DAILY
snapshot_retention:
keep_last: 10
endpoints:
- name: web
endpoint: localhost:8080
type: HTTP
region: EU
whitelist:
- 10.0.0.0/8
timeout: 300
http:
verify_certificate: true
compression: true
auth_type: BASIC
auth:
username: admin
password: secret
- tn1: 9090
variables:
- key: API_URL
value: https://api.example.com
type: VAR
note: Backend API URL
fetch:
- repository: https://github.com/acme/app.git
ref: main
path: /app/src
- artifact: acme-assets:latest
path: /app/public
source_path: dist.zip
permissions:
others: DENIED
users:
dev@example.com: READ_WRITE
groups:
admins: READ_WRITE
pipelines:
- all: DENIED
- project: my-project
pipeline: deploy
access: USE_ONLY
sandboxes:
- project: my-project
sandbox: base
access: USE_ONLY