Skip to content

Commit a3a799d

Browse files
committed
docs: Update compose files and readme with new locations and options
* Remove PUID/PGID * Add OUTPUT_DIR instructions * Change dev bind to examples folder * Update demo output
1 parent 3da5565 commit a3a799d

File tree

4 files changed

+82
-45
lines changed

4 files changed

+82
-45
lines changed

README.md

Lines changed: 77 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -156,47 +156,66 @@ services:
156156
```
157157
158158
```shell
159-
$ docker compose up
160-
app is starting!
161-
[2025-08-08 13:47:17.462 -0400] VERBOSE: [Init] Config Dir ENV: /config -> Resolved: /config
162-
[2025-08-08 13:47:17.465 -0400] INFO : [Init] Debug Mode: NO
163-
[2025-08-08 13:47:17.476 -0400] INFO : [App] Version: 0.1.0
164-
[2025-08-08 13:47:17.477 -0400] INFO : [App] Files On Server Dir ENV: /filesOnServer -> Resolved: /filesOnServer
165-
[2025-08-08 13:47:17.479 -0400] INFO : [App] [uptime_kuma] Found Stack 'uptime_kuma' at dir /filesOnServer/uptime_kuma
166-
[2025-08-08 13:47:17.485 -0400] INFO : [App] [uptime_kuma] Found 1 files matching compose pattern **/{compose,docker-compose}*.y?(a)ml:
167-
compose.yaml
168-
[2025-08-08 13:47:17.486 -0400] INFO : [App] [uptime_kuma] Stack config complete
169-
[2025-08-08 13:47:17.487 -0400] INFO : [App] [immich] Found Stack 'immich' at dir /filesOnServer/immich
170-
[2025-08-08 13:47:17.488 -0400] INFO : [App] [immich] Found 1 files matching compose pattern **/{compose,docker-compose}*.y?(a)ml:
159+
$ docker compose up --no-log-prefix
160+
[2025-08-11 14:06:19.080 -0400] INFO : [Init] Debug Mode: NO
161+
[2025-08-11 14:06:19.094 -0400] INFO : [App] Version: 0.1.0
162+
[2025-08-11 14:06:19.095 -0400] INFO : [App] Files On Server Dir ENV: /filesOnServer -> Resolved: /filesOnServer
163+
[2025-08-11 14:06:19.096 -0400] INFO : [App] [Files On Server] Processing Stacks for 6 folders:
164+
/filesOnServer/compose.yaml
165+
/filesOnServer/immich
166+
/filesOnServer/jellyfin
167+
/filesOnServer/octoprint
168+
/filesOnServer/plex
169+
/filesOnServer/uptime-kuma
170+
[2025-08-11 14:06:19.096 -0400] INFO : [App] [Files On Server] Compose File Glob: **/{compose,docker-compose}*.y?(a)ml
171+
[2025-08-11 14:06:19.097 -0400] INFO : [App] [Files On Server] Env Glob: **/.env
172+
[2025-08-11 14:06:19.097 -0400] INFO : [App] [Files On Server] [compose] Found Stack 'compose' at dir /filesOnServer/compose.yaml
173+
[2025-08-11 14:06:19.103 -0400] WARN : [App] [Files On Server] [compose] Did not find any files patterns matching compose glob
174+
[2025-08-11 14:06:19.103 -0400] INFO : [App] [Files On Server] [compose] Stack config complete
175+
[2025-08-11 14:06:19.104 -0400] INFO : [App] [Files On Server] [immich] Found Stack 'immich' at dir /filesOnServer/immich
176+
[2025-08-11 14:06:19.107 -0400] INFO : [App] [Files On Server] [immich] Found 1 files matching compose glob:
171177
docker/docker-compose.yaml
172-
[2025-08-08 13:47:17.489 -0400] INFO : [App] [immich] Stack config complete
173-
[2025-08-08 13:47:17.489 -0400] INFO : [App] [plex] Found Stack 'plex' at dir /filesOnServer/plex
174-
[2025-08-08 13:47:17.490 -0400] INFO : [App] [plex] Found 1 files matching compose pattern **/{compose,docker-compose}*.y?(a)ml:
175-
compose.yaml
176-
[2025-08-08 13:47:17.491 -0400] INFO : [App] [plex] Found 1 env files matching pattern **/.env:
177-
.env
178-
[2025-08-08 13:47:17.491 -0400] INFO : [App] [plex] Using .komodoEnv for Komodo-written env file
179-
[2025-08-08 13:47:17.492 -0400] INFO : [App] [plex] Stack config complete
180-
[2025-08-08 13:47:17.492 -0400] INFO : [App] [homepage] Found Stack 'homepage' at dir /filesOnServer/homepage
181-
[2025-08-08 13:47:17.493 -0400] INFO : [App] [homepage] Found 3 files matching compose pattern **/{compose,docker-compose}*.y?(a)ml:
178+
[2025-08-11 14:06:19.107 -0400] INFO : [App] [Files On Server] [immich] Using file(s): docker/docker-compose.yaml
179+
[2025-08-11 14:06:19.108 -0400] INFO : [App] [Files On Server] [immich] Stack config complete
180+
[2025-08-11 14:06:19.108 -0400] INFO : [App] [Files On Server] [jellyfin] Found Stack 'jellyfin' at dir /filesOnServer/jellyfin
181+
[2025-08-11 14:06:19.109 -0400] INFO : [App] [Files On Server] [jellyfin] Found 3 files matching compose glob:
182182
compose.yaml
183183
docker-compose.yaml
184184
docker/docker-compose.yaml
185-
[2025-08-08 13:47:17.493 -0400] INFO : [App] [homepage] Found 1 env files matching pattern **/.env:
185+
[2025-08-11 14:06:19.110 -0400] INFO : [App] [Files On Server] [jellyfin] Using file: compose.yaml but not writing to file_paths since this is the Komodo default
186+
[2025-08-11 14:06:19.111 -0400] INFO : [App] [Files On Server] [jellyfin] Found 1 env files matching pattern **/.env:
186187
.env
187-
[2025-08-08 13:47:17.494 -0400] INFO : [App] [homepage] Using .komodoEnv for Komodo-written env file
188-
[2025-08-08 13:47:17.494 -0400] INFO : [App] [homepage] Stack config complete
189-
[2025-08-08 13:47:17.495 -0400] INFO : [App] TOML:
188+
[2025-08-11 14:06:19.111 -0400] INFO : [App] [Files On Server] [jellyfin] Using .komodoEnv for Komodo-written env file
189+
[2025-08-11 14:06:19.111 -0400] INFO : [App] [Files On Server] [jellyfin] Stack config complete
190+
[2025-08-11 14:06:19.111 -0400] INFO : [App] [Files On Server] [octoprint] Found Stack 'octoprint' at dir /filesOnServer/octoprint
191+
[2025-08-11 14:06:19.112 -0400] WARN : [App] [Files On Server] [octoprint] Did not find any files patterns matching compose glob
192+
[2025-08-11 14:06:19.112 -0400] INFO : [App] [Files On Server] [octoprint] Stack config complete
193+
[2025-08-11 14:06:19.113 -0400] INFO : [App] [Files On Server] [plex] Found Stack 'plex' at dir /filesOnServer/plex
194+
[2025-08-11 14:06:19.114 -0400] INFO : [App] [Files On Server] [plex] Found 1 files matching compose glob:
195+
compose.yaml
196+
[2025-08-11 14:06:19.114 -0400] INFO : [App] [Files On Server] [plex] Using file: compose.yaml but not writing to file_paths since this is the Komodo default
197+
[2025-08-11 14:06:19.115 -0400] INFO : [App] [Files On Server] [plex] Stack config complete
198+
[2025-08-11 14:06:19.115 -0400] INFO : [App] [Files On Server] [uptime-kuma] Found Stack 'uptime-kuma' at dir /filesOnServer/uptime-kuma
199+
[2025-08-11 14:06:19.116 -0400] INFO : [App] [Files On Server] [uptime-kuma] Found 1 files matching compose glob:
200+
compose.yaml
201+
[2025-08-11 14:06:19.116 -0400] INFO : [App] [Files On Server] [uptime-kuma] Using file: compose.yaml but not writing to file_paths since this is the Komodo default
202+
[2025-08-11 14:06:19.117 -0400] INFO : [App] [Files On Server] [uptime-kuma] Found 1 env files matching pattern **/.env:
203+
.env
204+
[2025-08-11 14:06:19.117 -0400] INFO : [App] [Files On Server] [uptime-kuma] Using .komodoEnv for Komodo-written env file
205+
[2025-08-11 14:06:19.117 -0400] INFO : [App] [Files On Server] [uptime-kuma] Stack config complete
206+
[2025-08-11 14:06:19.118 -0400] INFO : [App] [Files On Server] Built Stack configs for 6 folders
207+
[2025-08-11 14:06:19.119 -0400] INFO : [App] Copy the text between the scissors to use as the *Resource File* contents within your Resource Sync
208+
209+
✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️
190210
[[stack]]
191-
name = "uptime_kuma"
211+
name = "compose"
192212

