Skip to content

Commit dc6a5d8

Browse files
committed
move templating doc
1 parent 52bf8b8 commit dc6a5d8

8 files changed

Lines changed: 7 additions & 7 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ export default defineConfig({
4242
{ text: "Overview", link: "/getting-started/" },
4343
{ text: "Installation", link: "/getting-started/installation" },
4444
{ text: "Creating Your First Instance", link: "/getting-started/creating-first-instance" },
45+
{ text: "Templating Containers with trm launch", link: "/getting-started/templating" },
4546
{ text: "Storage and Sizing", link: "/getting-started/storage" },
4647
{ text: "Domains and Authentication", link: "/getting-started/domains-and-auth" },
4748
{ text: "Management GUIs", link: "/getting-started/management-guis" },
@@ -73,7 +74,6 @@ export default defineConfig({
7374
{ text: "OpenClaw", link: "/guides/openclaw" },
7475
{ text: "Hermes", link: "/guides/hermes" },
7576
{ text: "VSCodium Web IDE", link: "/guides/vscode" },
76-
{ text: "Templating Containers with trm launch", link: "/guides/templating" },
7777
{ text: "Isolated Docker Compose deployments", link: "/guides/compose" },
7878
{ text: "Dokploy", link: "/guides/dokploy" },
7979
{ text: "Coolify", link: "/guides/coolify" },

docs/getting-started/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This section covers everything you need to know to get up and running:
66

77
- **[Installation](installation.md):** The step-by-step process for getting Terrarium onto your VPS.
88
- **[Creating Your First Instance](creating-first-instance.md):** How to spin up your first container and publish an app to the web.
9+
- **[Templating Containers with `trm launch`](templating.md):** How to turn repeatable app setup into one launch command with Ansible, Docker Compose, variables, and proxy labels.
910
- **[Storage and Sizing](storage.md):** How to choose the right hardware and structure your storage for the best performance and snapshot capabilities.
1011
- **[Domains and Authentication](domains-and-auth.md):** Setting up custom domains and choosing how you want to handle Single Sign-On (SSO) for your private apps.
1112
- **[Management GUIs](management-guis.md):** A quick tour of the built-in visual dashboards you get right out of the box.

docs/getting-started/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This section covers everything you need to know to get up and running:
66

77
- **[Installation](./installation):** The step-by-step process for getting Terrarium onto your VPS.
88
- **[Creating Your First Instance](./creating-first-instance):** How to spin up your first container and publish an app to the web.
9+
- **[Templating Containers with `trm launch`](./templating):** How to turn repeatable app setup into one launch command with Ansible, Docker Compose, variables, and proxy labels.
910
- **[Storage and Sizing](./storage):** How to choose the right hardware and structure your storage for the best performance and snapshot capabilities.
1011
- **[Domains and Authentication](./domains-and-auth):** Setting up custom domains and choosing how you want to handle Single Sign-On (SSO) for your private apps.
1112
- **[Management GUIs](./management-guis):** A quick tour of the built-in visual dashboards you get right out of the box.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,4 +289,4 @@ If the app is running but the public route does not respond, check that the serv
289289
terrariumctl proxy sync
290290
```
291291

292-
For the full route label grammar, including authenticated routes and wildcard domains, see [Domains and Authentication](../getting-started/domains-and-auth.md#published-app-route-labels).
292+
For the full route label grammar, including authenticated routes and wildcard domains, see [Domains and Authentication](domains-and-auth.md#published-app-route-labels).

docs/guides/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ You can run databases, internal APIs, and experimental AI agents without worryin
1919
- **[VSCodium Web IDE](vscode.md):** The absolute best way to code in the cloud. Spin up a browser-based editor that is completely isolated and secured by SSO.
2020
- **[OpenClaw](openclaw.md):** Give the powerful autonomous AI agent a safe, disposable sandbox to execute code in.
2121
- **[Hermes](hermes.md):** Run agent-driven background services and expose only the user interface to the web.
22-
- **[Templating Containers with `trm launch`](templating.md):** Use Ansible, Galaxy roles, Docker Compose, variables, and proxy labels to launch ready-to-use containers in one command.
2322
- **[Docker Compose Stacks](compose.md):** The cleanest way to run multi-container apps (like a web server + Postgres + Redis) without making a mess of your host machine.
2423
- **[Dokploy](dokploy.md):** Turn your Terrarium containers into an automated, UI-driven deployment platform (like Heroku or Vercel).
2524
- **[Coolify](coolify.md):** Another excellent, self-hosted Heroku alternative that runs perfectly inside a single Terrarium LXC.

docs/guides/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ You can run databases, internal APIs, and experimental AI agents without worryin
1919
- **[VSCodium Web IDE](vscode.md):** The absolute best way to code in the cloud. Spin up a browser-based editor that is completely isolated and secured by SSO.
2020
- **[OpenClaw](openclaw.md):** Give the powerful autonomous AI agent a safe, disposable sandbox to execute code in.
2121
- **[Hermes](hermes.md):** Run agent-driven background services and expose only the user interface to the web.
22-
- **[Templating Containers with `trm launch`](templating.md):** Use Ansible, Galaxy roles, Docker Compose, variables, and proxy labels to launch ready-to-use containers in one command.
2322
- **[Docker Compose Stacks](compose.md):** The cleanest way to run multi-container apps (like a web server + Postgres + Redis) without making a mess of your host machine.
2423
- **[Dokploy](dokploy.md):** Turn your Terrarium containers into an automated, UI-driven deployment platform (like Heroku or Vercel).
2524
- **[Coolify](coolify.md):** Another excellent, self-hosted Heroku alternative that runs perfectly inside a single Terrarium LXC.

docs/reference/terrariumctl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ trm launch ubuntu:24.04 web-01 --profile dev
5353
trm launch ubuntu:24.04 web-01 --disk 40G --memory 4G --cpu 2
5454
```
5555

56-
For a more practical walkthrough with Ansible, Docker Compose, variables, Git assets, and proxy labels, see [Templating Containers with `trm launch`](../guides/templating.md).
56+
For a more practical walkthrough with Ansible, Docker Compose, variables, Git assets, and proxy labels, see [Templating Containers with `trm launch`](../getting-started/templating.md).
5757

5858
Provisioning flags generate cloud-init user-data that installs the needed packages and runs inside the new container:
5959

tests/docs-config.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ describe("docs config", () => {
2121
const docsConfig = readRepoFile("docs/.vitepress/config.mts");
2222
const reference = readRepoFile("docs/reference/terrariumctl.md");
2323
const firstInstance = readRepoFile("docs/getting-started/creating-first-instance.md");
24-
const templating = readRepoFile("docs/guides/templating.md");
24+
const templating = readRepoFile("docs/getting-started/templating.md");
2525
const guidePaths = [
2626
"docs/guides/openclaw.md",
2727
"docs/guides/hermes.md",
@@ -41,7 +41,7 @@ describe("docs config", () => {
4141
expect(reference).toContain("| `terrariumctl launch` |");
4242
expect(reference).toContain("trm launch ubuntu:24.04 app-01 --docker-compose ./docker-compose.yml");
4343
expect(reference).toContain("Templating Containers with `trm launch`");
44-
expect(docsConfig).toContain('link: "/guides/templating"');
44+
expect(docsConfig).toContain('link: "/getting-started/templating"');
4545
expect(templating).toContain("trm launch ubuntu:24.04 customer-portal");
4646
expect(templating).toContain("--vars ./portal.env");
4747
expect(templating).toContain("--var APP_ENV=production");

0 commit comments

Comments
 (0)