actions/scp-action
1
0
Fork 0
mirror of https://github.com/appleboy/scp-action.git synced 2025-06-04 22:07:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: refine and expand documentation for variable configuration

Browse Source 
- Rewrite and clarify SCP action and SSH proxy table variable descriptions for accuracy and detail
- Add new variables: debug, curl_insecure, capture_stdout, and version to the documentation
- Improve formatting and make default values more consistent and explicit in documentation

Signed-off-by: appleboy <appleboy.tw@gmail.com>
This commit is contained in:
appleboy 2025-04-27 11:21:28 +08:00
parent bc835cba55
commit e55e4eabdc
No known key found for this signature in database
1 changed files with 38 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
README.md
View File

@ -34,44 +34,47 @@ jobs:
See the [action.yml](./action.yml) file for more detail information. See the [action.yml](./action.yml) file for more detail information.
| Variable | Description | Default Value | | Variable | Description | Default Value |
| ------------------- | ----------------------------------------------------------------------------------------------------------- | ------------- | | ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------- |
| host | SCP remote host | - | | host | Remote host address for SCP (e.g., example.com or 192.168.1.1). | - |
| port | SCP remote port | `22` | | port | Remote SSH port for SCP. Default: 22. | 22 |
| username | SCP username | - | | username | Username for SSH authentication. | - |
| password | SCP password | - | | password | Password for SSH authentication (not recommended; use SSH keys if possible). | - |
| passphrase | The passphrase is usually used to encrypt the private key | - | | protocol | IP protocol to use. Valid values: 'tcp', 'tcp4', or 'tcp6'. Default: tcp. | tcp |
| protocol | The IP protocol to use. Valid values are `tcp`, `tcp4`, or `tcp6`. | `tcp` | | timeout | Timeout for establishing SSH connection to the remote host. Default: 30s. | 30s |
| fingerprint | Fingerprint SHA256 of the host public key. Default is to skip verification | - | | command_timeout | Timeout for the SCP command execution. Default: 10m. | 10m |
| timeout | Timeout for SSH to remote host | `30s` | | key | Content of the SSH private key (e.g., the raw content of ~/.ssh/id_rsa). | - |
| command_timeout | Timeout for SCP command | `10m` | | key_path | Path to the SSH private key file. | - |
| key | Content of SSH private key. e.g., raw content of ~/.ssh/id_rsa | - | | passphrase | Passphrase for the SSH private key, if required. | - |
| key_path | Path of SSH private key | - | | fingerprint | SHA256 fingerprint of the host's public key. If not set, host key verification is skipped (not recommended for production). | - |
| target | Target path on the server, must be a directory (**required**) | - | | use_insecure_cipher | Enable additional, less secure ciphers for compatibility. Not recommended unless required. | - |
| source | SCP file list (**required**) | - | | target | Target directory path on the remote server. Must be a directory. | - |
| rm | Remove target folder before uploading data | `false` | | source | List of files or directories to transfer (local paths). | - |
| strip_components | Remove the specified number of leading path elements | - | | rm | Remove the target directory on the server before uploading new data. | - |
| overwrite | Use `--overwrite` flag with tar, overwrite existing files when extracting | - | | debug | Enable debug messages for troubleshooting. | - |
| tar_tmp_path | Temporary path for tar file on the destination host | - | | strip_components | Remove the specified number of leading path elements when extracting files. | - |
| tar_exec | Path to tar executable on the destination host | `tar` | | overwrite | Use the --overwrite flag with tar to overwrite existing files. | - |
| tar_dereference | Use `--dereference` flag with tar, follow symlinks; archive and dump the files they point to | - | | tar_dereference | Use the --dereference flag with tar to follow symlinks. | - |
| use_insecure_cipher | Include more ciphers with use_insecure_cipher (see [#15](https://github.com/appleboy/scp-action/issues/15)) | - | | tar_tmp_path | Temporary path for the tar file on the destination host. | - |
| tar_exec | Path to the tar executable on the destination host. Default: tar. | tar |
| curl_insecure | When true, uses the --insecure option with curl for insecure downloads. | false |
| capture_stdout | When true, captures and returns standard output from the commands as action output. | false |
| version | The version of drone-scp to use. | - |
SSH Proxy Setting: SSH Proxy Setting:
| Variable | Description | Default Value | | Variable | Description | Default Value |
| ------------------------- | ----------------------------------------------------------------------------------------------------------- | ------------- | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| proxy_host | Proxy host | - | | proxy_host | Remote host address for SSH proxy. | - |
| proxy_port | Proxy port | `22` | | proxy_port | SSH proxy port. Default: 22. | 22 |
| proxy_username | Proxy username | - | | proxy_username | Username for SSH proxy authentication. | - |
| proxy_password | Proxy password | - | | proxy_password | Password for SSH proxy authentication. | - |
| proxy_protocol | The IP protocol to use. Valid values are `tcp`, `tcp4`, or `tcp6`. | `tcp` | | proxy_passphrase | Passphrase for the SSH proxy private key, if required. | - |
| proxy_passphrase | The passphrase is usually used to encrypt the private key | - | | proxy_timeout | Timeout for establishing SSH connection to the proxy host. Default: 30s. | 30s |
| proxy_timeout | Timeout for SSH to proxy host | `30s` | | proxy_key | Content of the SSH proxy private key (e.g., the raw content of ~/.ssh/id_rsa). | - |
| proxy_key | Content of SSH proxy private key | - | | proxy_key_path | Path to the SSH proxy private key file. | - |
| proxy_key_path | Path of SSH proxy private key | - | | proxy_fingerprint | SHA256 fingerprint of the proxy host's public key. If not set, host key verification is skipped (not recommended for production). | - |
| proxy_fingerprint | Fingerprint SHA256 of the host public key. Default is to skip verification | - | | proxy_use_insecure_cipher | Enable additional, less secure ciphers for the proxy connection. Not recommended unless required. | - |
| proxy_use_insecure_cipher | Include more ciphers with use_insecure_cipher (see [#15](https://github.com/appleboy/scp-action/issues/15)) | - |
## Setting up a SSH Key ## Setting up a SSH Key