docs: improve docs (#50)

2025-05-09 18:23:21 +08:00 · 2017-03-03 16:11:21 +08:00 · 2017-03-03 16:11:21 +08:00 · 4507e5e4f0
commit 4507e5e4f0
parent bb0d89368f
1 changed files with 33 additions and 0 deletions
--- a/DOCS.md
+++ b/DOCS.md
@ -33,6 +33,39 @@ pipeline:
 +    - foo.com
 +    - bar.com
    username: root
+    password: 1234
+    port: 22
+    script:
+      - echo hello
+      - echo world
+```
+
+Example configuration for login with private key:
+
+```diff
+pipeline:
+  ssh:
+    image: appleboy/drone-ssh
+    host: foo.com
+    username: root
+-   password: 1234
+   key: ${DEPLOY_KEY}
+    port: 22
+    script:
+      - echo hello
+      - echo world
+```
+
+Example configuration for login with file path of private key:
+
+```diff
+pipeline:
+  ssh:
+    image: appleboy/drone-ssh
+    host: foo.com
+    username: root
+-   password: 1234
+   key_path: ./deploy/key.pem
    port: 22
    script:
      - echo hello