cschlosser/drone-ftps

从Drone CI部署到FTP(S)服务器

概述

该Docker镜像用于从Drone CI构建流程中将文件部署到FTP或FTPS服务器，提供了灵活的配置选项以满足不同的部署需求，支持文件过滤、目录指定和安全连接设置。

核心功能和特性

• 支持FTP和FTPS协议连接服务器
• 可配置源文件目录和目标服务器目录
• 提供文件包含/排除过滤功能（基于egrep模式匹配）
• 支持TLS安全连接开关及证书验证控制
• 与Drone CI无缝集成，通过环境变量配置

使用场景

适用于Drone CI环境下需要将构建产物（如网站文件、应用程序包等）自动部署到FTP或FTPS服务器的场景，例如：

• 网站静态资源自动部署
• 应用程序构建产物分发
• 多环境（生产/开发）差异化部署

使用方法

环境准备

需在Drone CI中配置FTP_USERNAME和FTP_PASSWORD作为secret，用于FTP服务器身份验证。

必填设置

yaml
environment:
    FTP_USERNAME:
      from_secret: username  # 从Drone secret获取FTP用户名
    FTP_PASSWORD:
      from_secret: password  # 从Drone secret获取FTP密码
    PLUGIN_HOSTNAME: example.com:21  # FTP服务器地址和端口

可选设置

yaml
environment:
    PLUGIN_DEST_DIR: /path/to/dest  # 服务器目标目录，默认值：/
    PLUGIN_SRC_DIR: /path/to/src    # 本地源文件目录，默认值：./
    PLUGIN_SECURE: true | false     # 是否使用FTPS安全连接，默认值：true
    PLUGIN_VERIFY: false            # 是否验证TLS证书，默认未设置
    PLUGIN_EXCLUDE: ^\.git/$        # 排除文件的egrep模式（示例：排除.git目录）
    PLUGIN_INCLUDE: ^.*\.html$      # 包含文件的egrep模式（示例：仅包含.html文件）

完整配置示例

yaml
kind: pipeline
name: default

steps:
- name: master_build
  image: cschlosser/drone-ftps
  environment:
    FTP_USERNAME:
      from_secret: username
    FTP_PASSWORD:
      from_secret: password
    PLUGIN_HOSTNAME: example.com:21  # FTP服务器地址和端口
    PLUGIN_SECURE: false             # 禁用FTPS，使用普通FTP
    PLUGIN_VERIFY: false             # 禁用证书验证
    PLUGIN_EXCLUDE: ^\.git/$         # 排除.git目录
  when:
    branch:
    - master                         # 仅在master分支触发
    event:
    - push                           # 仅在push事件触发

- name: develop_build
  image: cschlosser/drone-ftps
  environment:
    FTP_USERNAME:
      from_secret: username
    FTP_PASSWORD:
      from_secret: password
    PLUGIN_HOSTNAME: example.com:21  # FTP服务器地址和端口
    PLUGIN_DEST_DIR: /develop        # 部署到服务器的/develop目录
    PLUGIN_SECURE: false             # 禁用FTPS
    PLUGIN_VERIFY: false             # 禁用证书验证
    PLUGIN_EXCLUDE: ^\.git/$         # 排除.git目录
  when:
    branch:
    - develop                        # 仅在develop分支触发
    event:
    - push                           # 仅在push事件触发