22
33A SDK that automatically provides a custom function to build your project's Dockerfile or run your docker-compose services.
44
5+ ## Table of Contents
6+
7+ - [ Dockerfile] ( #dockerfile )
8+ - [ Usage] ( #usage )
9+ - [ Functions] ( #functions )
10+ - [ Build] ( #build )
11+ - [ Example] ( #dockerfile-example )
12+ - [ Docker Compose] ( #docker-compose )
13+ - [ Supported properties] ( #supported-properties )
14+ - [ Environment variables] ( #environment-variables )
15+ - [ Volumes] ( #volumes )
16+ - [ Depends on] ( #depends-on )
17+ - [ Example] ( #docker-compose-example )
18+ - [ Start all services] ( #start-all-services )
19+ - [ Start one service] ( #start-one-service )
20+
521## Dockerfile
622
723Any argument, secret, or stages defined in your Dockerfile will be automatically exposed as parameter to your function.
@@ -40,7 +56,7 @@ Build a container of your project's application using your dockerfile and return
4056- ` buildArgs ` : A list of build arguments to pass to the build (optional).
4157- ` secrets ` : A list of secrets to pass to the build (optional).
4258
43- ### Example
59+ ### Dockerfile Example
4460
4561``` Dockerfile
4662ARG BASE_IMAGE=golang:1.23.2-alpine
@@ -189,7 +205,7 @@ Any argument of these services will be available as argument in the CLI, prefixe
189205
190206For example, if ` my-other-service` has an argument `my-arg`, it will be available as `--my-other-service-my-arg` in the CLI.
191207
192- # ## Example
208+ # ## Docker Compose Example
193209
194210` ` ` yaml
195211services:
@@ -222,7 +238,7 @@ volumes:
222238 redis_data:
223239` ` `
224240
225- # ### All
241+ # ### Start all services
226242
227243Start all services with the function `all` :
228244
@@ -242,7 +258,7 @@ $ PASSWORD=test dagger call docker compose all --redis-redis-password env:PASSWO
242258
243259:bulb : All functions will have their arguments prefixed by their service name.
244260
245- # ### Service
261+ # ### Start one service
246262
247263Start a single service by its name :
248264
0 commit comments