193213
[stack.config]
194214
server = "my-cool-server"
195-
run_directory = "/home/myUser/homelab/uptime_kuma"
215+
run_directory = "/home/myUser/homelab/compose"
196216
files_on_host = true
197217
auto_update = false
198218
poll_for_updates = false
199-
file_paths = [ "compose.yaml" ]
200219

201220
[[stack]]
202221
name = "immich"
@@ -210,44 +229,63 @@ poll_for_updates = false
210229
file_paths = [ "docker/docker-compose.yaml" ]
211230

212231
[[stack]]
213-
name = "plex"
232+
name = "jellyfin"
214233

215234
[stack.config]
216235
server = "my-cool-server"
217-
run_directory = "/home/myUser/homelab/plex"
236+
run_directory = "/home/myUser/homelab/jellyfin"
218237
files_on_host = true
219238
auto_update = false
220239
poll_for_updates = false
221-
file_paths = [ "compose.yaml" ]
222240
env_file_path = ".komodoEnv"
223241
additional_env_files = [ ".env" ]
224242

225243
[[stack]]
226-
name = "homepage"
244+
name = "octoprint"
245+
246+
[stack.config]
247+
server = "my-cool-server"
248+
run_directory = "/home/myUser/homelab/octoprint"
249+
files_on_host = true
250+
auto_update = false
251+
poll_for_updates = false
252+
253+
[[stack]]
254+
name = "plex"
255+
256+
[stack.config]
257+
server = "my-cool-server"
258+
run_directory = "/home/myUser/homelab/plex"
259+
files_on_host = true
260+
auto_update = false
261+
poll_for_updates = false
262+
263+
[[stack]]
264+
name = "uptime-kuma"
227265

