Add files via upload

documentation/en/AutoInstall.md

@@ -0,0 +1,66 @@
+### 前言
+ 自动脚本脚本利用docker来安装运行环境，适用于linux服务器。如果你的服务器没有docker服务，脚本会尝试安装之。安装docker的过程可能有些慢。如果你已经安装过docker，脚本会省略部分步骤，从而加快showdoc安装进度。
+ 
+当脚本安装docker失败时，你可以手动安装好docker后再执行脚本 。若装好了docker后还是再失败，则可根据此教程一步步地安装和调试： https://www.showdoc.cc/help?page_id=65610
+
+如果服务器系统本身不支持docker，则只能通过手动安装PHP环境的方式来运行showdoc：https://www.showdoc.cc/help?page_id=13732
+
+
+### 使用方法
+
+
+ 
+ ```
+  #下载脚本并赋予权限
+ wget https://www.showdoc.cc/script/showdoc;chmod +x showdoc;
+  
+  #默认安装中文版。如果想安装英文版，请加上en参数，如 ./showdoc en
+  ./showdoc en
+ 
+ ```
+
+
+### 安装后说明
+
+安装好后，showdoc的数据都会存放在 /showdoc_data/html 目录下。./showdoc 脚本可放置在任何目录，方便以后使用。也可以重新从官方地址下载。
+
+你可以打开 http://xxx.com:4999 来访问showdoc (xxx.com为你的服务器域名或者IP)。账户密码是showdoc/123456，登录后你便可以看到右上方的管理后台入口。建议登录后修改密码。
+
+对showdoc的问题或建议请至https://github.com/star7th/showdoc 处提issue。
+
+
+### 从手动方式升级到自动脚本方式
+如果你之前是手动安装showdoc，可考虑升级到现在这种自动脚本方式。升级到脚本方式后，就可以使用上脚本的自动化功能 ，比如说升级到最新版，重启，卸载等。
+升级方法：
+
+1，首先参考前文部分，在服务器全新安装一个showdoc
+
+2，把原来showdoc目录的Sqlite/showdoc.db.php覆盖/showdoc_data/html/Sqlite/showdoc.db.php  ，Public/Uploads覆盖 /showdoc_data/html/Public/Uploads
+
+3，执行命令
+
+ ```
+ chmod 777 -R /showdoc_data/html
+ ./showdoc update
+ ```
+ 
+ 
+### 其他命令
+
+ ```
+ 
+ #下面附上脚本其他命令，以便管理showdoc时可以用得上。
+
+ #停止
+ ./showdoc stop 
+ 
+ #重启
+ ./showdoc restart
+
+ #升级showdoc到最新版
+ ./showdoc update
+  
+ #卸载showdoc
+ ./showdoc uninstall
+ 
+ ```

documentation/en/ByDocker.md

