Initial docs commit

2024-10-15 12:59:05 -04:00 · 2024-10-15 12:59:05 -04:00 · cd91b71761
commit cd91b71761
parent 944bbcdf1c
1 changed files with 33 additions and 0 deletions
--- a/docs.md
+++ b/docs.md
@ -0,0 +1,33 @@
+---
+name: scp
+description: SCP an artifact to a remote host
+author: Jacob Patterson
+---
+
+# Settings
+
+Settings without a default value are required.
+
+| Name              | Default | Description                                                     |
+| ----------------- | ------- | --------------------------------------------------------------- |
+| `remote_host`     |         | Remote host                                                     |
+| `remote_port`     | `22`    | Remote listening port                                           |
+| `remote_path`     |         | Destination path to copy the file to                            |
+| `remote_user`     |         | User to authenticate to remote host with                        |
+| `ssh_private_key` |         | Contents of RSA private key to authenticate to remote host with |
+| `file`            |         | File to copy                                                    |
+
+# Example
+
+```yaml
+steps:
+  push-file: drone-scp:latest
+  pull: true
+  settings:
+    remote_host: 111.222.333.444
+    remote_path: /tmp
+    remote_user: user
+    ssh_private_key:
+      from_secret: ssh_private_key
+    file: output
+```