部署在线文档应用程序 CodeX Docs

用户7870779161616
205 阅读5分钟

一、Flexus云服务器X实例介绍  

云服务器提供了一种高效灵活的解决方案，让用户可以根据实际需求即时调整计算资源，避免了传统物理服务器的管理和维护成本。通过云服务器，企业能够实现快速部署和弹性扩展，同时受益于服务商提供的数据安全保障措施，确保业务连续性和数据安全性。

华为云下一代云服务器Flexus X实例焕新上线，新产品基于X实例搭建电商交易平台，可以从容面对电商市场瞬息万变的业务压力变化，也适用于搭建游戏后台服务器，强大算力轻松应对千人同时在线，同时平滑扩容可快速应对服务器玩家数量上涨诉求，超强的网络加速能力提升用户体验。

Flexus X实例通过和其他服务组合，具备计算、镜像安装、网络、存储、安全等能力，您可根据业务需要灵活配置各资源。    

            
本次测评使用的规格是：4核12G-100G-3M规格的Flexus X实例基础模式

二、Flexus云服务器X实例配置  

2.1 重置密码  

购买服务器的时候可以提前设置用户名和密码，因为我这里跳过了，所以购买完成后需要重置密码，会短信或站内消息通过你的云服务器信息，重点是公网IP地址和用户名，首先打开你的服务器控制台，选择重置密码    

勾选自动重启，点击确定即可

2.2 服务器连接  

华为云服务器提供了多种链接方式，如使用控制台提供的VNC方式登录、使用Linux/Mac OS系统主机登录Linux弹性云服务器（即ssh root@192.168.48.78命令）或者使用Putty、Xshell等工具登录Linux弹性云服务器。

我个人习惯使用 MobaXterm 这款软件，添加SSH连接，输出公网IP、用户名和端口(默认22)，连接即可。    

2.3 安全组配置  

安全组是一个逻辑上的分组，为同一个VPC内的云服务器提供访问策略。用户可以在安全组中定义各种访问规则，当云服务器加入该安全组后，即受到这些访问规则的保护。

系统为每个网卡默认创建一个默认安全组，默认安全组的规则是对出方向上的数据报文全部放行，入方向访问受限。您可以使用默认安全组，也可以根据需要创建自定义的安全组。

    

主要需要填写优先级（默认填1即可）、协议端口（协议一般为TCP或UDP，端口一般选择你项目需要暴露的端口即可），描述（选填，一般会填写此端口的用途以免忘记了），其他默认点击确定即可。安全组配置主要是暴露端口可以给外网访问。

如果还不清楚可以参考文档：安全组配置示例

              

2.4 Docker 环境搭建  

本次服务器环境是ubuntu系统镜像，需要自己安装docker环境

服务器类别系统镜像内网IP地址Docker版本操作系统版本
Flexus云服务器X实例Ubuntu192.168.0.16827.2.0Ubuntu 22.04.4 LTS

使用apt-get命令安装docker及其配置

安装必要工具包              

$ sudo apt-get install \              
apt-transport-https \              
ca-certificates \              
curl \              
gnupg-agent \              
software-properties-common              

添加Docker GPG秘钥              

$ sudo curl -fsSL mirrors.ustc.edu.cn/docker-ce/l… | sudo apt-key add -              

配置仓库源              

sudoadd−apt−repository\              "deb[arch=amd64]https://mirrors.ustc.edu.cn/docker−ce/linux/ubuntu\               sudo add-apt-repository \                     "deb [arch=amd64] https://mirrors.ustc.edu.cn/docker-ce/linux/ubuntu \                     (lsb_release -cs) \              
stable"                       

更新apt包索引              

$ sudo apt-get update              

安装docker              

$ sudo apt-get install docker-ce docker-ce-cli containerd.io              

添加docker镜像源              

$ sudo vim /etc/docker/daemon.json              

{              
"registry-mirrors": [              
"ustc-edu-cn.mirror.aliyuncs.com/",              
"docker.mirrors.ustc.edu.cn",              
"docker.nju.edu.cn",              
"ccr.ccs.tencentyun.com/",              
"docker.m.daocloud.io/",              
"dockerproxy.com",              
]              
}              

重启              

sudosystemctldaemon−reload        sudo systemctl daemon-reload               sudo systemctl restart docker    

 测试docker安装是否成功

root@flexusx-c6b3:~# docker -v              
Docker version 27.2.0, build 3ab4256```

检查docker服务状态

root@flexusx-c6b3:~# systemctl status docker              

  • docker.service - Docker Application Container Engine              
    Loaded: loaded (/lib/systemd/system/docker.service; enabled; vendor preset: enabled)              
    Active: active (running) since Fri 2024-08-30 15:53:45 CST; 17h ago              
    TriggeredBy: * docker.socket              
    Docs: docs.docker.com              
    Main PID: 24912 (dockerd)              
    Tasks: 13              
    Memory: 24.7M              
    CPU: 3.778s              
    CGroup: /system.slice/docker.service              
    `-24912 /usr/bin/dockerd -H fd:// --containerd=/run/containerd/containerd.sock    

