Configuration file overview¶
batect uses a YAML-based configuration file.
By convention, this file is called
batect.yml and is placed in the root of your project (alongside the
You can, however, use a different name or location, and tell
batect where to find it with the
The root of the configuration file is made up of:
The name of your project. Used to label any images built.
If a project name is not provided, the project name is taken from the directory containing the configuration file. For example, if your configuration
/home/alex/projects/my-cool-app/batect.yml and you do not provide a project name,
my-cool-app will be used automatically.
Definitions for each of the containers that make up your various environments.
Definitions for each of your tasks, the actions you launch through batect.
For further examples and real-world scenarios, take a look at the sample projects.