mikroways/jekyll

Docker Jekyll

一个监听HTTP POST请求并自动生成Jekyll网站的Docker容器。通过该容器，你可以自托管Jekyll网站，并添加支持——当GitHub或Bitbucket上有推送时自动部署站点。

构建

docker build -t mikroways/jekyll .

运行

要运行容器，只需执行以下命令（此示例将克隆并服务Mikroways的网站）：

docker run -p 8080:80 -d -e "HTTP_USER=mikroways" -e "HTTP_PASS=password" -e "REPO_URL=https://github.com/Mikroways/mikroways.net.git" docker.xuanyuan.run/mikroways/jekyll

启动后，容器将首次部署网站，并为自动部署设置基础认证。

如你所见，需要定义三个必填环境变量：

• HTTP_USER：HTTP认证的用户名。
• HTTP_PASS：HTTP认证的密码。
• REPO_URL：需要克隆的Git仓库URL。

自动部署

自动部署执行以下操作：

• 仓库将被克隆（或更新）到/tmp目录。
• 执行bundle install和bundle exec jekyll build命令。
• 将_site目录中生成的HTML文件移动到/data目录，替换现有文件。

首次部署可能需要一些时间（取决于仓库大小、网络连接等）。后续部署会更快，因为只需下载更改并安装新的 gems。

注意：/data目录可以通过卷挂载，但非必需。

自动部署支持两种方式：仅基础HTTP认证的简单方式，以及同时使用基础HTTP认证和请求体密钥的复杂方式。

仅使用基础认证

默认情况下，容器支持基础认证，使用HTTP_USER和HTTP_PASS环境变量定义的用户名和密码，因此无需额外操作即可使用此方式。

使用基础认证和密钥

这需要定义两个额外的环境变量：

• USE_SECRET：必须设置为'yes'（小写）。
• SECRET（可选）：你想要使用的密钥。

如果未指定密钥，系统将自动生成。此时需查看容器日志，寻找字符串"Secret to send posts with"以获取密钥：

Secret to send posts with:
5se7xfS2waUwwD9Nw4c0k4tvIuqGHUTDuALkeOk8W1Tflxn8xIJcA-O0Ay3S366Z

测试

要验证一切正常，请按照以下步骤操作：

1. 访问网站：首次部署完成后，你应该能看到网站在线。
2. 强制部署：

如果仅使用基础认证：

curl -X POST http://mikroways:password@hostname/deploy-with-basic-auth

如果同时使用密钥：

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'secret=5se7xfS2waUwwD9Nw4c0k4tvIuqGHUTDuALkeOk8W1Tflxn8xIJcA-O0Ay3S366Z' http://mikroways:password@hostname/deploy-with-secret

如果操作成功，你将在容器日志中看到部署过程已启动。如果远程仓库有任何更改，部署完成后会应用这些更改。

与GitHub自动化集成

GitHub仅支持基础认证方式。设置步骤如下：进入Settings -> Webhooks & services -> Create webhook。

• Payload URL：[***]
• Content type：任意。
• Secret：留空。
• Events：Push

许可证

MIT许可证（MIT）

版权所有 (c) 2016 Leandro Di Tommaso

特此授予任何获得本软件及相关文档文件（以下简称“软件”）副本的人免费使用、复制、修改、合并、发布、分发、再许可和/或出售软件的权利，前提是符合以下条件：

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

本软件按“原样”提供，不提供任何明示或暗示的担保，包括但不限于适销性、特定用途适用性和非侵权性的担保。在任何情况下，作者或版权持有人均不对因软件或软件使用或其他交易引起的任何索赔、损害或其他责任负责。

作者

• 作者:: Leandro Di Tommaso (<***>)