检查docker compose版本

root@flexusx-c6b3:~# docker compose version              
Docker Compose version v2.29.2

三、Flexus云服务器X实例部署 CodeX Docs  

3.1 CodeX Docs 介绍  

CodeX Docs是一个基于开源技术的文档应用程序。其核心架构基于Editor.js，提供了一个现代化的模块化编辑体验。这款工具适应多种场景，从产品文档到内部团队的知识库，再到个人笔记，CodeX Docs皆能胜任。其设计旨在轻量级、高效和可扩展，确保用户可以根据具体需求调整以及扩大项目功能。

•现代编辑体验：基于Editor.js，该项目提供了灵活且直观的内容编辑流程。用户能够以模块化的方式组织和展示文档，可自定义内容的外观和结构。

•灵活的文档结构：CodeX Docs允许用户创建嵌套文档结构，能够进行内容的分类和分级管理。这种灵活性使得信息组织的易用性和可维护性大幅度提升。

•无依赖部署：该项目支持简单配置和无数据库的部署方式，使得安装和使用变得前所未有的简单。用户只需要最少的设置即可启动并运行应用程序。

•人性化的用户界面和美化的URL：应用程序在桌面和移动端的呈现效果同样优美，并支持SEO友好的人性化URL，为网站的可访问性和搜索引擎排名提供了保障。    

•集成的错误追踪和性能分析：集成了如Hawk（错误跟踪）和Yandex Metrica（性能分析）等工具，让团队能够实时追踪错误并对页面性能进行分析，以便于优化用户体验。

              
CodeX Docs的开发团队，CodeX，是一支由全球数字专家组成的团体，他们致力于创建高质量的开源产品。项目支持包括Markdown在内的多种文档格式，用户可以在平台内轻松实现内容的格式化和管理。此外，该应用程序支持静态渲染和错误追踪，帮助开发者更好地识别和修复问题，为提升用户体验做出巨大贡献。

•官网：docs.codex.so/codex-docs

•Github：github.com/codex-team/…

3.2 CodeX Docs 部署  

•创建 docs-config.yaml

docs-config.yaml 是文档的配置文件

port: 3000              
host: "localhost"              
uploads:              
driver: "local"              
local:              
path: "./uploads"              
s3:              
bucket: "my-bucket"              
region: "eu-central-1"              
baseUrl: "docs-static.codex.so.s3-website.eu-central-1.amazonaws.com"              
keyPrefix: "/"              
accessKeyId: "my-access-key"              
secretAccessKey: "my-secret-key"              
frontend:              
title: "CodeX Docs"              
description: "Free Docs app powered by Editor.js ecosystemt"              
startPage: ""              
misprintsChatId: "12344564"              
yandexMetrikaId: ""              
carbon:              
serve: ""              
placement: ""              
menu:              
- "Guides"              
- title: "CodeX"              
uri: "codex.so"              

auth:              
password: secretpassword              
secret: supersecret              

hawk:              
#  frontendToken: "123"              
#  backendToken: "123"              

database:              
driver: local # you can change database driver here. 'mongodb' or 'local'              
local:              
path: ./db              
#  mongodb:              
#    uri: mongodb://localhost:27017/docs    

•创建 docker-compose.yml    

version: "3.2"              
services:              
docs:              
image: ghcr.io/codex-team/codex.docs:v2.0.0-rc.8              
ports:              
- "8092:3000"              
volumes:              
- ./uploads:/usr/src/app/uploads              
- ./db:/usr/src/app/db              
- ./docs-config.yaml:/usr/src/app/docs-config.yaml

•ports: 映射主机的 8092 端口到容器的 3000 端口

•volumes: 将主机目录挂载到容器目录

如果将上述代码片段保存在名为 docker-compose.yml 的文件中，则只需从同一文件夹中运行docker compose up -d 即可自动拉取 CodeX Docs 镜像，并创建并启动一个容器。 up 表示启动服务，-d 表示在后台执行。docker-compose down 命令用于停止和清理由 docker-compose up 启动的服务。

•启动服务

进入项目目录，执行docker-compose up -d启动命令，会自动拉取容器并运行

从 Github Package 拉取 CodeX Docs 镜像，地址：ghcr.io/codex-team/codex.docs

