Add an app
Every app here is a folder of a few small files. You can add one from your browser, without installing anything.
How it works
- Step 1 Copy the starter folder
On GitHub, copy each file in starter-template/ into templates/<your-app>/. The folder name is the app’s id and its web address, so pick it once: lowercase letters, digits and hyphens.
- Step 2 Fill it in
template.yaml and cloudgate.yaml tell Cloudgate how to run the app. index.md is the page people read here: a tagline, what it replaces, what you can do with it, and a few questions.
- Step 3 Open a pull request
Checks run on every pull request and say in plain English which file and field to change. A maintainer reviews it, and once merged the app appears here and in every Cloudgate install.
What goes in the folder
templates/n8n/ template.yaml name, description, tags, links, the values setup asks for cloudgate.yaml what Cloudgate runs docker-compose.yml only when the app needs one logo.svg the app's own logo, square index.md this website's page: tagline, category, what it replaces, features, questions screenshots/ optional
Questions
Do I need to install anything?
No. You can add every file from the GitHub website. If you want to check a template on your own computer first, run npx @octabyte-io/cloudgate@next template check templates/<your-app>, and template try in place of template check to start it on your own Docker.
What makes a good app page?
Plain language for someone who has never run a server: what the app does for a business, what it replaces, and an honest note on what is different. No ports, versions or code on the page.
Which category should I choose?
One of: Websites, Team chat, Automation, Analytics, Docs & wikis, Files & photos, Passwords, Customers & sales, Monitoring, Developer tools. If none fits, say so in your pull request.
Can I use the app’s own logo?
Yes, and please do: an SVG if the project publishes one, or a square PNG. Screenshots go in screenshots/ with alt text that describes them: the project’s own images when their license allows it, credited, or your own capture of the app with made-up sample data.