228266
[stack.config]
229267
server = "my-cool-server"
230-
run_directory = "/home/myUser/homelab/homepage"
268+
run_directory = "/home/myUser/homelab/uptime-kuma"
231269
files_on_host = true
232270
auto_update = false
233271
poll_for_updates = false
234-
file_paths = [ "compose.yaml" ]
235272
env_file_path = ".komodoEnv"
236273
additional_env_files = [ ".env" ]
237-
[2025-08-08 13:47:17.496 -0400] INFO : [App] Done!
274+
✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️
275+
[2025-08-11 14:06:19.119 -0400] INFO : [App] Done!
238276
```
239277
240-
Copy everything after `[2025-08-08 13:47:17.495 -0400] INFO : [App] TOML:` up until the next timestamp -- this is the contents used in the [**Using Sync Resources**](#using-sync-resources) section.
278+
Copy everything between ✂️ lines -- this is the contents used in the [**Using Sync Resources**](#using-sync-resources) section.
241279
242280
**TIP**
243281
244282
Use
245283
246284
```
247-
docker compose logs --no-log-prefix
285+
docker compose up --no-log-prefix
248286
```
249287

250-
after running Komodo Import to get output without the service name prefix, makes getting clear TOML output easier.
288+
to get output without the service name prefix, makes getting clear TOML output easier.
251289

252290
</details>
253291

compose.dev.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ services:
77
required: false
88
volumes:
99
## ParentDirectory:FILES_ON_SERVER_DIR
10-
- ./tests/exampleDir:/filesOnServer
10+
- ./example:/filesOnServer
1111
restart: no

compose.yaml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ services:
55
## ParentDirectory:FILES_ON_SERVER_DIR
66
- ./myprojects:/filesOnServer
77

8-
## optional, TOML is saved to file here
9-
#- ./config:/config
8+
## optional, TOML is saved to file here when OUTPUT_DIR env is present
9+
#- ./output:/output
1010
environment:
1111
- TZ=America/New_York
1212
## Komodo Server name to use for generated Stacks
@@ -24,7 +24,6 @@ services:
2424
#- COMPOSE_FILE_GLOB=
2525
#- ENV_FILE_GLOB=
2626

27-
## use if using /config for saving TOML
28-
#- PUID=1000
29-
#- PGID=1000
27+
## only saves to file if this ENV is present
28+
#- OUTPUT_DIR=/output
3029
restart: no

config/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)