CyberShell/backy
1
1
Fork 0
Code Issues 7 Pull Requests Packages Projects 1 Releases 9 Wiki Activity

update docs
All checks were successful
ci/woodpecker/push/gitea Pipeline was successful
Details
ci/woodpecker/push/publish-docs Pipeline was successful
Details

Browse Source
This commit is contained in:
Andrew Woodlee 2023-07-02 05:32:33 -05:00
parent 37bd69b675
commit e353ed0225
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/content/config/commands.md
View File

@ -16,11 +16,12 @@ commands:
- -f /some/path/to/docker-compose.yaml - -f /some/path/to/docker-compose.yaml
- down - down
# if host is not defined, command will be run locally # if host is not defined, command will be run locally
# The host has to be defined in either the config file or the SSH Config files
host: some-host host: some-host
backup-docker-container-script: backup-docker-container-script:
cmd: /path/to/script/on/some-host cmd: /path/to/local/script
# The host has to be defined in either the config file or the SSH Config files # script file is input as stdin to SSH
host: some-host type: scriptFile # also can be script
environment: environment:
- FOO=BAR - FOO=BAR
- APP=$VAR - APP=$VAR
@ -33,6 +34,7 @@ Values available for this section:
| `cmd` | Defines the command to execute | `string` | yes | | `cmd` | Defines the command to execute | `string` | yes |
| `args` | Defines the arguments to the command | `[]string` | no | | `args` | Defines the arguments to the command | `[]string` | no |
| `environment` | Defines evironment variables for the command | `[]string` | no | | `environment` | Defines evironment variables for the command | `[]string` | no |
| `type` | May be `scriptFile` or `script`. Runs script from local machine on remote | `string` | no |
| `getOutput` | Command(s) output is in the notification(s) | `bool` | no | | `getOutput` | Command(s) output is in the notification(s) | `bool` | no |
| `host` | If not specified, the command will execute locally. | `string` | no | | `host` | If not specified, the command will execute locally. | `string` | no |
| `shell` | Only applicable when host is not specified | `string` | no | | `shell` | Only applicable when host is not specified | `string` | no |
@ -84,6 +86,14 @@ If I assign a value to host as `host: web-prod` and don't specify this value in
If shell is defined and host is NOT defined, the command will run in the specified shell. If shell is defined and host is NOT defined, the command will run in the specified shell.
Make sure to escape any shell input. Make sure to escape any shell input.
### type
May be `scriptFile` or `script`. Runs script from local machine on remote host.
If `script` is specified, `cmd` is used as the script.
Script file is input as stdin to SSH.
### environment ### environment
The environment variables support expansion: The environment variables support expansion: