第七星尘

ShowDoc部署手册

ShowDoc介绍

关于ShowDoc的介绍,请访问:http://blog.star7th.com/2015/11/1816.html

云安装

showdoc与腾讯云达成了合作,你可以通过腾讯云实验室的引导,一步步地在linux上安装showdoc,简单易上手:https://cloud.tencent.com/developer/labs/lab/10108
如果你想部署到自己已有服务器,则可以看后续教程。

Docker环境 或 PHP环境

如果你使用Docker安装ShowDoc,则无须再手动安装PHP环境。请忽略本文后续教程,跳转至:http://www.showdoc.cc/help?page_id=65610

如果你手动安装PHP环境,可参考:http://www.showdoc.cc/php 。ShowDoc需要PHP5.3及以上版本、php-gd库、php-pdo模块。

安装ShowDoc

1、全新安装

①、如果你熟悉命令行,则可通过Composer安装 。如果采用手动方式安装,则请下载代码:
https://github.com/star7th/showdoc

②、文件夹权限

请确保/Application/Runtime 、 /Public/Uploads 、 /Sqlite 、 /Sqlite/showdoc.db.php 有可写权限

③、Windows服务器

在php.ini里面把”extension=php_sqlite.dll”和”extension=php_pdo_sqlite.dll”启用以便开启对SQlite的支持;也启用php_mbstring.dll;Linux服务器则不需要此操作。

④、运行安装

在浏览器访问http://xxxx.com/install/ (请将网址更改为你服务器域名或ip)。安装完毕后可使用默认账号showdoc(密码:123456)登录,也可以自行注册账户

2、升级安装

①、如果你是ShowDoc早期使用mysql数据库的那部分用户,请参考这里转移数据 http://www.showdoc.cc/help?page_id=31990 其他用户请忽略本段话,往下看。

②、如果你熟悉命令行,则可通过Composer升级 。如果采用手动方式安装,则请下载代码:
https://github.com/star7th/showdoc

③、备份旧代码目录

④、全新安装(具体操作参考上面”全新安装”部分的文字)并初始化ShowDoc完毕后,进入之前备份的目录。将Sqlite/sqlite.db.php(这是原来的数据库文件),以及Public/Uploads/下的所有文件(这些是上传的图片。如没有图片则可忽略之),全部复制并覆盖到新showdoc目录的相应文件。覆盖后重新给这些文件可写权限。

⑤、 覆盖文件后,用浏览器访问http://xxxx.com/index.php?s=/home/update/db (请将网址更改为你服务器域名或ip)。看到OK字样便证明成功升级.

错误排查

常见问题:http://www.showdoc.cc/3&page_id=16118

使用在线的ShowDoc

如果你没有自己的服务器,但又想使用ShowDoc作为分档分享工具,你可以使用在线的ShowDoc http://www.showdoc.cc
http://www.showdoc.cc 作为在线服务会长期维护,请放心托管你的文档数据。使用在线服务时请记住showdoc唯一官方网址https://www.showdoc.cc

ShowDoc交流群

  • ShowDoc使用交流qq群
    交流群①:564671853(已满)
    交流群②:174709989(已满)
    交流群③:667194478
分享到: 更多
码字很辛苦,转载请注明来自第七星尘的技术博客《ShowDoc部署手册》

