2017-10-26 00:22:00 +00:00
|
|
|
# Deploy to FTP(S) server from Drone CI
|
|
|
|
|
|
|
|
[![Docker Stars](https://img.shields.io/docker/stars/cschlosser/drone-ftps.svg)](https://hub.docker.com/r/cschlosser/drone-ftps/)
|
|
|
|
[![Docker Pulls](https://img.shields.io/docker/pulls/cschlosser/drone-ftps.svg)](https://hub.docker.com/r/cschlosser/drone-ftps/)
|
|
|
|
[![Docker Build](https://img.shields.io/docker/build/cschlosser/drone-ftps.svg)](https://hub.docker.com/r/cschlosser/drone-ftps/)
|
|
|
|
[![Docker Layers](https://images.microbadger.com/badges/image/cschlosser/drone-ftps.svg)](https://hub.docker.com/r/cschlosser/drone-ftps/)
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
2018-02-06 21:10:06 +00:00
|
|
|
You have to set the username and password for your FTP server in the `FTP_USERNAME` and `FTP_PASSWORD` secret.
|
2017-10-26 00:22:00 +00:00
|
|
|
|
2019-05-17 18:17:33 +00:00
|
|
|
## Required settings
|
2017-10-26 00:22:00 +00:00
|
|
|
|
|
|
|
```yaml
|
2019-05-17 18:15:51 +00:00
|
|
|
environment:
|
|
|
|
FTP_USERNAME:
|
|
|
|
from_secret: username
|
|
|
|
FTP_PASSWORD:
|
|
|
|
from_secret: password
|
|
|
|
PLUGIN_HOSTNAME: example.com:21
|
2019-05-17 18:17:33 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
## Optional settings
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
environment:
|
2019-05-17 18:15:51 +00:00
|
|
|
PLUGIN_DEST_DIR: /path/to/dest (default /)
|
|
|
|
PLUGIN_SRC_DIR: /path/to/dest (default ./)
|
|
|
|
PLUGIN_SECURE: true | false (default true)
|
|
|
|
PLUGIN_VERIFY: false
|
|
|
|
PLUGIN_EXCLUDE: (egrep like pattern matching)
|
|
|
|
PLUGIN_INCLUDE: (egrep like pattern matching)
|
2022-05-18 09:26:46 +00:00
|
|
|
PLUGIN_CHMOD: true | false (default true)
|
|
|
|
PLUGIN_CLEAN_DIR: true | false (default false)
|
|
|
|
PLUGIN_AUTO_CONFIRM: true | false (default false)
|
2022-08-05 19:25:13 +00:00
|
|
|
PLUGIN_SSH_ACCEPT_RSA: true | false (default false)
|
2022-05-18 09:26:46 +00:00
|
|
|
PLUGIN_DEBUG: true | false (default false)
|
2017-10-26 00:22:00 +00:00
|
|
|
```
|
|
|
|
|
2019-05-17 18:15:51 +00:00
|
|
|
## Full file example
|
2017-10-26 00:22:00 +00:00
|
|
|
|
|
|
|
```yaml
|
2019-05-17 18:15:51 +00:00
|
|
|
kind: pipeline
|
|
|
|
name: default
|
2017-10-26 00:22:00 +00:00
|
|
|
|
2019-05-17 18:15:51 +00:00
|
|
|
steps:
|
|
|
|
- name: master_build
|
|
|
|
image: cschlosser/drone-ftps
|
|
|
|
environment:
|
|
|
|
FTP_USERNAME:
|
|
|
|
from_secret: username
|
|
|
|
FTP_PASSWORD:
|
|
|
|
from_secret: password
|
|
|
|
PLUGIN_HOSTNAME: example.com:21
|
2017-10-26 00:22:00 +00:00
|
|
|
|
2019-05-17 18:15:51 +00:00
|
|
|
PLUGIN_SECURE: false
|
|
|
|
PLUGIN_VERIFY: false
|
|
|
|
PLUGIN_EXCLUDE: ^\.git/$
|
|
|
|
when:
|
|
|
|
branch:
|
|
|
|
- master
|
|
|
|
event:
|
|
|
|
- push
|
2017-10-26 00:22:00 +00:00
|
|
|
|
2019-05-17 18:15:51 +00:00
|
|
|
- name: develop_build
|
|
|
|
image: cschlosser/drone-ftps
|
|
|
|
environment:
|
|
|
|
FTP_USERNAME:
|
|
|
|
from_secret: username
|
|
|
|
FTP_PASSWORD:
|
|
|
|
from_secret: password
|
|
|
|
PLUGIN_HOSTNAME: example.com:21
|
|
|
|
PLUGIN_DEST_DIR: /develop
|
|
|
|
PLUGIN_SECURE: false
|
|
|
|
PLUGIN_VERIFY: false
|
|
|
|
PLUGIN_EXCLUDE: ^\.git/$
|
|
|
|
when:
|
|
|
|
branch:
|
|
|
|
- develop
|
|
|
|
event:
|
|
|
|
- push
|
2018-02-06 21:10:06 +00:00
|
|
|
```
|