Skip to main content

Local Quickstart

This guide gets Velane running locally so you can sign in, create a snippet, and invoke it.

Prerequisites​

  • Docker + Docker Compose
  • Node.js (for frontend development only)
  • Go (for control-plane or CLI development only)

1) Clone the repository​

git clone https://github.com/abskrj/velane.git
cd velane

2) Set bootstrap admin values​

In docker-compose.yml, set:

  • BOOTSTRAP_EMAIL
  • BOOTSTRAP_PASSWORD
  • BOOTSTRAP_TENANT

These create your first admin user and tenant on first boot.

3) Start the stack​

docker compose up --build

On startup, Velane runs database migrations automatically and then starts all services.

4) Open Velane​

  • Admin portal: http://localhost:8092
  • API: http://localhost:8080
  • MCP server: http://localhost:8090

Sign in with your bootstrap credentials.

5) Verify the API health endpoint​

curl http://localhost:8080/healthz

Expected: a healthy response payload.

What to do next​

  • Continue to first-snippet.md
  • If you want integrations immediately, go to ../integrations/overview.md