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

  1. Open Settings → Templates in Arcane.
  2. Add https://registry.getarcane.app/registry.json as a registry.
  3. 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).

aiAI models, LLM runtimes and chat interfaces1
analyticsWeb and usage analytics0
archiveOffline archives and web preservation0
automationWorkflow automation and scheduled jobs1
backupBackups and snapshots1
bookmarksBookmark managers and read-it-later0
booksEbooks, comics and audiobooks0
calendarCalendars and contacts (CalDAV/CardDAV)0
dashboardStart pages and homelab dashboards0
databaseDatabases, caches and database tools0
developmentDeveloper tools, IDEs and API tooling0
dnsDNS and DHCP servers1
dockerDocker and container management1
documentsDocument management, PDF and OCR0
downloadsDownload clients (torrent, usenet)0
emailEmail servers and testing0
filesFile browsing, sharing and sync0
financeBudgeting and personal finance0
fitnessFitness and activity tracking0
gamesGame servers and game libraries0
gitGit hosting0
hobbyHobby and craft tracking0
home-automationSmart home and IoT0
householdInventory, groceries and recipes0
identityAuthentication, SSO and identity providers0
loggingLog viewers and aggregation0
mediaGeneral media apps0
media-managementMedia library automation (the *arr apps, requests, indexers)0
media-serverMedia servers and their companions0
monitoringUptime, metrics and system monitoring0
musicMusic streaming and libraries0
networkingTunnels, network tools and speed tests6
notesNote taking0
notificationsPush notifications and messaging0
photosPhoto libraries0
privacyAd blocking and privacy tools0
productivityGeneral productivity and collaboration0
reverse-proxyReverse proxies and TLS0
rssFeed readers0
searchSearch engines0
securityPassword managers and security tools0
storageObject and cloud storage2
tasksTasks, kanban and project management0
toolsSmall single-purpose utilities and converters0
videoVideo downloaders and YouTube front ends0
vpnVPN servers0
wikiWikis and documentation0