Create default config table (WIP), add information on argument priority

Daniel Winning 2025-04-24 00:23:14 +01:00
parent e5a39f6cc9
commit 73c742c84e
2 changed files with 21 additions and 2 deletions

@ -12,9 +12,27 @@ This document explains the different ways to configure your project environments
The default configuration for Spinner environments can be found at [config/spinner.yaml](https://forge.winningsoftware.co.uk/LoomLabs/spinner/src/branch/main/config/spinner.yaml)
in the Spinner repository.
## All Configuration Options
| Option | Config Key | Accepted Values |
|----------------------|---------------------------------------|---------------------------------------------------|
| `--php` | `environment.php.version` | Any PHP version with a valid PHP FPM Docker Image |
| `--disable-database` | `environment.database.enabled: false` | None in CLI / `true`/`false` in `spinner.yaml` |
# Custom Configuration
## Argument Priority
Environment options and arguments are considered in the following priority order:
- Those explicitly passed to the commands via the CLI
- Any set in the `spinner.yaml` file in your projects root directory
- Fallback to the default configuration found in this repository at `config/spinner.yaml`
This means that if you were to set `environment.database.enabled: true` in your config file, but pass the
`--disable-database` flag when running the `spin:up` command, your projects settings would be overridden by
the flag you passed in.
## Command Line Arguments
## Using Custom Configuration

@ -1,2 +1,3 @@
After [installation](Installation), you'll need to ensure that your **Docker Engine** is installed and
running before running any `spinner` commands.
After [installation](Installation), you'll need to ensure that your **Docker Engine** is installed and running before running any
`spinner` commands. If you attempt to run any `spinner` commands while your Docker Engine is turned off, you'll see an
error message.