Skip to content

Latest commit

 

History

History
124 lines (96 loc) · 3.73 KB

README.md

File metadata and controls

124 lines (96 loc) · 3.73 KB
Raw

代码说明

整体代码采用nodejs + vue + element-ui实现, 分两部分:

  • 客户端部分: 客户端表示vue页面这部分, 在client目录下
  • 服务器端部分: 服务器代码在src目录下

代码逻辑

服务器启动以后, 会定时git clone TarsDocs, 到client/markdown目录下, 注意服务器需要安装 git web页面会实时解析markddown文件, 并转化成html

你可以用这个工程来解析其他的markdown文件!

如何调试

启动client:

  • 进入client目录
  • npm install
  • npm run dev

启动server:

  • 源码目录: npm install
  • npm run dev

访问: http://localhost:6001/ 即可

开发时修改任何代码, 服务器和客户端都会自动编译和更新.

源码如何发布

编译client

  • 进入client目录
  • npm run build
  • 运行后, 生成所有client的页面和js等

编译server

  • 由于server采用的typescript实现, 因此需要编译
  • 在源码目录, npm run build

完成以上工作后, 代码都编译并准备好(这个也是提交到git的状态), 需要运行时, 采用pm来控制服务, 先安装pm:

npm install pm2

npm run prd

注意默认开启的是6080端口!!(config/config.json中修改)

config.json字段说明

服务的关键字段都在config.json中(config/config.json)

{
    "webConf": {
        "port": 6080,               //服务绑定端口
        "loggerPath": "./log",      //日志路径
        "logFileKeepDays": "1",     //日志保存天数
        "defaultLanguage": "cn",    //缺省语言(目前版本无效)
        "title": "TARS文档"          //web的title
    },
    "login": {
        "enableLogin": false,           //是否开启登录(email验证和登录)
        "email": {                      //email smtp信息, 用于发送邮件
            "smtp": {
                "host": "smtp.exmail.qq.com",
                "port": 465,
                "secure": true,
                "auth": {
                    "user": "[email protected]",
                    "pass": "xxxxx"
                }
            },
            "schema": "http://doc.tarsyun.com",            //web跳转地址
            "ignoreEmail": ["gmail.com"]   //屏蔽哪些邮箱
        },
        "dbConf":  {                        //如果有登录, 则需要配置db信息
            "database": "db_gitbook",
            "host": "127.0.0.1",
            "port": "3306",
            "user": "root",
            "password": "Root@12345",
            "charset": "utf8mb4",
            "pool": {
                "max": 10,
                "min": 0,
                "idle": 10000
            }
        }
    },
    "git": {
        "repo": "https://github.com/TarsCloud/TarsDocs",    //repo地址
        "path": "./client/markdown",        //拉取到本地的地址
        "interval": 3600000,                //定时拉取时间
        "cloneOnStart": false              //是否定时clone
    }
}

Docker发布

可以编译成docker来发布

#制作docker
npm run docker
#运行docker
docker run -p 8080:6080 -v /data/gitbook/config.json:/root/gitbook/dist/config/config.json -v /data/gitbook/TarsDocs:/root/gitbook/client/markdown tarscloud/gitbook
docker run -p 8080:6080 -v /data/gitbook/config-git.json:/root/gitbook/dist/config/config.json -v /data/gitbook/doc:/root/gitbook/client/markdown tarscloud/gitbook

关于搜索

搜索用到分词技术, 使用了一个nodejieba的库, 注意他底层是c++写的, 因此导致了这部分是无法跨平台的!

关于用户系统

默认是没有开启用户登录的, 如果开启用户登录, 则用户需要通过email注册和激活, 才能完成访问. 开启方式: 打开webConf.ts中的enableLogin

关于配置

你可以指定自己的git, 修改/config/webConf.ts即可(正式发布, 不要忘了npm run build)