StackExchange/dnscontrol
1
1
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2025-01-10 17:38:13 +08:00
Code Issues Projects Releases Packages Wiki Activity

DOCS: Clarify Windows use of --creds filename (#2812)

Browse source
This commit is contained in:
Tom Limoncelli 2024-01-24 12:08:10 -05:00 committed by GitHub
parent 881a641f0d
commit eb45102029
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 2 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
documentation/creds-json.md
View file

@ -178,9 +178,8 @@ The `--creds` flag allows you to specify a different file name.
* Do not end the filename with `.yaml` or `.yml` as some day we hope to support YAML. * Do not end the filename with `.yaml` or `.yml` as some day we hope to support YAML.
* Rather than specifying a file, you can specify a program or shell command to be run. The output of the program/command must be valid JSON and will be read the same way. * Rather than specifying a file, you can specify a program or shell command to be run. The output of the program/command must be valid JSON and will be read the same way.
* If the name begins with `!`, the remainder of the name is taken to be a shell command or program to be run. * If the name begins with `!`, the remainder of the name is taken to be a shell command or program to be run.
* If the name is a file that is executable (chmod `+x` bit), it is taken as the command to be run. * If the name is a file that is executable (chmod `+x` bit), it is taken as the command to be run (Linux/MacOS only).
* Exceptions: The `x` bit is not checked if the filename ends with `.yaml`, `.yml` or `.json`. * Exceptions: The `x` bit is not checked if the filename ends with `.yaml`, `.yml` or `.json`.
* Windows: Executing an external script isn't supported. There's no code that prevents it from trying, but it isn't supported.
### Example commands ### Example commands
@ -198,7 +197,7 @@ dnscontrol preview --creds /some/absolute/path/creds.sh
Following commands would execute a shell command: Following commands would execute a shell command:
```shell ```shell
dnscontrol preview --creds "!op inject -i creds.json.tpl" dnscontrol preview --creds '!op inject -i creds.json.tpl'
``` ```
This example requires the [1Password command-line tool](https://developer.1password.com/docs/cli/) This example requires the [1Password command-line tool](https://developer.1password.com/docs/cli/)