mirror of
https://gitee.com/jiulinxiri/ssh-scp-deploy.git
synced 2026-03-14 05:22:54 +08:00
30 lines
2.4 KiB
Markdown
30 lines
2.4 KiB
Markdown
# ssh-scp-deploy
|
||
|
||
[](https://docs.github.com/en/actions/creating-actions/about-actions#types-of-actions)
|
||
[](https://opensource.org/licenses/MIT)
|
||
[](./)
|
||
|
||
This action provide an easy and higly customizable way to upload files via scp and execute a set of command via ssh before or/and after.
|
||
|
||
## Supported runners
|
||
[](https://docs.github.com/en/actions/creating-actions/about-actions#docker-container-actions)
|
||
|
||
## Usage
|
||
```yaml
|
||
- uses: underscore69/ssh-scp-deploy@v1.0.0
|
||
with:
|
||
local: './' # Local file path - REQUIRED false - DEFAULT ./
|
||
remote: '~/' # Remote file path - REQUIRED false - DEFAULT ~/
|
||
host: ${{secrets.HOST}} # Remote server address - REQUIRED true
|
||
port: ${{secrets.PORT}} # Remote server port - REQUIRED false - DEFAULT 22
|
||
user: ${{secrets.USER}} # Remote server user - REQUIRED true
|
||
password: ${{secrets.PASSWORD}} # User password - REQUIRED at least one of "password" or "key"
|
||
key: ${{secrets.KEY}} # Remote server private key - REQUIRED at least one of "password" or "key"
|
||
pre_upload: echo "This will be executed before the upload!" # Command to run via ssh before scp upload - REQUIRED false
|
||
post_upload: echo "This will be executed after the upload!" # Command to run via ssh after scp upload - REQUIRED false
|
||
ssh_options: -o StrictHostKeyChecking=no # A set of ssh_option separated by -o - REQUIRED false - DEFAULT -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null
|
||
scp_options: -v # Flags to use during scp - REQUIRED false - DEFAULT ''
|
||
```
|
||
|
||
## License
|
||
The source code, scripts and documentation in this project are released under the [MIT License](LICENSE) |