Templates

The official catalogue is published at cgt.octabyte.io, with a page for each app and a Deploy button that opens the get-started wizard, which works with no Server and no account yet: it signs you up on the way. Inside the console, the Templates page lists the same catalogue so you can add an app to a Project you already have. Apps include Ghost, n8n, Plausible Analytics, Nextcloud, Vaultwarden, WordPress and more, and the catalogue keeps growing.

What you can do

• Browse and search the catalogue in the console, and filter by tag.
• Set an app up in an existing Project and Environment, or in a new Project.
• Review exactly what it creates as a Plan before anything runs.
• Cancel a setup you have not applied yet.

Set up a Template

1. Find the app

   Open Templates in the rail. Search by name or filter by Tags. Each card links the app’s website, docs and source, and says where it runs.

   cloudgate.octabyte.app/templates

   

2. Choose where it goes

   Press Set up. Choose a Project and an Environment, for example storefront / staging. An Environment that cannot take the app is greyed out. Or choose New Project from a template and give the Project a name and a Deploy target.

3. Fill in the values

   Give the setup a Setup name, fill in the values the template asks for, and pick the Domain hosts its web parts answer on.

4. Review and apply

   Press Set up and review the Plan. Read the Environment’s Plan: it lists the Services the template creates. Press Apply.

Until you apply it, the setup waits as a Pending setup on the Environment’s Services tab, where Cancel setup drops it. A pending setup that is not applied is dropped after 30 days.

Set up a Template in a repository-kept config

When the Project’s config is kept in your repository, Cloudgate does not write to your repository. The setup shows the YAML to paste into your cloudgate.yaml instead. Commit it to the Config branch, and the next push’s Plan creates the template’s parts.

What you cannot do

• A template is a copy: it keeps no link to the catalogue and receives no updates.
• A template’s Compose part is console-managed: you change it in the console, not in the config.
• In a cloud, a template’s Compose part runs on its own Stack VM, and you type its Domain host.
• On a self-hosted instance the operator can mirror the catalogue or turn it off; the page then says “Templates are off”. See Instance settings.

Where does the catalogue come from?

From the public repository octabyte-io/cg-templates. Each release publishes one catalogue.zip, a folder per template: its cloudgate.yaml, a template.yaml with what only a template has (the values it asks for or generates, its Domains and files), at most one compose file, the config files it ships and a logo. Cloudgate reads the newest release it can use, checks the zip whole, and hides a single template it cannot read while listing the rest.

Write or test a template

A template is written as a folder in cg-templates; that repository’s README says how. The CLI checks one the way Cloudgate will read it, with no Instance or login:

• cloudgate template check <folder> prints ✓ for each template Cloudgate would offer and ✗ with the reason for each it would hide.
• cloudgate template try <folder> starts the template’s compose part on your own Docker, checks each Domain answers, and removes everything. A test-values.yaml in the folder gives its asked values.
• cloudgate template pack <folder> <out> builds the catalogue.zip a release publishes.

Related pages

• Deploy your first app with the get-started wizard.
• Project config and Plans: what Apply does.
• Compose stacks: how a template’s Compose part runs.
• Domains and HTTPS for the template’s hosts.
• Features for everything else Cloudgate runs.

Questions

Where can I see every template?

On the template catalogue website at cgt.octabyte.io, which has a page for each app with a Deploy button. The console's Templates page lists the same catalogue.

Does my app get updates when the template changes?

No. Setting a template up copies its config into your Project. It keeps no link to the template and gets no updates from it.

Can an AI agent set up a template?

No. Only a person can set a template up.