云策文档是一款开源知识管理工具。通过独立的知识库空间,结构化地组织在线协作文档,实现知识的积累与沉淀,促进知识的复用与流通。
Go to file
fantasticit 8f9cecf277 feat: improve log message 2022-04-25 09:19:48 +08:00
packages feat: improve log message 2022-04-25 09:19:48 +08:00
scripts Update README in scripts 2022-04-24 22:52:57 +08:00
.gitignore root: ignore dev.yaml 2022-02-22 23:17:17 +08:00
.prettierignore chore: format code 2022-03-12 10:31:03 +08:00
.prettierrc feat: improve tiptap 2022-03-21 16:46:27 +08:00
.stylelintrc.js refactor: format the code 2022-03-27 15:43:06 +08:00
README.md Update README.md 2022-04-11 22:13:56 +08:00
nginx.conf feat: improve nginx.conf 2022-04-11 22:02:03 +08:00
package.json fix: fix pre-commit hook 2022-04-24 22:09:58 +08:00
pnpm-lock.yaml feat: add pre-commit hook 2022-04-24 21:23:36 +08:00
pnpm-workspace.yaml root: upload source code 2022-02-20 19:51:55 +08:00

README.md

think

简介

Think 是一款开源知识管理工具。通过独立的知识库空间,结构化地组织在线协作文档,实现知识的积累与沉淀,促进知识的复用与流通。同时支持多人协作文档。使用的技术如下:

  • MySQL:数据存储
  • next.js:前端页面框架
  • nest.js:服务端框架
  • AliyunOSS:对象存储
  • tiptap:编辑器及文档协作

可访问云策文档帮助中心,查看更多功能文档。

链接

云策文档已经部署上线,可前往注册使用。

预览

首页 知识库 新建文档 编辑器 协作 收藏

项目运行

本项目依赖 pnpm 使用 monorepo 形式进行代码组织,分包如下:

  • @think/config: 客户端、服务端、OSS、MYSQL、Redis 等配置管理
  • @think/domains:领域模型数据定义
  • @think/constants:常量配置
  • @think/server:服务端
  • @think/client:客户端

pnpm

项目依赖 pnpm请安装后运行npm i -g pnpm)。

数据库

首先安装 MySQL,推荐使用 docker 进行安装。

docker image pull mysql:5.7
# m1 的 mac 可以用docker image pull --platform linux/x86_64 mysql:5.7
docker run -d --restart=always --name think -p 3306:3306 -e MYSQL_ROOT_PASSWORD=root mysql:5.7

然后在 MySQL 中创建数据库。

docker container exec -it think bash;
mysql -u root -p;
CREATE DATABASE  `think` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

可选Redis

如果需要文档版本服务,请在 @think/configyaml 配置中进行 db.redis 的配置。

docker pull redis:latest
docker run --name think-redis -p 6379:6379 -d redis --appendonly yes --requirepass "root"

本地运行

首先clone 项目。

git clone --depth=1 https://github.com/fantasticit/think.git your-project-name

然后,安装项目依赖。

pnpm install
  • 启动项目
pnpm run dev

前台页面地址:http://localhost:3000。 服务接口地址:http://localhost:5001。 协作接口地址:http://localhost:5003

如需修改配置,可在 packages/config/yaml 下进行配置。

配置文件

默认加载 dev.yaml 中的配置(生产环境使用 prod.yaml )。

# 开发环境配置
server:
  prefix: '/api'
  port: 5001
  collaborationPort: 5003
  # 最大版本记录数
  maxDocumentVersion: 20

client:
  assetPrefix: '/'
  apiUrl: 'http://localhost:5001/api'
  collaborationUrl: 'ws://localhost:5003'

# 数据库配置
db:
  mysql:
    host: '127.0.0.1'
    username: 'root'
    password: 'root'
    database: 'think'
    port: 3306
    charset: 'utf8mb4'
    timezone: '+08:00'
    synchronize: true
  redis:
    host: '127.0.0.1'
    port: '6379'
    password: 'root'

# oss 文件存储服务
oss:
  aliyun:
    accessKeyId: ''
    accessKeySecret: ''
    bucket: ''
    https: true
    region: ''

# jwt 配置
jwt:
  secretkey: 'zA_Think+KNOWLEDGE+WIKI+DOCUMENTS@2022'
  expiresIn: '6h'

项目部署

生产环境部署的脚本如下:


node -v
npm -v

npm config set registry http://registry.npmjs.org

npm i -g pm2 @nestjs/cli pnpm

pnpm install
pnpm run build
pnpm run pm2

pm2 startup
pm2 save

nginx 配置

采用反向代理进行 nginx 配置,同时设置 proxy_set_header X-Real-IP $remote_addr; 以便服务端获取到真实 ip 地址

upstream wipi_client {
  server 127.0.0.1:3000;
  keepalive 64;
}

# http -> https 重定向
server {
  listen  80;
  server_name 域名;
  rewrite ^(.*)$  https://$host$1 permanent;
}

server {
  listen 443 ssl;
  server_name 域名;
  ssl_certificate      证书存放路径;
  ssl_certificate_key  证书存放路径;

  location / {
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_set_header Host $host;
    proxy_set_header X-Nginx-Proxy true;
    proxy_cache_bypass $http_upgrade;
    proxy_pass http://wipi_client; #反向代理
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  }
}

自动化部署

思路:在服务器部署 webhook然后在 github setting 中配置相应钩子,实现自动化部署

参考:webhook

资料