Ready-made projects, read before they run.
A catalog of compose templates from lists such as Arcane’s and Portainer’s, or your own. Pick one, fill in a few fields, see what it asks of your engine, and deploy it as a project of its own. A project of yours that works becomes a template you can share as a list.
Cooking from someone else’s recipe?Read the comic: a box of recipe cards, and an inspector who reads each one before it cooks →What you can do
Lists of templates
Arcane’s community templates out of the box. Add the list of Portainer, the one by Lissy93, one a friend keeps on the web or on a Forgejo at home, or a file on this computer, and turn each list on or off. A list on the internet may not lead into your own network, not even through its name.
Two formats
registry.json of Arcane, and templates.json of Portainer, version 2 and 3. A Portainer stack comes from its repository; for a single container the app writes the compose file. A Portainer template for a swarm deploys as a stack on a swarm manager. Each template of Arcane is checked against its content_hash.
Find one
Search by name, filter by tag or by list, with the logo of each template and the note of its maker.
Fill in the fields
Ports, names and the other settings of the .env, with what each one means. Passwords and secrets get a random value instead of the example, and a secret that still has the example value is marked.
Fixed values in view
A value the list fixes is shown read-only, so you see everything that goes into the .env.
Reviewed before it runs
Compose reads the file with your values, and the app names what it asks of your engine: privileged, the Docker socket, folders of the host, its network or processes, capabilities, devices, and a volume that already exists, left over from an earlier project with the same name or of another project, with the data and passwords of then. Anything serious needs a tick before Deploy.
Nothing from your own computer
A template that names a variable your computer has, such as a token, or your user folder or name, such as HOME or USERPROFILE, is pointed out. And every compose command for a project from the catalog runs in a clean environment, from the deploy on, so a token from your own environment never reaches it.
Nothing fetched behind your back
A template with include, an extends from another file, or an env_file outside its folder is refused: compose would fetch or read more than you reviewed.
What you read is what runs
If the compose file or the .env changed after the review, the app does not deploy it.
A project of its own
Each template becomes a compose project in a folder of its own, with compose.yaml and .env, on the Compose page like any other. Deploy closes the dialog and goes on as a task in the status bar; close it without deploying, and the folder is gone again. When its template gets a newer version, or changes without one, the Catalog page and Needs attention say so; the update shows what changes, is reviewed next to the project, and keeps your values. A swarm stack is updated as a stack.
Your own templates
Save as template… on a compose project keeps it in the catalog. The .env becomes an example with passwords, secrets, tokens and keys left empty, and a secret written in the compose file itself can move to the .env.example. Saving the same project again updates its template: the same id, the next version.
Share them as a list
Export your templates as a registry.json with a templates folder. Push it to a repository and others add it as a list; this app also reads it from a folder on this computer.
The review
What a template asks of your engine, before it gets it.
A template is someone else’s compose file, and deploying it runs their images on your engine. So the dialog has a second step: compose reads the file with your values, and the app lists what stands out, the serious things first. The Docker socket, privileged, the network or processes of the host, folders outside the project, a volume or network that belongs to something else, the compose file mounted into its own container, a token from your own environment. Then a tick, and only then Deploy.
Lists of your own
A Forgejo at home is a catalog too.
Add the address of a registry.json or a templates.json, also on your own network, or pick a file on this computer. The app fetches lists over https only, follows a redirect to your own network only when the list itself lives there, and reads the files of a list on this computer only from its own folder.
My templates
A project that works, kept for next time.
Save as template… writes the compose file and an .env.example to your own templates, first in the catalog. Passwords, secrets, tokens and keys are left empty and named, and the dialog warns about what the app cannot take out. Export them as a list, push the folder to a repository, and a friend adds it to their catalog.
All features