docs: update documentation
This commit is contained in:
parent
b0aafdcc54
commit
39b542952b
@ -24,8 +24,9 @@ Dump Let's Encrypt certificates from Traefik.
|
|||||||
|
|
||||||
### SEE ALSO
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [traefik-certs-dumper completion](traefik-certs-dumper_completion.md) - Generate the autocompletion script for the specified shell
|
||||||
* [traefik-certs-dumper file](traefik-certs-dumper_file.md) - Dump the content of the "acme.json" file.
|
* [traefik-certs-dumper file](traefik-certs-dumper_file.md) - Dump the content of the "acme.json" file.
|
||||||
* [traefik-certs-dumper kv](traefik-certs-dumper_kv.md) - Dump the content of a KV store.
|
* [traefik-certs-dumper kv](traefik-certs-dumper_kv.md) - Dump the content of a KV store.
|
||||||
* [traefik-certs-dumper version](traefik-certs-dumper_version.md) - Display version
|
* [traefik-certs-dumper version](traefik-certs-dumper_version.md) - Display version
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 9-Oct-2019
|
###### Auto generated by spf13/cobra on 21-Feb-2025
|
||||||
|
|||||||
40
docs/traefik-certs-dumper_completion.md
Normal file
40
docs/traefik-certs-dumper_completion.md
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
## traefik-certs-dumper completion
|
||||||
|
|
||||||
|
Generate the autocompletion script for the specified shell
|
||||||
|
|
||||||
|
### Synopsis
|
||||||
|
|
||||||
|
Generate the autocompletion script for traefik-certs-dumper for the specified shell.
|
||||||
|
See each sub-command's help for details on how to use the generated script.
|
||||||
|
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for completion
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
--clean Clean destination folder before dumping content. (default true)
|
||||||
|
--config string config file (default is $HOME/.traefik-certs-dumper.yaml)
|
||||||
|
--crt-ext string The file extension of the generated certificates. (default ".crt")
|
||||||
|
--crt-name string The file name (without extension) of the generated certificates. (default "certificate")
|
||||||
|
--dest string Path to store the dump content. (default "./dump")
|
||||||
|
--domain-subdir Use domain as sub-directory.
|
||||||
|
--key-ext string The file extension of the generated private keys. (default ".key")
|
||||||
|
--key-name string The file name (without extension) of the generated private keys. (default "privatekey")
|
||||||
|
--post-hook string Execute a command only if changes occurs on the data source. (works only with the watch mode)
|
||||||
|
--watch Enable watching changes.
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [traefik-certs-dumper](traefik-certs-dumper.md) - Dump Let's Encrypt certificates from Traefik.
|
||||||
|
* [traefik-certs-dumper completion bash](traefik-certs-dumper_completion_bash.md) - Generate the autocompletion script for bash
|
||||||
|
* [traefik-certs-dumper completion fish](traefik-certs-dumper_completion_fish.md) - Generate the autocompletion script for fish
|
||||||
|
* [traefik-certs-dumper completion powershell](traefik-certs-dumper_completion_powershell.md) - Generate the autocompletion script for powershell
|
||||||
|
* [traefik-certs-dumper completion zsh](traefik-certs-dumper_completion_zsh.md) - Generate the autocompletion script for zsh
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 21-Feb-2025
|
||||||
59
docs/traefik-certs-dumper_completion_bash.md
Normal file
59
docs/traefik-certs-dumper_completion_bash.md
Normal file
@ -0,0 +1,59 @@
|
|||||||
|
## traefik-certs-dumper completion bash
|
||||||
|
|
||||||
|
Generate the autocompletion script for bash
|
||||||
|
|
||||||
|
### Synopsis
|
||||||
|
|
||||||
|
Generate the autocompletion script for the bash shell.
|
||||||
|
|
||||||
|
This script depends on the 'bash-completion' package.
|
||||||
|
If it is not installed already, you can install it via your OS's package manager.
|
||||||
|
|
||||||
|
To load completions in your current shell session:
|
||||||
|
|
||||||
|
source <(traefik-certs-dumper completion bash)
|
||||||
|
|
||||||
|
To load completions for every new session, execute once:
|
||||||
|
|
||||||
|
#### Linux:
|
||||||
|
|
||||||
|
traefik-certs-dumper completion bash > /etc/bash_completion.d/traefik-certs-dumper
|
||||||
|
|
||||||
|
#### macOS:
|
||||||
|
|
||||||
|
traefik-certs-dumper completion bash > $(brew --prefix)/etc/bash_completion.d/traefik-certs-dumper
|
||||||
|
|
||||||
|
You will need to start a new shell for this setup to take effect.
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
traefik-certs-dumper completion bash
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for bash
|
||||||
|
--no-descriptions disable completion descriptions
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
--clean Clean destination folder before dumping content. (default true)
|
||||||
|
--config string config file (default is $HOME/.traefik-certs-dumper.yaml)
|
||||||
|
--crt-ext string The file extension of the generated certificates. (default ".crt")
|
||||||
|
--crt-name string The file name (without extension) of the generated certificates. (default "certificate")
|
||||||
|
--dest string Path to store the dump content. (default "./dump")
|
||||||
|
--domain-subdir Use domain as sub-directory.
|
||||||
|
--key-ext string The file extension of the generated private keys. (default ".key")
|
||||||
|
--key-name string The file name (without extension) of the generated private keys. (default "privatekey")
|
||||||
|
--post-hook string Execute a command only if changes occurs on the data source. (works only with the watch mode)
|
||||||
|
--watch Enable watching changes.
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [traefik-certs-dumper completion](traefik-certs-dumper_completion.md) - Generate the autocompletion script for the specified shell
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 21-Feb-2025
|
||||||
50
docs/traefik-certs-dumper_completion_fish.md
Normal file
50
docs/traefik-certs-dumper_completion_fish.md
Normal file
@ -0,0 +1,50 @@
|
|||||||
|
## traefik-certs-dumper completion fish
|
||||||
|
|
||||||
|
Generate the autocompletion script for fish
|
||||||
|
|
||||||
|
### Synopsis
|
||||||
|
|
||||||
|
Generate the autocompletion script for the fish shell.
|
||||||
|
|
||||||
|
To load completions in your current shell session:
|
||||||
|
|
||||||
|
traefik-certs-dumper completion fish | source
|
||||||
|
|
||||||
|
To load completions for every new session, execute once:
|
||||||
|
|
||||||
|
traefik-certs-dumper completion fish > ~/.config/fish/completions/traefik-certs-dumper.fish
|
||||||
|
|
||||||
|
You will need to start a new shell for this setup to take effect.
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
traefik-certs-dumper completion fish [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for fish
|
||||||
|
--no-descriptions disable completion descriptions
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
--clean Clean destination folder before dumping content. (default true)
|
||||||
|
--config string config file (default is $HOME/.traefik-certs-dumper.yaml)
|
||||||
|
--crt-ext string The file extension of the generated certificates. (default ".crt")
|
||||||
|
--crt-name string The file name (without extension) of the generated certificates. (default "certificate")
|
||||||
|
--dest string Path to store the dump content. (default "./dump")
|
||||||
|
--domain-subdir Use domain as sub-directory.
|
||||||
|
--key-ext string The file extension of the generated private keys. (default ".key")
|
||||||
|
--key-name string The file name (without extension) of the generated private keys. (default "privatekey")
|
||||||
|
--post-hook string Execute a command only if changes occurs on the data source. (works only with the watch mode)
|
||||||
|
--watch Enable watching changes.
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [traefik-certs-dumper completion](traefik-certs-dumper_completion.md) - Generate the autocompletion script for the specified shell
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 21-Feb-2025
|
||||||
47
docs/traefik-certs-dumper_completion_powershell.md
Normal file
47
docs/traefik-certs-dumper_completion_powershell.md
Normal file
@ -0,0 +1,47 @@
|
|||||||
|
## traefik-certs-dumper completion powershell
|
||||||
|
|
||||||
|
Generate the autocompletion script for powershell
|
||||||
|
|
||||||
|
### Synopsis
|
||||||
|
|
||||||
|
Generate the autocompletion script for powershell.
|
||||||
|
|
||||||
|
To load completions in your current shell session:
|
||||||
|
|
||||||
|
traefik-certs-dumper completion powershell | Out-String | Invoke-Expression
|
||||||
|
|
||||||
|
To load completions for every new session, add the output of the above command
|
||||||
|
to your powershell profile.
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
traefik-certs-dumper completion powershell [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for powershell
|
||||||
|
--no-descriptions disable completion descriptions
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
--clean Clean destination folder before dumping content. (default true)
|
||||||
|
--config string config file (default is $HOME/.traefik-certs-dumper.yaml)
|
||||||
|
--crt-ext string The file extension of the generated certificates. (default ".crt")
|
||||||
|
--crt-name string The file name (without extension) of the generated certificates. (default "certificate")
|
||||||
|
--dest string Path to store the dump content. (default "./dump")
|
||||||
|
--domain-subdir Use domain as sub-directory.
|
||||||
|
--key-ext string The file extension of the generated private keys. (default ".key")
|
||||||
|
--key-name string The file name (without extension) of the generated private keys. (default "privatekey")
|
||||||
|
--post-hook string Execute a command only if changes occurs on the data source. (works only with the watch mode)
|
||||||
|
--watch Enable watching changes.
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [traefik-certs-dumper completion](traefik-certs-dumper_completion.md) - Generate the autocompletion script for the specified shell
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 21-Feb-2025
|
||||||
61
docs/traefik-certs-dumper_completion_zsh.md
Normal file
61
docs/traefik-certs-dumper_completion_zsh.md
Normal file
@ -0,0 +1,61 @@
|
|||||||
|
## traefik-certs-dumper completion zsh
|
||||||
|
|
||||||
|
Generate the autocompletion script for zsh
|
||||||
|
|
||||||
|
### Synopsis
|
||||||
|
|
||||||
|
Generate the autocompletion script for the zsh shell.
|
||||||
|
|
||||||
|
If shell completion is not already enabled in your environment you will need
|
||||||
|
to enable it. You can execute the following once:
|
||||||
|
|
||||||
|
echo "autoload -U compinit; compinit" >> ~/.zshrc
|
||||||
|
|
||||||
|
To load completions in your current shell session:
|
||||||
|
|
||||||
|
source <(traefik-certs-dumper completion zsh)
|
||||||
|
|
||||||
|
To load completions for every new session, execute once:
|
||||||
|
|
||||||
|
#### Linux:
|
||||||
|
|
||||||
|
traefik-certs-dumper completion zsh > "${fpath[1]}/_traefik-certs-dumper"
|
||||||
|
|
||||||
|
#### macOS:
|
||||||
|
|
||||||
|
traefik-certs-dumper completion zsh > $(brew --prefix)/share/zsh/site-functions/_traefik-certs-dumper
|
||||||
|
|
||||||
|
You will need to start a new shell for this setup to take effect.
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
traefik-certs-dumper completion zsh [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for zsh
|
||||||
|
--no-descriptions disable completion descriptions
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
--clean Clean destination folder before dumping content. (default true)
|
||||||
|
--config string config file (default is $HOME/.traefik-certs-dumper.yaml)
|
||||||
|
--crt-ext string The file extension of the generated certificates. (default ".crt")
|
||||||
|
--crt-name string The file name (without extension) of the generated certificates. (default "certificate")
|
||||||
|
--dest string Path to store the dump content. (default "./dump")
|
||||||
|
--domain-subdir Use domain as sub-directory.
|
||||||
|
--key-ext string The file extension of the generated private keys. (default ".key")
|
||||||
|
--key-name string The file name (without extension) of the generated private keys. (default "privatekey")
|
||||||
|
--post-hook string Execute a command only if changes occurs on the data source. (works only with the watch mode)
|
||||||
|
--watch Enable watching changes.
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [traefik-certs-dumper completion](traefik-certs-dumper_completion.md) - Generate the autocompletion script for the specified shell
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 21-Feb-2025
|
||||||
@ -15,7 +15,7 @@ traefik-certs-dumper file [flags]
|
|||||||
```
|
```
|
||||||
-h, --help help for file
|
-h, --help help for file
|
||||||
--source string Path to 'acme.json' file. (default "./acme.json")
|
--source string Path to 'acme.json' file. (default "./acme.json")
|
||||||
--version string Traefik version. If empty use v1. Possible values: 'v2'.
|
--version string Traefik version. If empty use v1. Possible values: 'v2', 'v3'.
|
||||||
```
|
```
|
||||||
|
|
||||||
### Options inherited from parent commands
|
### Options inherited from parent commands
|
||||||
@ -37,4 +37,4 @@ traefik-certs-dumper file [flags]
|
|||||||
|
|
||||||
* [traefik-certs-dumper](traefik-certs-dumper.md) - Dump Let's Encrypt certificates from Traefik.
|
* [traefik-certs-dumper](traefik-certs-dumper.md) - Dump Let's Encrypt certificates from Traefik.
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 9-Oct-2019
|
###### Auto generated by spf13/cobra on 21-Feb-2025
|
||||||
|
|||||||
@ -47,4 +47,4 @@ Dump the content of a KV store.
|
|||||||
* [traefik-certs-dumper kv etcd](traefik-certs-dumper_kv_etcd.md) - Dump the content of etcd.
|
* [traefik-certs-dumper kv etcd](traefik-certs-dumper_kv_etcd.md) - Dump the content of etcd.
|
||||||
* [traefik-certs-dumper kv zookeeper](traefik-certs-dumper_kv_zookeeper.md) - Dump the content of zookeeper.
|
* [traefik-certs-dumper kv zookeeper](traefik-certs-dumper_kv_zookeeper.md) - Dump the content of zookeeper.
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 9-Oct-2019
|
###### Auto generated by spf13/cobra on 21-Feb-2025
|
||||||
|
|||||||
@ -49,4 +49,4 @@ traefik-certs-dumper kv boltdb [flags]
|
|||||||
|
|
||||||
* [traefik-certs-dumper kv](traefik-certs-dumper_kv.md) - Dump the content of a KV store.
|
* [traefik-certs-dumper kv](traefik-certs-dumper_kv.md) - Dump the content of a KV store.
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 9-Oct-2019
|
###### Auto generated by spf13/cobra on 21-Feb-2025
|
||||||
|
|||||||
@ -48,4 +48,4 @@ traefik-certs-dumper kv consul [flags]
|
|||||||
|
|
||||||
* [traefik-certs-dumper kv](traefik-certs-dumper_kv.md) - Dump the content of a KV store.
|
* [traefik-certs-dumper kv](traefik-certs-dumper_kv.md) - Dump the content of a KV store.
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 9-Oct-2019
|
###### Auto generated by spf13/cobra on 21-Feb-2025
|
||||||
|
|||||||
@ -49,4 +49,4 @@ traefik-certs-dumper kv etcd [flags]
|
|||||||
|
|
||||||
* [traefik-certs-dumper kv](traefik-certs-dumper_kv.md) - Dump the content of a KV store.
|
* [traefik-certs-dumper kv](traefik-certs-dumper_kv.md) - Dump the content of a KV store.
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 9-Oct-2019
|
###### Auto generated by spf13/cobra on 21-Feb-2025
|
||||||
|
|||||||
@ -47,4 +47,4 @@ traefik-certs-dumper kv zookeeper [flags]
|
|||||||
|
|
||||||
* [traefik-certs-dumper kv](traefik-certs-dumper_kv.md) - Dump the content of a KV store.
|
* [traefik-certs-dumper kv](traefik-certs-dumper_kv.md) - Dump the content of a KV store.
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 9-Oct-2019
|
###### Auto generated by spf13/cobra on 21-Feb-2025
|
||||||
|
|||||||
@ -2,10 +2,6 @@
|
|||||||
|
|
||||||
Display version
|
Display version
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Display version
|
|
||||||
|
|
||||||
```
|
```
|
||||||
traefik-certs-dumper version [flags]
|
traefik-certs-dumper version [flags]
|
||||||
```
|
```
|
||||||
@ -35,4 +31,4 @@ traefik-certs-dumper version [flags]
|
|||||||
|
|
||||||
* [traefik-certs-dumper](traefik-certs-dumper.md) - Dump Let's Encrypt certificates from Traefik.
|
* [traefik-certs-dumper](traefik-certs-dumper.md) - Dump Let's Encrypt certificates from Traefik.
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 9-Oct-2019
|
###### Auto generated by spf13/cobra on 21-Feb-2025
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user