xmppxsf/xmpp.org

xmpp.org Docker镜像文档

镜像概述

xmpp.org Docker镜像是由XMPP标准基金会（XSF）维护的官方镜像，用于构建和部署xmpp.org网站。该网站是XMPP协议相关信息的官方发布平台，包含协议文档、规范、社区资源等内容。镜像基于Pelican静态网站生成器，集成了所有必要依赖，支持本地开发、内容贡献和生产环境部署。

核心功能与特性

• 静态网站生成：使用Pelican 3.3生成静态HTML文件，高效轻量
• 多环境配置：区分开发配置（pelicanconf.py）和生产配置（publishconf.py）
• 开发便捷性：支持文件变更自动重载（devserver模式）
• 多安装方式：提供Docker、Vagrant及常规本地安装选项
• 主题定制：支持通过Sass修改网站主题样式，使用Grunt编译

使用场景

• XMPP社区成员贡献网站内容（文档、新闻、规范更新等）
• 本地开发和测试网站更改
• 部署生产环境的xmpp.org官方网站
• 网站主题和样式定制开发

使用方法

Docker安装与使用

基本构建流程

通过MakefileDocker实现镜像构建和网站生成，主要步骤：

1. 创建构建环境镜像：

   bash
   make -f MakefileDocker builder
   

   生成包含Pelican、Markdown等依赖的开发环境镜像。

2. 生成网站静态文件：

   bash
   make -f MakefileDocker site
   

   在本地仓库目录运行，生成的静态文件位于deploy/output。

3. 创建生产部署镜像：

   bash
   make -f MakefileDocker deployer
   

   基于静态文件创建轻量级生产部署镜像。

开发模式运行

启动自动重载的开发服务器（默认端口8080）：

bash
make -f MakefileDocker serve

访问http://localhost:8080查看网站，文件变更将自动触发重载。

其他安装方式（供参考）

常规本地安装

bash
git clone ssh://git@github.com/xsf/xmpp.org.git
cd xmpp.org
# 安装依赖后启动服务器
make serve
# 或自动重载模式
make devserver

访问http://localhost:8000。

Vagrant安装

bash
git clone ssh://git@github.com/xsf/xmpp.org.git
cd xmpp.org
vagrant up
vagrant ssh
cd /vagrant/
make devserver

访问http://localhost:8000。

配置说明

项目结构：

<repo>
  pelicanconf.py       # 开发环境配置
  publishconf.py       # 生产环境配置
  content/
    pages/             # 网站页面源文件（Markdown格式）
  deploy/
    output/            # 生成的静态网站文件（Docker构建输出）
  xmpp.org-theme/      # 网站主题目录
    sass/              # Sass样式源文件

• 开发配置：pelicanconf.py含调试设置和本地服务器配置
• 生产配置：publishconf.py含优化设置，用于生成生产环境文件
• 内容管理：页面内容位于content/pages，通过Markdown文件维护

主题开发

修改网站主题样式步骤：

1. 安装依赖：

   bash
   npm install
   

2. 启动Grunt监听Sass变更并编译：

   bash
   grunt
   

   注意：仅修改sass目录下的源文件，勿直接编辑编译后的CSS。

内容贡献与沟通

内容贡献流程

1. Fork仓库：https://github.com/xsf/xmpp.org/fork
2. 在content/pages目录修改或添加内容
3. 提交PR前确保分支与主仓库同步
4. 提交PR描述变更，经审核后合并

沟通渠道

关于网站内容和开发的讨论，加入XMPP会议室： xsf@muc.xmpp.org（通过XMPP客户端加入）

网站生成与部署

• 主分支提交触发Travis CI自动构建
• 构建状态查看：[***]
• 变更将同步到[***]