Repository navigation
Home
Kyle Ebbinga edited this page Nov 19, 2026
·
3 revisions
Vertex is centralized source control for games and other big-file projects: Perforce's model (central history, file locking, large binaries), git's ease of use, and a stateless server that scales out. New here? Start with Getting started.
| Page | What's in it |
|---|---|
| Getting started | Run a server, install vx, and submit your first revision. |
| Concepts | Projects, workspaces, branches, revisions, and locks, with a git and Perforce comparison. |
| Command reference | Every vx command and option. |
| File locking | How files lock automatically when you change them, and how others see it. |
| Branching and merging | Branches, vx checkout, vx merge, conflicts and merge chains. |
| Ignore rules |
.vxignore syntax and templates. |
| Users and permissions | Access levels, groups, visibility and logins. |
| Best practices | How to set up projects, branches, access and a server. |
| Page | What's in it |
|---|---|
| Deploying the server | Docker images, standalone builds, upgrades, reverse proxies and a deployment checklist. |
| Configuration | Every VX_* environment variable, S3 credentials and Redis. |
| Monitoring | Prometheus metrics, suggested alerts and exporters. |
| Performance tuning | Per-project write limits, PostgreSQL on ZFS, transfer memory and scaling out. |
| Page | What's in it |
|---|---|
| Benchmarking |
vx-bench: load-test a deployment the way real clients use it. |
| Mirroring |
vx-mirror: replay git into Vertex, or mirror Vertex to git or Perforce. |
| Page | What's in it |
|---|---|
| Architecture | The pieces, where state lives, the wire protocol, and a submit end to end. |
| Storage | Content-addressed chunks: FastCDC, SHA-256 ids, zstd, S3 and the content index. |
| Workspaces |
.vx/, the SQLite index, the stat cache and how sync works. |
| History and revisions | Revision tables, submit checks, and why writes serialize per project. |
| Events | The project event journal, live push to clients, and server-side handlers. |
| Caching | Memory and Redis caching, invalidation, and what's never cached. |
See CONTRIBUTING.md for the development setup and workflow. When a change affects users (a command, an option, a setting, a metric), update the matching page here in the same pull request.