[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: Update quickstart for git repo
+15
-4
+13
-3
docsite/docs/quickstart.mdx
+13
-3
docsite/docs/quickstart.mdx
···
26
26
27
27
You want to import all of the existing compose projects into Komodo as [Files On Server](../usage/overview#files-on-server) [Stacks](https://komo.do/docs/resources#stack) attached to `my-cool-server`.
28
28
29
+
:::tip
30
+
31
+
Using git repositories instead of plain folders? Check out the [Git Repo Stack docs](../usage/overview#git-repo)
32
+
33
+
:::
34
+
29
35
## Create Docker Compose File
30
36
31
37
Use the [example `compose.yaml` file from the repository](https://github.com/FoxxMD/komodo-import/blob/main/compose.yaml) as a starting point.
32
38
33
-
* Bind `/home/myUser/homelab/` into the container at `/filesOnServer` so Komodo Import can scan the parent folder
39
+
* Bind `/home/myUser/homelab/` into the container at `/filesOnServer` so Komodo Import can scan the parent folder (this is the same for plain folder and git repo stack methods)
34
40
* Define `HOST_PARENT_PATH=/home/myUser/homelab` so Komodo Import knows how to create Run Directory in a Komodo Stack correctly
35
41
36
42
```yaml
···
52
58
restart: no
53
59
```
54
60
61
+
## Choose Desired Output
62
+
55
63
<Tabs groupId="output" queryString>
56
64
<TabItem value="console" label="Console">
57
-
This [Output](../usage/overview#outputs) write renders the Sync Resource TOML to docker logs. Run komodo-import with `--no-log-prefix` to get the generated TOML output for a Sync Resource.
65
+
This [Output](../usage/overview#outputs) renders the Sync Resource TOML to docker logs. Run komodo-import with `--no-log-prefix` to get the generated TOML output for a Sync Resource.
58
66
59
67
```shell
60
68
docker compose up --no-log-prefix
···
116
124
[2025-08-11 14:06:19.119 -0400] INFO : [App] Done!
117
125
```
118
126
119
-
Now [manually create a Sync Resource](../usage/resourceSync#create-sync-resource) and Execute to import your projects.
127
+
Now, [manually create a Sync Resource](../usage/resourceSync#create-sync-resource) and Execute to import your projects.
128
+
129
+
Or, use [Sync Api](./?output=sync-api#choose-desired-output) output instead to directly write the Sync Resource to Komodo.
120
130
</TabItem>
121
131
<TabItem value="sync-api" label="Sync API">
122
132