Get started

Pick the path that matches what you want to do.

Try Waldur on your machine

Run a local instance with Docker Compose and look around the UI. → Try Waldur locally

Use a Waldur deployment

You have an account on a Waldur portal run by your organization, HPC centre or cloud provider.

• Interface introduction — how the portal is laid out
• Create an organization and manage projects
• Order and manage resources
• How you reach services once they are provisioned

The user guide covers the rest, by role.

Call the API

Make your first request with curl, the Python SDK or TypeScript. → Make your first API call

Deploy Waldur for production

1. Check the hardware requirements.
2. Install with Docker Compose on a single server, or with Helm on Kubernetes.
3. Configure Waldur: the configuration guide lists every setting, and most deployments start with identity providers.
4. Let service providers add offerings.

Danger

Before going to production, complete the go-live checklist.

Contribute to Waldur

Set up a development environment and open your first merge request. → Contribute to Waldur

Learn the concepts

The platform overview explains Waldur's three building blocks — users, organizations and projects — and how everything else, from orders to invoices, attaches to them.