tunathu/mirror-web

TUNA mirrors 主页 Docker 部署文档

镜像概述和主要用途

TUNA mirrors 主页是使用 Jekyll 编写的镜像站网站，需依赖 Ruby (>=2.0) 和 Node.js 环境。支持通过直接编译或 Docker 环境构建运行，主要用于镜像站的展示、本地测试及文档贡献管理。

核心功能和特性

• Docker 化构建：提供专用 Dockerfile 实现环境隔离，简化依赖安装流程
• 跨环境支持：兼容直接编译（如 CentOS 系统）和容器化部署两种方式
• 动态数据加载：需下载指定动态数据文件（tunasync.json、tunet.json 等）以确保功能完整性
• 本地演示功能：支持通过 jekyll serve 快速启动本地测试服务
• 文档贡献机制：提供完整的文档编写、提交流程及规范，支持社区协作

使用场景和适用范围

适用于 TUNA 镜像站的开发人员、维护人员及文档贡献者，具体场景包括：

• 本地搭建镜像站测试环境验证功能
• 参与镜像站帮助文档的编写与提交
• 测试新功能或文档变更的显示效果

使用方法和配置说明

运行 Demo

直接编译

本站使用 Jekyll 编写，并通过 babel 编译 ECMAScript6，因此必须安装 Ruby (>=2.0) 和 Node.js。

For Centos

1. 安装 Node.js

bash
yum install nodejs

2. 安装 Ruby 2.2.4 和 rubygems

Step 1: 安装依赖包

bash
yum install gcc-c++ patch readline readline-devel zlib zlib-devel
yum install libyaml-devel libffi-devel openssl-devel make
yum install bzip2 autoconf automake libtool bison iconv-devel sqlite-devel

Step 2: 编译 Ruby 2.2.4 源码

bash
wget -c https://cache.ruby-lang.org/pub/ruby/2.2/ruby-2.2.4.tar.gz

Step 3: 安装 rubygems

bash
wget -c https://rubygems.org/rubygems/rubygems-2.4.8.tgz
ruby setup.rb

3. 安装 bundle 和 build

bash
gem install bundle
gem install build

4. 获取镜像站源码并编译

bash
bundle install
jekyll build

Docker 中构建

bash
cd mirror-web
docker build -t builden -f Dockerfile.build .
docker run -it -v /path/to/mirror-web/:/data builden

动态数据文件下载

为确保正常运行，需下载以下动态数据文件：

bash
wget https://mirrors.tuna.tsinghua.edu.cn/static/tunasync.json -O static/tunasync.json
wget https://mirrors.tuna.tsinghua.edu.cn/static/tunet.json -O static/tunet.json
mkdir -p static/status
wget https://mirrors.tuna.tsinghua.edu.cn/static/status/isoinfo.json -O static/status/isoinfo.json

本地运行 Demo

完成上述步骤后，执行以下命令启动本地服务：

bash
jekyll serve

贡献文档

基本步骤

1. Fork 本项目并克隆到本地
2. 创建分支：git checkout -b foo-doc
3. 在 _posts/help 目录下创建文档文件，文件名格式为 年-月-日-名称.md
4. 使用 Markdown 语法编写文档
5. 提交并推送代码
6. 发送 Pull Request

写作规范

1. 对于相对不知名的镜像项目，首先用一两句话介绍该项目
2. 写明使用方法，采用 Github Flavored Markdown 格式
3. 中英文字符间应保留一个空格

特殊用法

表单选择

例如 <[***]> 中，通过表单选择操作系统和版本号，建议直接使用 Vue.js