mirror of
https://github.com/easingthemes/ssh-deploy.git
synced 2024-11-19 08:08:05 +08:00
Compare commits
7 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
a9e37f3cb5 | ||
|
ff615959b6 | ||
|
5c4b90e3f8 | ||
|
66b3ffb0f7 | ||
|
037d157977 | ||
|
e34308df6c | ||
|
ad838db71f |
20
README.md
20
README.md
@@ -12,38 +12,40 @@ This action would usually follow a build/test action which leaves deployable cod
|
||||
|
||||
Pass configuration with `env` vars
|
||||
|
||||
1. `SSH_PRIVATE_KEY` [required]
|
||||
##### 1. `SSH_PRIVATE_KEY` [required]
|
||||
|
||||
This should be the private key part of an ssh key pair.
|
||||
Private key part of an SSH key pair.
|
||||
The public key part should be added to the `authorized_keys` file on the server that receives the deployment.
|
||||
|
||||
The keys should be generated using the PEM format. You can us this command
|
||||
More info for SSH keys: https://www.ssh.com/ssh/public-key-authentication
|
||||
|
||||
The keys should be generated using the PEM format. You can use this command
|
||||
|
||||
```
|
||||
ssh-keygen -m PEM -t rsa -b 4096
|
||||
```
|
||||
|
||||
2. `REMOTE_HOST` [required]
|
||||
##### 2. `REMOTE_HOST` [required]
|
||||
|
||||
eg: mydomain.com
|
||||
|
||||
3. `REMOTE_USER` [required]
|
||||
##### 3. `REMOTE_USER` [required]
|
||||
|
||||
eg: myusername
|
||||
|
||||
3. `REMOTE_PORT` (optional, default '22')
|
||||
##### 4. `REMOTE_PORT` (optional, default '22')
|
||||
|
||||
eg: '59184'
|
||||
|
||||
2. `ARGS` (optional, default '-rltgoDzvO')
|
||||
##### 5. `ARGS` (optional, default '-rltgoDzvO')
|
||||
|
||||
For any initial/required rsync flags, eg: `-avzr --delete`
|
||||
|
||||
3. `SOURCE` (optional, default '')
|
||||
##### 6. `SOURCE` (optional, default '')
|
||||
|
||||
The source directory, path relative to `$GITHUB_WORKSPACE` root, eg: `dist/`
|
||||
|
||||
4. `TARGET` (optional, default '/home/REMOTE_USER/')
|
||||
##### 7. `TARGET` (optional, default '/home/REMOTE_USER/')
|
||||
|
||||
The target directory
|
||||
|
||||
|
@@ -23,6 +23,10 @@ inputs:
|
||||
description: "Target directory"
|
||||
required: false
|
||||
default: "/home/REMOTE_USER/"
|
||||
ARGS:
|
||||
description: "Arguments to pass to rsync"
|
||||
required: false
|
||||
default: "-rltgoDzvO"
|
||||
outputs:
|
||||
status:
|
||||
description: "Status"
|
||||
|
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "ssh-deploy",
|
||||
"version": "2.1.0",
|
||||
"version": "2.1.3",
|
||||
"description": "This GitHub Action deploys specific directory from `GITHUB_WORKSPACE` to a folder on a server via rsync over ssh.",
|
||||
"main": "src/index.js",
|
||||
"dependencies": {
|
||||
|
Reference in New Issue
Block a user