[READ-ONLY] Mirror of https://github.com/FoxxMD/komodo-import. Import existing compose stacks into Komodo
foxxmd.github.io/komodo-import
compose
docker
import
komodo
toml
docs: fix broken links
+7
-7
+2
-2
docsite/docs/usage/overview.mdx
+2
-2
docsite/docs/usage/overview.mdx
···
201
201
| ENV | Required | Default | Description |
202
202
| :------------------------ | :------- | -------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- |
203
203
| `SERVER_NAME` | ☑️ | | The name of the Komodo [Server](https://komo.do/docs/resources#server) where a Stack is located |
204
-
| `STACKS_FROM` | ☑️ | `dir` | What [**Stack Sources**](#stack-source) to generate Stacks from? `dir` or `compose` |
204
+
| `STACKS_FROM` | ☑️ | `dir` | What [**Stack Sources**](#stack-sources) to generate Stacks from? `dir` or `compose` |
205
205
| `HOST_DIR` | ☑️ | | The parent directory on the **host** that mounted into the Komodo Import container |
206
206
| `WRITE_ENV` | - | `true` | Write the contents of found .env files to Komodo **Environment**. Likely want this as `true`. |
207
207
| `COMPOSE_FILE_GLOB` | - | `**/{compose,docker-compose}*.y?(a)ml` | The [glob](https://github.com/isaacs/node-glob?tab=readme-ov-file#glob-primer) pattern to use for finding files for **Files Paths** in Stack config |
···
279
279
</TabItem>
280
280
</Tabs>
281
281
282
-
#### Git Based Stacks
282
+
#### Git Repo Stacks
283
283
284
284
If a parsed folder (or parent of it) contains a `.git` folder and it has a valid tracked branch + remote, then it will generate a **Git Repo Stack**.
285
285
+3
-3
docsite/src/components/QuickstartCompose.tsx
+3
-3
docsite/src/components/QuickstartCompose.tsx
···
231
231
232
232
<h3>4. Where should generated Stacks be created?</h3>
233
233
234
-
<p>Choose one or more <a href="../usage/overview/#outputs-1">Outputs</a>:</p>
234
+
<p>Choose one or more <a href="../usage/overview#outputs-1">Outputs</a>:</p>
235
235
236
236
<p><Button className="margin-right--md" label="Console" link="#" variant="primary" disabled/> <Button label="Komodo" link="#" variant="primary"
237
237
outline={!composeState.api}
238
238
onClick={komodoApiCallback}/></p>
239
239
240
-
<p>Generated Stacks are <strong>always</strong> output to docker logs as a <a href="../usage/resourceSync/#create-sync-resource">Sync Resource</a>.</p>
240
+
<p>Generated Stacks are <strong>always</strong> output to docker logs as a <a href="../usage/resourceSync#create-sync-resource">Sync Resource</a>.</p>
241
241
242
242
<MDXContent><ConsoleOutput/></MDXContent>
243
243
244
244
<div style={{display: composeState.api ? 'inherit' : 'none'}}>
245
-
<p>Komodo Import can, additionally, create a <a href="../usage/resourceSync/#create-sync-resource">Sync Resource</a> with the generated Stacks in Komodo for you. This method <strong>only</strong> creates the Resource, it does not execute or change your existing Stacks.</p>
245
+
<p>Komodo Import can, additionally, create a <a href="../usage/resourceSync#create-sync-resource">Sync Resource</a> with the generated Stacks in Komodo for you. This method <strong>only</strong> creates the Resource, it does not execute or change your existing Stacks.</p>
246
246
247
247
<p>Create an <a href="../usage/overview#api-sync">API Key and Secret</a>, then specify them below.</p>
248
248
<p>
+2
-2
docsite/src/pages/index.mdx
+2
-2
docsite/src/pages/index.mdx
···
20
20
21
21
* Generate Resources from...
22
22
* [x] Stack
23
-
* [x] [Files On Server](./docs/usage/overview#files-on-server) Stacks from plain folders
24
-
* [x] [Git-based](./docs/usage/overview#git-repo) Stacks from folders containing git repository
23
+
* [x] [Files On Server](./docs/usage/overview#stacks) Stacks from plain folders
24
+
* [x] [Git-based](./docs/usage/overview#git-repo-stacks) Stacks from folders containing git repository
25
25
* [x] Use running [Docker Compose projects](./docs/usage/overview?stacksFrom=compose#stack-sources) or a [specific directory](./docs/usage/overview?stacksFrom=dir#stack-sources) of compose projects
26
26
* Generate To...
27
27
* [x] TOML