本文将指导如何使用 Docker Compose 一键搭建 CodeX Docs 

在快节奏的现代生活中，笔记软件已成为人们生活、学习和工作中必不可少的工具之一。

它可以帮助我们记录灵感、思考和计划，以及存储其他重要信息。

然而，随着市场上笔记软件的不断涌现，选择一款适合自己的软件变得越来越困难。今天我来介绍一个简单的笔记、文档应用 CodeX Docs。

文章目录

• 1 CodeX Docs是什么？
  • 1.1 CodeX Docs 的主要功能包括：
• 2 入门：
  • 2.1 安装非常简单：
  • 2.2 1 安装docker 以及 docker compose
  • 2.3 2 新建docs-config.yaml和docker-compose.yaml文件
  • 2.4 3 运行 docker-compose
  • 2.5 反向代理：

CodeX Docs是什么？

CodeX Docs 是一个简单的免费文档应用程序，适用于内部、公共或个人文档。它基于 Editor.js，使用漂亮干净的 UI 处理内容。

CodeX Docs 是一款免费的开源产品。如果对其他一些功能感兴趣，请随时在 GitHub Repo 上创建问题。

实例图如下：

CodeX Docs 的主要功能包括：

• 创建、编辑和管理文档
• 支持多种文档格式，包括 Markdown、HTML、Word、PDF 等
• 内置图像、表格、代码等元素
• 支持协作编辑
• 提供丰富的 API 支持

CodeX Docs 官网：https://docs.codex.so/codex-docs

demo 预览图：https://docs-demo.codex.so/about-this-demo

入门：

安装非常简单：

1 安装docker 以及 docker compose

Docker 更详细的内容可参考：安装 Docker 以及 Docker Compose 教程

sudo -i
apt update 
apt upgrade -y

curl -fsSL https://get.docker.com -o get-docker.sh 
sh get-docker.sh
rm get-docker.sh
curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose && chmod +x /usr/local/bin/docker-compose

2 新建docs-config.yaml和docker-compose.yaml文件

为了方便，将docker项目统一安装到/root/docker目录下，在root身份下，输入以下代码：

mkdir -p /root/docker/codex/{data,db,uploads}
cd /root/docker/codex/

新建 docs-config.yaml 文件

touch docs-config.yaml

新建 docker-compose.yml 文件并添加配置文件：

nano docker-compose.yaml

version: "3.2"
services:
  docs:
    image: ghcr.io/codex-team/codex.docs:latest
    ports:
      - 3000:3000
    environment:
      - APP_CONFIG_auth_password=codex
    volumes:
      - ./uploads:/usr/src/app/uploads
      - ./db:/usr/src/app/db
      - ./docs-config.yaml:/usr/src/app/docs-config.yaml

键盘按下ctrl+x，然后按y，回车。

3 运行 docker-compose

docker-compose up -d

开始使用：

打开 http://ip:3000 检查是否正常

登陆密码为：codex

反向代理：

反向代理可参考：安装网站统计工具Plausible 教程