plugin-drone-scp/DOCS.md

date, title, author, tags, repo, logo, image

date	title	author	tags	repo	logo	image
2017-01-06T00:00:00+00:00	SCP	appleboy	publish ssh scp	appleboy/drone-scp	term.svg	appleboy/drone-scp

The SCP plugin copy files and artifacts to target host machine via SSH. The below pipeline configuration demonstrates simple usage:

pipeline:
  scp:
    image: appleboy/drone-scp
    host: example.com
    target: /home/deploy/web
    source: release.tar.gz

Example configuration with custom username, password and port:

pipeline:
  scp:
    image: appleboy/drone-scp
    host: example.com
+   username: appleboy
+   password: 12345678
+   port: 4430
    target: /home/deploy/web
    source: release.tar.gz

Example configuration with multiple source and target folder:

pipeline:
  scp:
    image: appleboy/drone-scp
    host: example.com
    target:
+     - /home/deploy/web1
+     - /home/deploy/web2
    source:
+     - release_1.tar.gz
+     - release_2.tar.gz

Example configuration with multiple host:

pipeline:
  scp:
    image: appleboy/drone-scp
-   host: example.com
+   host:
+     - example1.com
+     - example2.com
    target: /home/deploy/web
    source: release.tar.gz

Example configuration with wildcard pattern of source list:

pipeline:
  scp:
    image: appleboy/drone-scp
    host:
      - example1.com
      - example2.com
    target: /home/deploy/web
    source:
-     - release/backend.tar.gz
-     - release/images.tar.gz
+     - release/*.tar.gz

Remove target folder before copy files and artifacts to target:

  scp:
    image: appleboy/drone-scp
    host: example.com
    target: /home/deploy/web
    source: release.tar.gz
+   rm: true

Example configuration using ｀SSHProxyCommand｀:

pipeline:
  scp:
    image: appleboy/drone-scp
    host:
      - example1.com
      - example2.com
    target: /home/deploy/web
    source:
      - release/*.tar.gz
+   proxy_host: 10.130.33.145
+   proxy_user: ubuntu
+   proxy_port: 22
+   proxy_key: ${PROXY_KEY}

Example configuration for success build:

pipeline:
  scp:
    image: appleboy/drone-scp
    host: example.com
    target: /home/deploy/web
    source: release.tar.gz
+   when:
+     status: success

Example configuration for tag event:

pipeline:
  scp:
    image: appleboy/drone-scp
    host: example.com
    target: /home/deploy/web
    source: release.tar.gz
+   when:
+     status: success
+     event: tag

Parameter Reference

host

target hostname or IP

port

ssh port of target host

username

account for target host user

password

password for target host user

key

plain text of user private key

target

folder path of target host

source

source lists you want to copy

rm

remove target folder before copy files and artifacts

timeout

timeout is the maximum amount of time for the TCP connection to establish.

Template Reference

repo.owner

repository owner

repo.name

repository name

build.status

build status type enumeration, either success or failure

build.event

build event type enumeration, one of push, pull_request, tag, deployment

build.number

build number

build.commit

git sha for current commit

build.branch

git branch for current commit

build.tag

git tag for current commit

build.ref

git ref for current commit

build.author

git author for current commit

build.link

link the the build results in drone

proxy_host

proxy hostname or IP

proxy_port

ssh port of proxy host

proxy_username

account for proxy host user

proxy_password

password for proxy host user

proxy_key

plain text of proxy private key

proxy_key_path

key path of proxy private key