How the registry works
Each template lives in templates/<id>/ in
the GitHub repository. On every merge to main, CI generates registry.json, which is
currently at v1.1.0 with 12
templates.
Use it in Arcane
- Open Settings → Templates in Arcane.
- Add
https://registry.getarcane.app/registry.jsonas a registry. - Pick a template, fill in its environment values, and deploy.
Template files
- compose.yaml
- The Compose project. Images track :latest, except databases pinned to a major version.
- .env.example
- Every variable the compose file uses without a default. Secrets are placeholders.
- template.json
- Name, description, author, icon_url and tags. version is optional.
- README.md
- Deployment notes: first-run steps, paths and links to upstream docs.
Versioning
Every template carries a content_hash computed from
template.json, compose.yaml, .env.example and README.md, so Arcane can see when a template changed.
minor
New template
Adding a template directory bumps the registry's minor version.
patch
Changed or removed template
Any change to a template's files, or removing a template, bumps the registry's patch version.
patch
Template versions
If template.json leaves out version, the template's version gets a patch bump whenever its content_hash changes. A version written in template.json always wins.
Contributing
vp install vp run new my-app # scaffold templates/my-app vp run lint:templates my-app # check it, add --fix for automatic fixes
See CONTRIBUTING.md for the full checklist.
Tags
Templates use tags from this list (tags.json).
| ai | AI models, LLM runtimes and chat interfaces | 1 |
| analytics | Web and usage analytics | 0 |
| archive | Offline archives and web preservation | 0 |
| automation | Workflow automation and scheduled jobs | 1 |
| backup | Backups and snapshots | 1 |
| bookmarks | Bookmark managers and read-it-later | 0 |
| books | Ebooks, comics and audiobooks | 0 |
| calendar | Calendars and contacts (CalDAV/CardDAV) | 0 |
| dashboard | Start pages and homelab dashboards | 0 |
| database | Databases, caches and database tools | 0 |
| development | Developer tools, IDEs and API tooling | 0 |
| dns | DNS and DHCP servers | 1 |
| docker | Docker and container management | 1 |
| documents | Document management, PDF and OCR | 0 |
| downloads | Download clients (torrent, usenet) | 0 |
| Email servers and testing | 0 | |
| files | File browsing, sharing and sync | 0 |
| finance | Budgeting and personal finance | 0 |
| fitness | Fitness and activity tracking | 0 |
| games | Game servers and game libraries | 0 |
| git | Git hosting | 0 |
| hobby | Hobby and craft tracking | 0 |
| home-automation | Smart home and IoT | 0 |
| household | Inventory, groceries and recipes | 0 |
| identity | Authentication, SSO and identity providers | 0 |
| logging | Log viewers and aggregation | 0 |
| media | General media apps | 0 |
| media-management | Media library automation (the *arr apps, requests, indexers) | 0 |
| media-server | Media servers and their companions | 0 |
| monitoring | Uptime, metrics and system monitoring | 0 |
| music | Music streaming and libraries | 0 |
| networking | Tunnels, network tools and speed tests | 6 |
| notes | Note taking | 0 |
| notifications | Push notifications and messaging | 0 |
| photos | Photo libraries | 0 |
| privacy | Ad blocking and privacy tools | 0 |
| productivity | General productivity and collaboration | 0 |
| reverse-proxy | Reverse proxies and TLS | 0 |
| rss | Feed readers | 0 |
| search | Search engines | 0 |
| security | Password managers and security tools | 0 |
| storage | Object and cloud storage | 2 |
| tasks | Tasks, kanban and project management | 0 |
| tools | Small single-purpose utilities and converters | 0 |
| video | Video downloaders and YouTube front ends | 0 |
| vpn | VPN servers | 0 |
| wiki | Wikis and documentation | 0 |