mirror of
https://github.com/appleboy/drone-ssh.git
synced 2025-07-02 21:52:51 +08:00
Update doc with custom secrets example
This commit is contained in:
parent
40323f23e5
commit
c423f2a3c6
21
DOCS.md
21
DOCS.md
@ -142,6 +142,24 @@ pipeline:
|
||||
+ event: tag
|
||||
```
|
||||
|
||||
Example configuration for using custom secrets:
|
||||
|
||||
```diff
|
||||
pipeline:
|
||||
ssh:
|
||||
image: appleboy/drone-ssh
|
||||
host: foo.com
|
||||
username: root
|
||||
password: 1234
|
||||
port: 22
|
||||
+ secrets: [ aws_access_key_id ]
|
||||
+ envs: [ aws_access_key_id ]
|
||||
script:
|
||||
- export AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID
|
||||
```
|
||||
|
||||
This allows us to use custom secrets (The one's that the plugin doesn't expect) which can be used in the script section.
|
||||
|
||||
# Parameter Reference
|
||||
|
||||
host
|
||||
@ -162,6 +180,9 @@ key
|
||||
key_path
|
||||
: key path of user private key
|
||||
|
||||
envs
|
||||
: custom secrets which are made available in the script section
|
||||
|
||||
script
|
||||
: execute commands on a remote server
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user