root@flexusx-c6b3:~/codex# docker-compose up -d              
Creating network "codex_default" with the default driver              
Pulling docs (ghcr.io/codex-team/codex.docs:v2.0.0-rc.8)...              
v2.0.0-rc.8: Pulling from codex-team/codex.docs              
3d2430473443: Already exists              
b60fa0ff74d7: Already exists              
dc7a390288bd: Already exists              
33306f9c18eb: Already exists              
f9be63c00aa6: Pull complete              
2ed6939c8418: Pull complete              
644ea669f4ad: Pull complete              
d2be5619e9f2: Pull complete              
ed6a286fe574: Pull complete              
Digest: sha256:aba12cc74c619f1894f03606473292e1e3ad9ffd77b4d902a44de6fcd02c28d7              
Status: Downloaded newer image for ghcr.io/codex-team/codex.docs:v2.0.0-rc.8              
Creating codex_docs_1 ...              
Creating codex_docs_1 ... done    

•配置安全组

在Flexus云服务器X实例的安全组管理页面，添加入方向规则，接下来我们启动服务需要监听8092端口，所以添加安全组为TCP:8092协议端口。

•检查容器状态

检查 CodeX Docs 容器状态，确保容器正常启动

root@flexusx-c6b3:~/codex# docker ps              
CONTAINER ID   IMAGE                     COMMAND                  CREATED          STATUS          PORTS                                                                          NAMES              
ff1ba3feb77e   ghcr.io/codex-team/codex.docs:v2.0.0-rc.8   "docker-entrypoint.s…"   3 hours ago         Up 3 hours         0.0.0.0:8092->3000/tcp, :::8092->3000/tcp   codex_docs_1

•访问地址

内网：http://localhost:8092              
外网：http://公网IP:8092

•访问结果

若出现此页面，则部署 codex cods server 成功。    

3.3 CodeX Docs 使用  

点击 add page 去创建第一个页面，CodeX Docs 使用带有主密码的简单身份验证方案，它应该通过 auth.password 配置属性环境变量来定义的，输入后登录

默认的 auth.password: secretpassword

再次点击 add page 去创建第一个页面，选择页面位置和输入标题，在写点内容即可，点击Save changes保存    

这样管理员账户查看的效果是这样的，右上角会显示编辑按钮，修改时间和文章主体

使用普通用户查看，对应的风格是这样的，少了编辑按钮，只有可读权限    

点击编辑按钮， 进入编辑模式，可以调整文档层级，可以继续修改文档，保存修改和删除文档

在编辑模式中，页面包含以下控件：父页面、置于上方和别名输入。

•父页面输入允许您指定现有页面中的哪个页面应为当前页面的父页面。此关系将显示在侧边栏中，就像页面嵌套到父部分一样。              
如果您不希望任何现有页面成为您页面的父页面，只需选择一个Root 选项 - 这将允许您创建一个根级页面（侧边栏本身的一部分）。

•置于上方              
使用“置顶输入”可以对部分内的页面进行排序。选项包含同一父级的所有页面（和— 无关紧要）。只需选择当前页面应插入其上方的页面即可。

•别名              
别名字段允许您指定页面应可用的 URL 路径。例如，输入/test 将使页面具有地址 ${docs-domain}/test    

              
这个项目的介绍文档也是通过这个展示的，整体风格很简单，左侧是目录树，每篇文档都是按照树的结构排序的，中间是文章主体，会显示修改时间，地步会显示上一篇或下一篇的导航，右侧则是该篇文档的目录

文档编辑风格类似Notion，但是更简单，保留了几种常用的格式类型： 标题、图片、代码、链接、表格、列表、CheckList 等    

搜索功能感觉比较鸡肋，只能搜索标题，不能搜索文章内容

我们来查看下 CodeX Docs 的映射文件路径下的结构

root@flexusx-c6b3:~/codex# tree -L 2              
.              
|-- db              
|   |-- aliases.db              
|   |-- files.db              
|   |-- pages.db              
|   -- pagesOrder.db               |-- docker-compose.yml               |-- docs-config.yaml               -- uploads              
`-- 38fc7dea374d9535b7df8045801db80f.png              

2 directories, 7 files    

•db 即为数据库目录

•uploads 即为上传文件目录

随着软件项目的复杂性不断增加，保存、分享和更新项目相关文档的重要性日益凸显，CodeX Docs 采用了当下流行的Editor.js生态系统，目标是提供一个便捷且功能丰富的平台，帮助团队记录、组织和分享信息。它不仅仅是一个文档工具，更是一个能够提升团队协作效率和减少沟通障碍的利器。作为文档和文档管理工具，我们使用了文档的编辑/更新和搜索功能，还有更多有趣的设置和功能就需要自行探索了。

四、总结  

CodeX Docs项目以其开放性、易用性和强大功能为现代团队提供了不可或缺的文档解决方案。不论是初创企业还是大型团队，CodeX Docs都能为其提供有效的支持。通过这款工具，文档的编写和管理将不再是企业发展中的阻力，而是推动其前进的重要驱动力。此次使用的Flexus X实例配置还是很高的4核12G-100G-3M规格的基础模式，文档的编辑很顺畅，预览加载也很快，项目是轻量级的，也没有添加一些无关内容，整体占用很低。

avatar
文章
阅读
粉丝