@@ -0,0 +1,103 @@
+
+### 基础安装
+
+安装前请确保你的环境已经装好了docker 。docker的安装教程在网上比较多，可以搜索了解下。这里重点介绍showdoc.
+
+```
+# 原版官方镜像安装命令(中国大陆用户不建议直接使用原版镜像，可以用后面的加速镜像)
+docker pull star7th/showdoc 
+
+# 中国大陆镜像安装命令（安装后记得执行docker tag命令以进行重命名）
+docker pull registry.docker-cn.com/star7th/showdoc
+docker tag registry.docker-cn.com/star7th/showdoc:latest star7th/showdoc:latest 
+
+##后续命令无论使用官方镜像还是加速镜像都需要执行
+
+#新建存放showdoc数据的目录
+mkdir /showdoc_data
+mkdir /showdoc_data/html
+chmod 777 -R /showdoc_data
+
+#启动showdoc容器。启动完了后别忘记后面还有转移数据的步骤。
+docker run -d --name showdoc -p 4999:80 -v /showdoc_data/html:/var/www/html/ star7th/showdoc
+
+#转移数据。执行这里的时候留意命令行界面有没有权限禁止的错误提示。
+#如果有，则检查权限，或者安全限制（比如说可能selinux会禁止docker进程写文件）
+docker exec showdoc \cp -fr /showdoc_data/html/ /var/www/
+# 权限
+chmod 777 -R /showdoc_data
+
+```
+
+根据以上命令操作的话，往后showdoc的数据都会存放在 /showdoc_data/html 目录下。
+你可以打开 http://localhost:4999 来访问showdoc (localhost可改为你的服务器域名或者IP)。账户密码是showdoc/123456，登录后你便可以看到右上方的管理后台入口。建议登录后修改密码。
+对showdoc的问题或建议请至https://github.com/star7th/showdoc 出提issue。若觉得showdoc好用，不妨点个star。
+
+### 如何升级
+   这里的升级是针对上面docker安装方式的升级。如果你原来是采用非docker安装方式（如php安装方式）的话，请跳过本部分文字，直接去看下部分。
+```
+//停止容器
+docker stop showdoc 
+
+//下载最新代码包
+wget https://github.com/star7th/showdoc/archive/master.tar.gz
+//解压
+tar -zxvf master.tar.gz -C /showdoc_data/
+
+rm -rf  /showdoc_data/html_bak
+//备份。如果可以的话，命令中的html_bak还可以加上日期后缀，以便保留不同日期的多个备份
+mv /showdoc_data/html  /showdoc_data/html_bak
+mv /showdoc_data/showdoc-master /showdoc_data/html  ##// */
+
+//赋予权限
+chmod 777 -R /showdoc_data/html
+
+//启动容器
+docker start showdoc
+
+//执行安装。默认安装中文版。如果想安装英文版，将下面参数中的zh改为en
+curl http://localhost:4999/install/non_interactive.php?lang=zh
+
+//转移旧数据库
+\cp  -f  /showdoc_data/html_bak/Sqlite/showdoc.db.php /showdoc_data/html/Sqlite/showdoc.db.php
+
+//转移旧附件数据
+\cp -r -f /showdoc_data/html_bak/Public/Uploads /showdoc_data/html/Public/Uploads
+
+// 执行数据库升级，看到OK字样便证明成功
+curl http://localhost:4999?s=/home/update/db
+
+//如果中途出错，请重命名原来的/showdoc_data/html_bak文件为/showdoc_data/html ，然后重启容器便可恢复。
+
+```
+
+
+### 非docker安装方式如何升级到docker安装方式
+
+先参考前文，用docker方式全新安装一个showdoc，并且做好数据持久化。
+接下来，假设你原来安装的旧showdoc已上传到服务器的 /tmp/showdoc 目录，那么
+```
+//转移旧数据库
+\cp -r -f /tmp/showdoc/Sqlite/showdoc.db.php /showdoc_data/html/Sqlite/showdoc.db.php
+
+//转移旧附件数据
+\cp -r -f /tmp/showdoc/Public/Uploads /showdoc_data/html/Public/Uploads
+
+// 执行数据库升级，看到OK字样便证明成功
+curl http://localhost:4999?s=/home/update/db
+```
+
+### 数据备份
+备份/showdoc_data/html 目录即可。比如执行下面命令压缩存放
+```
+zip -r /showdoc_data/showdoc_bak.zip  /showdoc_data/html 
+//其中showdoc_bak.zip可以用日期后缀命名，以便多个备份。你也可以用定时任务来实现定时备份。
+```
+### 其他参考命令
+```
+ docker stop showdoc //停止容器
+ docker restart showdoc //重启showdoc容器
+ docker rm showdoc //删除showdoc容器
+ docker rmi star7th/showdoc //删除showdoc镜像
+ docker stop $(docker ps -a -q) ;docker rm $(docker ps -a -q) ;//停止并删除所有容器。危险命令，不懂勿用。
+```

documentation/en/Development&Contribution.md

@@ -0,0 +1,44 @@
+#### 技术栈说明
+
+前端：Vue + ElementUI
+后端：为了兼容低版本的php运行环境（兼容至5.3），使用的是保守的ThinkPHP3.2.3框架
+数据库：showdoc自带文件型数据库（/Sqlite/showdoc.db.php)，不需要用户手动安装数据库
+
+#### 开发前准备
+
+开发机器需要先安装好PHP环境和NodeJS环境
+下载代码并放置到PHP环境下的www目录
+先在浏览器通过地址访问，以便完成showdoc的初始化安装（如已安装过则忽略）
+在命令行里进入showdoc的web_src目录，执行npm install 以安装依赖。（若无npm，你则先要安装NodeJS环境）
+
+
+#### 前端开发
+
+执行npm run dev 以启用调式模式，通过访问 localhost:8080 便可以实时看到改动的效果。请使用代理以便请求后端API的时候代理到PHP服务端。
+需要执行npm run build 才会最终打包生效。打包后的静态文件会在/web目录下
+
+主要涉及到的目录和文件：
+```
+web_src/src/components   //页面组件基本都放在这里
+web_src/src/router       //页面路由。可以根据url定位到组件
+web_src/static           //静态资源目录
+web_src/static/lang      //前端语言包
+```
+
+#### 后端开发
+
+主要涉及到的目录和文件
+
+```
+server/Application/Api/              //应用目录，基本所有后台api都放在这里
+server/Application/Runtime/Logs      //如果有错误日志，会直接打印出浏览器或者打印到这里
+Public/Uploads                       //上传的图片放置在此处
+server/Application/Api/Lang          //后端语言包
+```
+
+
+#### 其它说明
+
+二次开发后请尊重开源协议，保留版权标识和链接
+如开发了好用的功能，不妨贡献到官方github代码仓库以分享给大家用
+showdoc往后升级可能会覆盖你原有的二次开发。如果想兼容，最好提交到官方仓库成为官方功能。