scrapinghub/drone

Drone Docker镜像文档

镜像概述和主要用途

Drone是一款轻量级持续集成/持续部署(CI/CD)工具，基于Docker容器技术构建。它能够与主流代码托管平台（如GitHub、GitLab、Bitbucket等）无缝集成，自动化执行代码构建、测试和部署流程，帮助开发团队提高开发效率和代码质量。Drone设计简洁，配置灵活，支持多种数据库和部署方式，适合各类规模的开发项目使用。

核心功能和特性

• 多平台集成：支持GitHub、GitHub Enterprise、GitLab、Bitbucket和Gogs等代码托管平台
• 灵活的数据库支持：默认使用SQLite，同时支持PostgreSQL和MySQL数据库
• 配置方式多样：可通过TOML配置文件或环境变量进行参数设置，支持混合配置
• Docker原生支持：基于Docker运行，使用AUFS存储驱动，支持 Worker 节点扩展
• 邮件通知：集成SMTP服务，支持构建结果邮件通知
• 安全认证：通过OAuth协议与代码托管平台进行安全认证

系统要求

• Docker 环境
• AUFS 存储驱动

注意：强烈建议Docker使用AUFS存储驱动。可通过以下命令验证：

sh
sudo docker info | grep Driver:

使用场景和适用范围

• 开发团队的自动化构建、测试和部署流程
• 与GitHub/GitLab等平台集成的项目持续集成
• 需要灵活配置和扩展的CI/CD环境
• 中小型项目或团队的持续集成解决方案

安装方法

注意：当前项目处于alpha阶段，使用时请注意风险。

Ubuntu/Debian 系统

sh
wget downloads.drone.io/master/drone.deb
sudo dpkg -i drone.deb

CentOS/RedHat 系统

sh
wget downloads.drone.io/master/drone.rpm
sudo yum localinstall drone.rpm

数据库配置

Drone默认使用SQLite数据库，同时支持PostgreSQL和MySQL。可通过配置文件自定义数据库设置：

PostgreSQL 配置示例

toml
[database]
driver="postgres"
datasource="host=127.0.0.1 user=postgres dbname=drone sslmode=disable"

MySQL 配置示例

toml
[database]
driver="mysql"
datasource="root@tcp(127.0.0.1:3306)/drone"

配置说明

Drone支持通过配置文件或环境变量进行设置，也可混合使用两种方式。

配置文件方式

配置文件采用TOML格式，默认路径为/etc/drone/drone.toml（通过deb包安装时）。启动时可指定自定义配置文件路径：

sh
droned --config=/path/to/drone.toml

完整配置文件示例：

toml
[server]
port=""

[server.ssl]
key=""
cert=""

[session]
secret=""
expires=""

[database]
driver=""
datasource=""

[github]
client=""
secret=""
orgs=[]
open=false

[github_enterprise]
client=""
secret=""
api=""
url=""
orgs=[]
private_mode=false
open=false

[bitbucket]
client=""
secret=""
open=false

[gitlab]
url=""
client=""
secret=""
skip_verify=false
open=false

[gogs]
url=""
secret=""
open=false

[smtp]
host=""
port=""
from=""
user=""
pass=""

[docker]
cert=""
key=""

[worker]
nodes=[
"unix:///var/run/docker.sock",
"unix:///var/run/docker.sock"
]

环境变量方式

可通过环境变量设置所有配置参数，示例如下：

sh
# 服务器设置
export DRONE_SERVER_PORT=""
export DRONE_SERVER_SSL_KEY=""
export DRONE_SERVER_SSL_CERT=""

# 会话设置
export DRONE_SESSION_SECRET=""
export DRONE_SESSION_EXPIRES=""

# 数据库设置
export DRONE_DATABASE_DRIVER=""
export DRONE_DATABASE_DATASOURCE=""

# GitHub 配置
export DRONE_GITHUB_CLIENT=""
export DRONE_GITHUB_SECRET=""
export DRONE_GITHUB_OPEN=false

# GitHub Enterprise 配置
export DRONE_GITHUB_ENTERPRISE_CLIENT=""
export DRONE_GITHUB_ENTERPRISE_SECRET=""
export DRONE_GITHUB_ENTERPRISE_API=""
export DRONE_GITHUB_ENTERPRISE_URL=""
export DRONE_GITHUB_ENTERPRISE_PRIVATE_MODE=false
export DRONE_GITHUB_ENTERPRISE_OPEN=false

# Bitbucket 配置
export DRONE_BITBUCKET_CLIENT=""
export DRONE_BITBUCKET_SECRET=""
export DRONE_BITBUCKET_OPEN=false

# GitLab 配置
export DRONE_GITLAB_URL=""
export DRONE_GITLAB_CLIENT=""
export DRONE_GITLAB_SECRET=""
export DRONE_GITLAB_SKIP_VERIFY=false
export DRONE_GITLAB_OPEN=false

# 邮件配置
export DRONE_SMTP_HOST=""
export DRONE_SMTP_PORT=""
export DRONE_SMTP_FROM=""
export DRONE_SMTP_USER=""
export DRONE_SMTP_PASS=""

# Worker 节点
export DRONE_WORKER_NODES="tcp://0.0.0.0:2375,tcp://0.0.0.0:2375"

混合配置方式

可同时使用环境变量和配置文件：

sh
DRONE_GITLAB_URL="https://gitlab.com" droned --config=/path/to/drone.conf

GitHub 集成配置

要与GitHub集成，需在GitHub上注册应用：

1. 访问 https://github.com/settings/applications/new

2. 填写以下信息：

   • Homepage URL: http://localhost:8000/（本地运行时，服务器部署需替换为实际域名）
   • Authorization callback URL（GitHub.com）: http://localhost:8000/api/auth/github.com
   • Authorization callback URL（GitHub Enterprise）: http://localhost:8000/api/auth/enterprise.github.com

构建配置

需在代码仓库根目录添加 .drone.yml 文件定义构建流程。关于 .drone.yml 格式的详细说明，请参考 https://github.com/drone/drone/blob/v0.2.1/README.md#builds%E3%80%82

升级说明

从0.2版本升级时请注意：

• 建议等待master分支稳定后再升级
• 数据库不兼容，且无自动迁移工具
• 必须使用全新实例，无法保留旧数据

相关文档

• 安装文档
• 用户指南
• API参考