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.35.0 with 132 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 analytics3
archiveOffline archives and web preservation2
automationWorkflow automation and scheduled jobs14
backupBackups and snapshots4
bookmarksBookmark managers and read-it-later4
booksEbooks, comics and audiobooks4
calendarCalendars and contacts (CalDAV/CardDAV)1
dashboardStart pages and homelab dashboards5
databaseDatabases, caches and database tools7
developmentDeveloper tools, IDEs and API tooling10
dnsDNS and DHCP servers3
dockerDocker and container management3
documentsDocument management, PDF and OCR3
downloadsDownload clients (torrent, usenet)5
emailEmail servers and testing1
filesFile browsing, sharing and sync6
financeBudgeting and personal finance1
fitnessFitness and activity tracking1
gamesGame servers and game libraries3
gitGit hosting2
hobbyHobby and craft tracking1
home-automationSmart home and IoT2
householdInventory, groceries and recipes4
identityAuthentication, SSO and identity providers2
loggingLog viewers and aggregation1
mediaGeneral media apps30
media-managementMedia library automation (the *arr apps, requests, indexers)11
media-serverMedia servers and their companions5
monitoringUptime, metrics and system monitoring12
musicMusic streaming and libraries2
networkingTunnels, network tools and speed tests6
notesNote taking4
notificationsPush notifications and messaging2
photosPhoto libraries2
privacyAd blocking and privacy tools3
productivityGeneral productivity and collaboration20
reverse-proxyReverse proxies and TLS2
rssFeed readers3
searchSearch engines1
securityPassword managers and security tools4
storageObject and cloud storage4
tasksTasks, kanban and project management3
toolsSmall single-purpose utilities and converters14
videoVideo downloaders and YouTube front ends3
vpnVPN servers1
wikiWikis and documentation3