文档工具--showdoc(一)

一、showdoc简介

Showdoc 这款开源(免费)文档管理系统, 可以部署企业内部, 后台使用 php + sqlite, 支持indows/Linux/Docker 部署形式。
showdoc 的功能:

  1. 文档编辑语法采用 markdown, 编辑器做的挺不错.
  2. 支持文档版本管理
  3. 可以将文档导出为 word 软件格式
  4. 权限控制: 可以新建公开项目和私密项目, 可以管理项目成员.
  5. 文档搜索功能: 可以在一个项目搜索文档, 支持全文搜索, 但不支持跨项目的搜索。
    源码地址:https://github.com/star7th/showdoc
  6. 安装部署
[root@localhost ~]# yum update
[root@localhost ~]# yum install -y yum-utils device-mapper-persistent-data lvm2
[root@localhost ~]# yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
[root@localhost ~]# yum list docker-ce --showduplicates | sort -r
[root@localhost ~]# yum list installed | grep docker
[root@localhost ~]# yum remove -y docker.x86_64
# 安装Docker-ce
[root@localhost ~]# yum install -y docker-ce
# 启动Docker
[root@localhost ~]# systemctl start docker

建立映射目录:

[root@localhost ~]# mkdir -p /home/docker/showdoc/html

分配权限:

[root@localhost ~]# chmod  -R 777 /home/docker/showdoc

运行容器:

[root@localhost ~]# docker run -d --name showdoc --restart=always -p 40080:80 -v /home/docker/showdoc/html:/var/www/html/ star7th/showdoc

转移数据:

[root@localhost ~]# docker exec showdoc \cp -fr /showdoc_data/html/ /var/www/

再次设置权限:

[root@localhost ~]# chmod  -R 777 /home/docker/showdoc

http访问宿主机40080端口,用户名showdoc,密码:123456

二、nginx配置

server {
        listen       80;
        server_name  docs.huoniu8.com;

        access_log  logs/docs.access.log  main;
        charset utf-8;
        proxy_connect_timeout 180;
        proxy_send_timeout 180;
        proxy_read_timeout 180;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarder-For $remote_addr;

        location / {
                        proxy_pass http://127.0.0.1:40080;
                }
    }

三、安装配置

  1. 安装配置
    地址:http://docs.xxxx.com/install/index.php
    文档工具--showdoc(一)_第1张图片
    选择语言

    文档工具--showdoc(一)_第2张图片
    安装成功

四、登录使用

文档工具--showdoc(一)_第3张图片
登录

1. 创建项目

文档工具--showdoc(一)_第4张图片
创建项目

文档工具--showdoc(一)_第5张图片
创建项目

2. 管理后台

文档工具--showdoc(一)_第6张图片
管理后台

文档工具--showdoc(一)_第7张图片
站点设置

五、自定义

  1. 代码克隆(下载源码)
[root@localhost ~]# git clone https://github.com/star7th/showdoc.git
  1. ShowDoc配置访问默认为登录界面
    将web_src/router目录中的index.js
  routes: [
    {
      path: '/',
      name: 'Index',
      component: Index
    },
    {
      path: '/user/login',
      name: 'UserLogin',
      component: UserLogin
    },

修改为:

  routes: [
    {
      path: '/',
      name: 'UserLogin',
      component: UserLogin
    },

修改完后需使用node进行编译:

node build/build.js

将F:\showdoc\web目录下的文件覆盖


文档工具--showdoc(一)_第8张图片
F:\showdoc\web

文档工具--showdoc(一)_第9张图片
Linux
  1. 构建
    在showdoc目录下,执行命令:
[root@localhost ~]# docker build -t showdoc ./
  1. 运行
[root@localhost ~]# docker run -d --name showdoc --restart=always -p 40080:80 -v /home/docker/showdoc/html:/var/www/html/ showdoc
[root@localhost ~]# docker exec showdoc \cp -fr /showdoc_data/html/ /var/www/
[root@localhost ~]# chmod  -R 777 /home/docker/showdoc

六、常见问题:

  1. 请赋予 server/Application/Common/Conf/config.php 文件以可写权限!
    查看selinux状态
# 如果SELinux status参数为enabled即为开启状态
[root@localhost ~]#   /usr/sbin/sestatus -v 
SELinux status:                 disabled
# 进入docker

# 开放几个目录的写权限的步骤
docker exec -i -t showdoc /bin/sh
chmod 777 -R /var/www/html/server/Application
chmod 777 -R /var/www/html/install
chmod 777 -R /var/www/html/Public/Uploads/
chmod 777 -R /var/www/html/Sqlite/

你可能感兴趣的:(文档工具--showdoc(一))