vivumlab/docusaurus

docker-docusaurus

![]([] ![]([]

镜像概述

Docusaurus 是一个便于维护开源文档网站的工具（引用自官方网站）。本镜像为使用Docker构建服务器的用户提供了轻量级的Docusaurus 2运行环境，简化文档网站的部署流程。

核心功能和特性

基础组件

基于轻量级Alpine Linux构建，确保服务资源占用低。基础镜像选用node-alpine，以便灵活调整Nginx版本。具体包含：

• Alpine Linux 3.12
• Node.js 1.15.3
• 最新版本Docusaurus（版本号末尾的'x'表示可由维护者升级）

Docusaurus 2支持

本镜像运行Docusaurus 2 alpha版本（而非稳定版Docusaurus 1）。Docusaurus 2目前处于积极开发中，预计将很快发布正式版。由于从Docusaurus 1升级到2需要迁移工作，当前选择发布基于Docusaurus 2的镜像。

默认启用自动更新功能（可通过环境变量AUTO_UPDATE=false禁用），以适应alpha版本的频繁更新。

数据备份建议

强烈建议定期备份文档数据。考虑到当前使用的是alpha版本、Docker镜像可能存在的不稳定性或物理损坏等因素，需将数据备份至安全位置。

使用场景

适用于需要通过Docker快速部署Docusaurus 2文档网站的用户，尤其适合追求轻量级环境、需要灵活配置（如开发/生产模式切换）的场景。

使用方法

前提条件

需在系统中安装Docker。

拉取镜像

bash
docker pull vivumlab/docusaurus

基本用法

交互式运行（测试）

使用--rm选项在终止会话时自动删除容器：

bash
docker run -it --rm \
-p 80:80 \
-v /本地文档配置路径:/docusaurus \
vivumlab/docusaurus

此命令将启动一个可通过80端口访问的网站，具备以下特性：

• 网站源文件使用UID 1000和GID 1000，支持非root用户编辑
• 默认启用自动更新
• 网站名称为"MyWebsite"
• 使用"classic"模板
• 可切换开发/生产运行模式

后台运行（生产环境）

使用自定义参数以守护进程模式运行：

bash
docker run -d --name=docusaurus \
-p 80:80 \
-v /本地文档配置路径:/docusaurus \
-e TARGET_UID=1000 \
-e TARGET_GID=1000 \
-e AUTO_UPDATE=true \
-e WEBSITE_NAME=vivumlab \
-e TEMPLATE=classic \
-e RUN_MODE=development \
vivumlab/docusaurus

启动后，通过浏览器访问：

http
http://localhost/

环境变量说明

许可证

本项目采用MIT许可证。详见许可证文件。