everteal/drone-plugin-lftp-sftp repository overview

⁠Drone plugin LFTP SFTP

A Drone CI⁠ (>= 2.0) plugin that connects to a remote SFTP server using lftp⁠.

⁠Settings reference

• host: string (required)

Domain name or IP address of the host to SFTP into.

• port: integer (required)

Port the SFTP server is running on.

• username: string (required)

Username of the SFTP user

• script: string|array<string> (required)

List of LFTP commands to execute whilst connected to the server.

• key: string (must be set if password is not set)

SSH private key required to connect to account.

• password: string (must be set if key is not set)

Password required to connect to account.

• path: string (optional)

Working remote directory in which to execute the path in.

Note: To execute commands from another local path than the project's root (drone default), use lcd <local_directory_path>.

⁠Reference

• lftp command reference⁠
• lftp community wiki page⁠

⁠Example

kind: pipeline
type: docker
name: default

steps:
- name: Deploy with SFTP
  image: docker.io/everteal/drone-plugin-lftp-sftp:latest
  settings:
    key:
      from_secret: PRIVATE_KEY
    host: 1.2.3.4
    port: 22
    username: deployer
    path: ~/www
    script: |
      rm -r public          # Remove public directory
      mkdir -p public       # Recreate the directory
      mirror -R dist public # Push contents from 'dist' to 'public'