jackywn/docusaurus

Docusaurus Docker镜像文档

镜像概述

本Docker镜像旨在简化Docusaurus文档网站的部署流程，提供开箱即用的环境，支持通过环境变量自定义配置，实现数据持久化，并兼容多种部署方式，适用于个人或团队快速搭建专业的文档站点。

核心功能与特性

• 快速部署：无需手动配置Node.js环境，直接通过Docker命令启动Docusaurus服务
• 自定义配置：通过环境变量设置网站名称、用户权限、模板类型等关键参数
• 数据持久化：支持挂载本地目录，确保文档数据不会因容器重启丢失
• 灵活部署：支持独立Docker运行、docker-compose编排及自定义镜像构建
• 反向代理兼容：提供Nginx反向代理配置示例，便于集成到现有Web服务架构

使用场景

• 个人开发者快速搭建项目文档网站
• 团队内部技术文档协作与共享平台
• 需要频繁更新文档内容的场景
• 希望简化部署流程、减少环境配置复杂度的场景

使用方法

1. Docker独立部署

通过docker run命令直接启动容器：

shell
docker run -d --name=docusaurus \
    -p 8000:80 \
    -v ./docusaurus:/docusaurus \
    -e TARGET_UID=1000 \
    -e TARGET_GID=1000 \
    -e WEBSITE_NAME="awesometic-docs" \
    -e MAXLISTENRTS=20 \
    -e TEMPLATE=classic \
    jackywn/docusaurus

参数说明：

• -p 8000:80：将容器内80端口映射到主机8000端口
• -v ./docusaurus:/docusaurus：挂载本地目录到容器内，实现数据持久化
• 环境变量：
  • TARGET_UID：运行服务的用户ID
  • TARGET_GID：运行服务的组ID
  • WEBSITE_NAME：网站名称
  • MAXLISTENRTS：最大连接数
  • TEMPLATE：Docusaurus模板类型（当前支持classic）

2. Docker Compose部署

通过docker-compose实现更便捷的服务编排：

shell
# 克隆项目仓库
git clone https://github.com/Jack-Ywn/docusaurus-docker.git

# 进入项目目录
cd docusaurus-docker

# 启动服务
docker-compose up -d

3. 自定义构建容器镜像

如需修改镜像配置，可自行构建镜像：

shell
# 克隆项目仓库
git clone https://github.com/Jack-Ywn/docusaurus-docker.git

# 进入构建目录
cd docusaurus-docker/build

# 构建镜像
docker build -t jackywn/docusaurus .

4. Nginx反向代理配置

如需通过域名访问，可配置Nginx反向代理：

nginx
server {
    listen 80;
    listen 443 ssl http2;

    server_name                example.com;  # 替换为实际域名
    server_name_in_redirect    on;
    port_in_redirect           on;

    # HTTP重定向到HTTPS
    if ( $scheme = http ) { return 301 [***] }

    # SSL证书配置（替换为实际证书路径）
    ssl_certificate          example.com.cer;
    ssl_certificate_key      example.com.key;

    location / {
        proxy_pass  [***]  # 指向Docusaurus容器映射的端口
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Forwarded-Port $server_port;
    }
}