评论

  1. 周哲 #1

    这个很痛苦呀,石永红PHP方式安装的

    回复
    8天前
  2. 和气生成 #2

    兼容IE8吗?

    回复
    2018-08-30
  3. charles #3

    docker部署把安装目录挂载出来后无法启动,每次手动去复制容器里备份数据库,太麻烦了吧

    回复
    2018-05-25
  4. ZMQP #4

    您好,我想修改下页面,请问该怎么操作呢?web和web_src里都替换了发现并没有生效…docker重启容器也没用 😮

    回复
    2018-05-18
  5. 问道 #5

    手册很烂,并不是傻瓜式的

    回复
    2018-04-24
  6. justin_si #6

    是否可以开发用户group权限管理,看到数据库后端好像是有保留gid的。

    回复
    2018-03-26
  7. 南瓜 #7

    [root@centos-linux-2 html]# docker build -t showdoc ./
    unable to prepare context: unable to evaluate symlinks in Dockerfile path: lstat /var/www/html/Dockerfile: no such file or directory

    回复
    2018-03-21
  8. ceui #8

    无法注册,默认用户名showdoc和123456登录提示用户名密码错误

    回复
    2018-03-9
    • ceui

      apt-get install php-sqlite3

      回复
      2018-03-10
  9. LiuKZ #9

    我自己部署了本地服务器了,想把showdoc上面的项目导出到本地环境,应该怎么做呢

    回复
    2018-01-23
    • 第七星尘

      没有开发这样的迁移工具。只能手动复制过去

      回复
      2018-01-23
  10. 译名*o #10

    请问在哪关闭注册、登录时候的验证码功能?
    文章说了,/Application/Common/Conf/Config.php
    具体指的是哪一个参数呢?
    注册就是验证码错误!

    回复
    2017-11-14
    • 第七星尘

      参考常见问题链接https://www.showdoc.cc/help?page_id=16118

      回复
      2017-11-14
  11. fzico #11

    我想问一下,我在一台服务器上部署了showdoc,里面已经有很多文档,我想迁移到另外一台机器,该怎么做?

    回复
    2017-09-27
    • 第七星尘

      如果是最新版程序,直接复制过去并赋予权限即可。如果是旧程序,可以先按照部署/升级文档升级。

      回复
      2017-09-27
  12. 大山的孩子 #12

    请问下,我安装后,登录后报如下错误,是什么原因?
    http://localhost/apis/index.php?s=/Home/Item/index
    SQLSTATE[HY000]: General error: 1 no such table: item_top
    错误位置
    FILE: D:\wamp\www\apis\ThinkPHP\Library\Think\Db\Driver.class.php  LINE: 156

    回复
    2017-09-19
    • 第七星尘

      你升级程序的时候没升级数据库。详细看升级文档。请严格按照步骤操作。

      回复
      2017-09-19
  13. Geeks_Chen #13

    你好,我在本地搭建showdoc,写完的文档不能导出,求怎么解决?

    回复
    2017-08-16
    • 第七星尘

      这个不是配置文件引起的。而是某个安装环境可能没安装全。另外不建议在本地部署,最好部署在linux服务器

      回复
      2017-08-16
  14. Geeks_Chen #14

    你好,我在本地搭建showdoc环境,但是写后的API文档不能导出,怎么破?

    回复
    2017-08-16
    • 第七星尘

      不知道是否少了什么扩展。尝试根据这个来安装环境https://www.showdoc.cc/php?page_id=14595

      回复
      2017-08-16
      • Geeks_Chen

        我已经配置好环境了,我能修改某个配置文件,来让他可以导出吗?

        回复
        2017-08-16
  15. 李宣 #15

    我无论注册还还是登录都提示 我密码或用户名错误 。是我没链接上数据库嘛,我是linux环境

    回复
    2017-07-21
    • 第七星尘

      注册时时不可能有密码错误这种提示的,因为注册时不会检测密码正确性。我也不清楚你是怎么弄的

      回复
      2017-07-21
      • 连晋

        这个错误原因是因为 linux上面没有装sqllite 导致的 =-=

        回复
        2017-10-23
    • 高山

      同样的原因,注册后,就提示用户名或密码不正确,没法登陆。

      回复
      2017-07-21
      • 第七星尘

        我刚下载了github上的版本全新安装了下,是可以登录注册的

        回复
        2017-07-21
    • 高山

      注册都不能成功,填好注册信息后,直接提示用户名或密码不正确

      回复
      2017-07-21
      • 第七星尘

        我刚看了源码,出现这种情况的可能是用户名已经存在了。而对于这个已存在用户,你输入的密码不对。

        回复
        2017-07-21
        • 高山

          你点一下我的名字,可以进入到搭建的文档服务器,你可以看看具体情况

          回复
          2017-07-21
          • 第七星尘

            你是通过什么样的方式安装的?代码是composer还是直接下载的?环境是什么?

            2017-07-21
          • 高山

            直接下载的压缩包,上传服务器部署好后,没做其他操作。环境是ubuntu 16.04 apache2.4 php5.6

            2017-07-21
      • 第七星尘

        应该是写入数据库文件的时候失败了。Sqlite/showdoc.db.php是数据库文件。至于为什么写不进去,不知是否你系统有什么限制。我这边安装是没问题的。你要不试试别的服务器看行不行?另外你可以加下showdoc交流群②:174709989

        回复
        2017-07-21
        • lyy

          我也遇到了 ubuntu 17.04 死活无法注册和登录,文件权限都给了,windows下正常

          回复
          2017-09-2
        • hxn

          我也遇到了无法注册和登录的情况,文件权限给了,也安装好了。环境是ubuntu16.04 php7.0

          回复
          2017-09-29
          • 第七星尘

            安装php7-sqlite

            2017-09-29
  16. arony #16

    每次进行一个操作都有一个等待跳转/点击跳转的页面,这个能关掉吗?还是说这个有不可替代的作用?

    回复
    2017-07-8
    • 第七星尘

      后续更新再改掉这个交互方式。没什么不可替代,只是当初省代码采用了这种交互方式而已。比较理想的交互方式是ajax,然后前台弹浮窗提示。

      回复
      2017-07-8
  17. ainy #17

    这个安装以后,建立了项目,进入以后,也是首页的那个介绍,请问这个怎么改一下呢,就是打开这个网站,直接打开某个项目,或者是总项目的列表

    回复
    2017-06-28
    • 第七星尘

      暂不支持自定义。如果需要可以二次开发,修改模板。

      回复
      2017-06-29
  18. 一升米 #18

    您好,我是red hat /tomcat服务器,可以装完php,然后使用showDoc么?这种有教程么?谢谢

    回复
    2017-06-28
    • 第七星尘

      showdoc依赖php,能安装php就应该可以使用。你把showdoc放到php所访问的web目录

      回复
      2017-06-28
      • 一升米

        您好,我已经安装好了,目前发现一个问题,我在windows机器上写好文档,只用了一些H1,H3,H4等这些标题格式,其他的就是普通文字,然后使用linux机器,访问写好的项目文档,显示不全。例如我标题是“标题1234”,内容是“H1格式标题 换行”
        “正文”
        ,我在linux的火狐浏览器访问时,只能显示标题1234,然后显示H1格式标题,这几个字的上半部分,下面的全都看不到,大概过5分钟,才能整篇文章出来。这是为什么啊?我是同一个局域网啊。。我这两台机器干别的事情,都没这么慢啊。。无论何时点,目前都是出来标题的一半。再等5分钟。好诡异

        回复
        2017-06-29
      • 一升米

        您好,我找到原因了,因为我是内网,不联网的,我发现在打开单页时,要访问cdnjs.cloudflare.com这个网站,特别慢,每次都是先等待打开这个网站,过5分钟,访问不了这个网站,再打开单页,请问这个怎么设置,才能不访问cdnjs.cloudflare.com这个网站啊?我是内网使用showdoc

        回复
        2017-06-29
        • 第七星尘

          github上的新版已修复此问题

          回复
          2017-06-29
  19. albert #19

    楼主,这个有k8s部署版本吗,或者是你给我一个docker image 版本

    回复
    2017-06-27
    • 第七星尘

      参考docker安装部分,自己创建镜像。然后转移到自己需要的地方。

      回复
      2017-06-27
  20. 果果 #20

    导出word文档中图片太大导致显示不全,希望在导出里面能给图片自动调整宽度

    回复
    2017-05-17
    • 第七星尘

      其实我建议编辑图片的时候本身不应该编辑得那么大。写文档的时候可以尝试按模块拆分,不要全写在一块

      回复
      2017-05-17
      • 果果

        后来我试了600宽的图片,还是会被拉扯变形,html显示正常,就是导出word后不正常

        回复
        2017-05-18
        • 第七星尘

          html网页可以设定宽度,自然正常。word里面导出的是原始尺寸,图片多大它就显示多大。后面找时间优化这个问题。当前我建议你使用在线文档分享(相对离线文档而言会好些)

          回复
          2017-05-18
  21. 楼剑波 #21

    怎么看整个博客写了哪些文章,有没有目录

    回复
    2017-04-27
  22. 龙心安兰 #22

    有Java版本吗?

    回复
    2017-04-8
  23. 江旭东 #23

    开放API中说的将word文档批量导入,是需要先自己将word文档处理成文本文档,然后用api导入吗?

    回复
    2017-03-24
    • 第七星尘

      是的。因为word的格式太多无法统一,所以必须开发者自身先整理

      回复
      2017-03-24
  24. Charles #24

    可以有多語言可選嗎?

    回复
    2017-03-21
    • 第七星尘

      安装的时候可以选择英文。繁体中文还不支持,因为之前考虑这部分需求比较少,所以不花精力去维护了

      回复
      2017-03-22
  25. 流线胖小子 #25

    您好。SHOWDOC非常棒!我们的使用场景是企业的文档管理。希望可以在文档中增加版本号和上传日期、修改日期。我们在使用过程中希望能在文档中增加评论和回复功能。以上是我们的两个需求。谢谢。

    回复
    2017-03-13
  26. 别人笑我太疯癫丶 #26

    建议改为右侧滑动时左侧导航栏不滑动,虽然是一个小小的东西,感觉体验更好

    回复
    2017-03-8
  27. 长空 #27

    安装的时候报错『请赋予 Application/Common/Conf/config.php 文件以可写权限!』
    但是Application/Common/Conf/config.php这个文件根本就不存在呀

    回复
    2017-03-6
  28. zing #28

    提示请赋予 Application/Common/Conf/config.php 文件以可写权限!
    可是Application/Common/Conf/目录下没这个文件

    回复
    2017-03-5
  29. 联文恋闻 #29

    有没有支持ctrl+s保存的功能,因为习惯问题,每次保存ctrl+s之后,总是跳转页面,特别不方便,希望支持一下。

    回复
    2017-02-23
    • 第七星尘

      往后考虑加一个自动保存cookie的功能,到时不必每次手动保存。考虑了下,ctrl+s还是做成保存后跳转的方式会更好些。否则对很多人而言明明保存了还要点击多一次跳转才能看到页面,这会更多步骤。

      回复
      2017-02-23
  30. A大数据挖机-定制各类数据分析报告 #30

    希望出一个 不需要框架的版本,另外请问哪里还能找到原先支持mysql的那个版本

    回复
    2017-01-23
    • 第七星尘

      使用框架是为了节约开发时间;不支持mysql是为了节约维护精力,已经无法下载mysql版本

      回复
      2017-01-23
      • wangyw

        1.使用sqlite,理论上讲,是不是文档巨多之后,页面响应速度会下降 2.我改了一些配置和展现,以后升级是不是会被覆盖掉?

        回复
        2017-05-24
        • 第七星尘

          sqlite能够承受的文档足以,项目数在一万内的都没问题;极少有人会超过这个数。;会被覆盖掉。

          回复
          2017-05-24
  31. 飘泊 #31

    部署完(运行完install/index.php)进入首页一直nginx错误。

    2017/01/17 10:04:08 [error] 7387#0: *270 recv() failed (104: Connection reset by peer) while reading response header from upstream, client: 192.168.60.xxx, server: http://www.lnmp.org, request: "GET /showdoc/ HTTP/1.1", upstream: "fastcgi://unix:/tmp/php-cgi.sock:", host: "192.168.60.xxx"

    Logs下面也没有任何输出,请问是什么问题啊?

    回复
    2017-01-17
    • 第七星尘

      你都还没安装好php吧。nginx需要php-fpm配合

      回复
      2017-01-17
      • 飘泊

        PHP肯定安装好了,这个机器还运行几个本地站点。

        回复
        2017-01-17
        • 第七星尘

          其实这个在网上搜索一下便可以找到答案http://www.songlin51.com/archives/1284.html

          回复
          2017-01-17
          • 飘泊

            查看过php错误日志,不是这个问题。
            刚重装了一遍swoole扩展,发现错误变成另一种了。要3g的内存是什么情况。。。
            ################

            Allowed memory size of 134217728 bytes exhausted (tried to allocate 3140530577 bytes)
            错误位置

            FILE: /home/www/showdoc/ThinkPHP/Library/Think/Template.class.php  LINE: 427

            ThinkPHP3.2.3 { Fast & Simple OOP PHP Framework } — [ WE CAN DO IT JUST THINK ]

            2017-01-17
          • 第七星尘

            看来数据大了后内存占用会比较大。尝试用htq吧,数据放在redis中,自身的内存不会占用太多

            2017-01-17
  32. punk #32

    showdoc 忘记用户名,忘记密码,资料找不到欲哭无泪,建议还是做下账户绑定。

    回复
    2017-01-11
    • 第七星尘

      你这条评论不知为何进入垃圾箱了。http://www.showdoc.cc有提供绑定邮箱功能

      回复
      2017-01-16
      • punk

        之前忘记绑定邮箱 后面再找忘记用户名了 尴尬

        回复
        2017-02-18
        • 俺也是

          我现在也是,没有绑定邮箱,现在密码忘记了,试了一下午试不出来,怎么才能联系到客服,能不能通过手机号

          回复
          2018-07-2
  33. 飞鸟鸣鸾 #33

    虚拟主机不能装吗?我install的时候install/ajax.php报500错误

    回复
    2017-01-10
    • 第七星尘

      如果它要求的扩展虚拟主机没有,那就是不支持了。虚拟主机经常禁止一些功能,不建议安装,我也不打算做兼容虚拟主机测试

      回复
      2017-01-10
      • 飞鸟鸣鸾

        我看了下,我的虚拟主机有pdo_sqlite和mbstring,没有sqlite,或许是这个原因吧,我本地安装一切正常

        回复
        2017-01-10
  34. halfopen #34

    简洁,正是我需要的!

    回复
    2016-12-8
  35. nathan #35

    请问在哪关闭注册、登录时候的验证码功能?

    回复
    2016-10-21
  36. 啊啊啊 #36

    文章怎么排序啊

    回复
    2016-10-15
  37. kintsen #37

    什么时候能够支持ldap验证?

    回复
    2016-10-8
  38. 宝金所 #38

    按照此步骤安装后,到浏览器中无法打开登陆页面,求助博主

    回复
    2016-09-13
  39. 故事、自己写 #39

    不错,非常感谢~~~

    回复
    2016-09-13
  40. 大大牙 #40

    我打开editor.md的流程图和时序图的支持,可以在编辑器预览的时候看到。但是保存后,回到首页的时候,没法看到,请问有什么办法打开时序图和流程图的支持吗??

    回复
    2016-09-9
  41. porchliu #41

    @博主 你的评论显示重复呀。看着好累。

    回复
    2016-09-6
    • 第七星尘

      之前备份了博客程序,迁移博客后,备份数据跟现网数据一起显示了。我想办法去重下

      回复
      2016-09-6
  42. PeteLuo #42

    markdown编辑器的 目录标签[TOC]保存后没法查看,能否扩展

    回复
    2016-08-29
  43. PeteLuo #43

    我的项目的erp项目,所以会有多级菜单,所以写的文档可以大致为模块->子模块->菜单->页面等进行层级划分,这里有经四层了。现在最多支持三层目录,我需要省略最顶上的一层,能否考虑添加子目录不受限制,可以添加n个子目录

    回复
    2016-08-12
    • 第七星尘

      暂不考虑,多层子目录会导致左侧菜单难看。建议按逻辑拆分成多个子项目来写

      回复
      2016-08-12
  44. Tian #44

    原来托管到www.showdoc.cc的数据,有办法迁移到本地部署的服务器吗?

    回复
    2016-08-8
    • 第七星尘

      没有开发这样的导入导出工具。只能手动把页面复制过去了

      回复
      2016-08-8
  45. shi #45

    这是基于ThinkPHP的,感觉如果不是使用TP的话,是不感觉项目有点臃肿?

    回复
    2016-07-25
    • 第七星尘

      有点臃肿指的是?

      回复
      2016-07-25
      • shi

        就是被迫使用一个TP框架

        回复
        2016-07-26
        • 第七星尘

          用框架是为了在此基础上少些一些代码,增加开发效率。臃肿点影响并不大,showdoc对性能基本上没啥要求。如果不用框架的话也可以的,只是会浪费多一点开发时间

          回复
          2016-07-26
  46. succeed #46

    博主,请问为什么我windows下跑的没有问题,linux下部署上去搜索出来的结果老是搜到全部的,等于没搜到结果!可以解答一下吗?

    回复
    2016-06-29
  47. saint宝宝 #47

    原始密码忘记了怎么办。。。HELP。。

    回复
    2016-06-14
  48. 2ero #48

    做得蛮简单实用的,部署也比较简单,不过有三个问题我这边测试后觉得需要修改的
    1.历史记录问题,现在只能回滚历史记录,不过不能查看回滚前的详情,希望能修正,最后是不用登录,直接在页面就可以选择旧的记录来查看
    2.二级目录的名称修改
    3.导出文档的样式问题,现在导出确实太丑了,基本没什么用,希望能够弄得好看点

    回复
    2016-06-13
    • 第七星尘

      可以看详情的。你点击恢复到此版本后,详情会被加载到编辑器。你保存后才会真正覆盖。二级目录可以修改,在新建目录的那个页面,点击下方的目录列表可编辑。导出word的样式不好弄,迟点看看吧

      回复
      2016-06-13
  49. 刘明 #49

    之前有个mysql数据库相关 sql文件现在没有了么?

    回复
    2016-06-9
  50. 陆建国    #50

    文件夹权限加了还是 403 Forbidden

    回复
    2016-06-2
  51. JohnnieFucker #51

    自己之前在saas版上建的一些文档可以导出数据,然后导入到自己本地部署的数据库里么?

    回复
    2016-05-30
    • 第七星尘

      你说的是在线ShowDoc吗?没有开发导出工具。之前以为个人数据的都会自己部署服务器,所以觉得这个工具没什么需求

      回复
      2016-05-30
      • JohnnieFucker

        那麻烦能给我单独导一份sql么

        回复
        2016-05-31
        • 第七星尘

          你把那些页面一个个复制过去吧。因为那些页面源文件是markdown格式,直接复制过去就可以了,不需要再调样式。

          回复
          2016-05-31
  52. 赵昌柱 #52

    感谢分享这么好的工具.
    使用中遇到一点问题: 屏幕适配不太好, 当屏幕宽度不够大时, 内容跑到导航的下面去了, 这样看起来很乱.

    回复
    2016-05-28
  53. 西西弗 #53

    安装文档再详细一点吧,不熟悉php的人操作起来有点摸不着头脑。

    回复
    2016-05-23
    • 第七星尘

      安装了PHP环境后把代码下载到web目录下,然后给某些文件夹权限就好了

      回复
      2016-05-23
      • Sinri

        其实把这里的【某些】直接写进一个脚本,在命令行下跑一下就搞完的那种是不是更快。

        回复
        2016-12-9
    • 第七星尘

      不懂PHP的可参考此教程 http://doc.star7th.com/3007

      回复
      2016-05-27
  54. iJeremy #54

    用的挺好,自己根据项目需要觉得有点不足的地方:1、只支持两级目录;2、导出没有表格样式;不知道这两个以后能否支持?

    回复
    2016-05-23
    • 第七星尘

      短期内计划支持到三级目录;优化word的样式尚未有明确打算

      回复
      2016-05-23
      • iJeremy

        非常期待, ,具体什么时间上线?

        回复
        2016-05-23
        • 第七星尘

          现在上线了。可以升级安装了;此外教程末尾新增了qq交流群

          回复
          2016-05-23
          • hls

            你好 ,原来的nginx已经有站点配置 ,80端口已经使用了,应该怎么部署啊

            2017-07-31
  55. forritzstar #55

    我的1024屏幕适配不是很好
    但还是要支持~

    回复
    2016-05-21
  56. 江湖百晓生 #56

    66666

    回复
    2016-05-20