Skip to content

Core

Core feature contains some key configuration like domain name and current active environement. Those configuration settings may impact many other features indirectly.

It also handle the two following basic commands : ddb features and ddb config. Check command page for details about those commands.

Feature configuration (prefixed with core.)

Property Type Description
disabled boolean
false
Should this feature be disabled ?
domain.sub string
${project.name}
The domain to use for the domain generation. This is the constant part of the domain, that should not vary between environment.
domain.ext string
test
The extension to use for the domain. This is the last part, of your domain name, that may vary between environment.
domain.value
(read only)
string
${project.name}.${domain.ext}
The whole domain name.
env.current string
${env.available}[-1]
Current active environment. Default value is dev, or the last value of env.available.
project.name string
<Directory name of ${path.project_home}>
The project name. This is used by many templates and to generate other default values like domain.sub.
Property Type Description
env.available string[]
['prod', 'stage', 'ci', 'dev']
List of available environments. You should any new custom environment to support here before trying to set env.current to this custom environment.
required_version string Minimal required ddb version for the project to work properly. If required_version is greater than the currently running one, ddb will refuse to run until it's updated.
check_updates boolean
true
Should check for ddb updates be enabled ?
release_asset_name string
<plaform dependent>
Github release asset name to use to download ddb on self-update command.
path.ddb_home string
${env:HOME}/.docker-devbox/ddb
The path where ddb is installed.
path.home string
${env:HOME}/.docker-devbox
The path where docker devbox is installed.
path.project_home string The project directory.
process Process[] List of process configurations. A process configuration allow to add custom arguments before and after a command executed internally (like git).
Property Type Description
os string
posix
The current operating system.
github_repository string
inetum-orleans/docker-devbox-ddb
List of process configurations. A process configuration allow to add flags before and after a command normaly runned by ddb (like git).

Process configuration (used in core.process)

Property Type Description
bin string* The process path to override.
prepend string|string[]
Arguments to prepend to default arguments.
append string|string[] Arguments to append to default arguments.