更新了自述文档,使之可读性更强

add-license-1
青阳龙野 2018-01-30 17:14:03 +08:00
parent 229984f058
commit aa9d678c24
1 changed files with 28 additions and 17 deletions

View File

@ -1,48 +1,59 @@
KIFT
KIFT——快捷、强大、小巧的开源网盘系统
【青阳网络文件系统自述文档】
#快速开始:
您可以阅读github上的快速开始https://github.com/KOHGYLW/kiftd.wiki.git 。
简化的安装流程为:
第一步安装java 8或以上版本。
第二步:启动服务器
######使用kift有什么优势
1使用简单。只需一个浏览器您就可以在办公室内、家中、小型局域网内共享您的任何文件甚至是让您的朋友在线播放上传的视频——而无需下载。
2功能齐全。您只想将删除文件的权利给与您信任的人您想让您的学生只能上传自己的作业而不能下载抄袭其他人的作业kitf的权限管理能力能轻松完成您的需求。
3开源免费。无需任何投入您需要做的仅仅是下载解压然后开始使用。就是这么简单。害怕它隐藏不知名的代码偷用您的资源“挖矿”现在您可以在github上随时查看和拷贝本应用的全部源代码并自己动手编译它。您还可以根据自己的喜好随意修改它无论如何一切任由您操作。
######快速开始:
您可以阅读github上的快速开始https://github.com/KOHGYLW/kiftd/wiki 。
下载源代码请前往这个地址https://github.com/KOHGYLW/KohgylwIFT 。
如果您仅仅需要马上建立一个可用的网盘,那么您只需阅读下面这些步骤。
######1分钟快速部署
第一步安装java 8或以上版本的java环境。
第二步:按照下列操作启动您的服务器:
windows:
进入bin目录运行startup.bat文件。
使用浏览器推荐使用Chrome或FireFox或其内核的浏览器访问127.0.0.1
使用浏览器推荐使用Chrome或FireFox或其内核的浏览器访问127.0.0.1。例如如果您用的是360安全浏览器那么您应该使用“极速模式”访问本应用。
Linux/Unix(含Mac OS X):
使用终端进入bin目录以Root权限运行startup.sh文件
sudo ./startup.sh
使用浏览器推荐使用Chrome或FireFox或其内核的浏览器访问127.0.0.1
使用浏览器访问127.0.0.1。可以参见windows的这一步操作完全一样
第三步:进入主页
在局域网其他主机上使用浏览器访问本机IP地址即可进入本系统
在局域网内其他主机上使用浏览器访问您本机IP地址即可进入本系统。
第四步:测试管理功能
使用内置用户(admin,000000)进行登录,并进行创建文件夹、删除文件或文件夹、上传文件操作。
#mp4与webm格式资源在线播放
######mp4与webm格式资源在线播放
上传至本系统的全部mp4资源和webm资源均可使用在线播放功能需要用户具备[下载]权限。点击文件后方操作栏中的“播放”按钮即可。点击页面右上方停止播放并返回按钮返回应用主页。
#用户授权:
######用户授权:
进入 webapps/ROOT/etc 目录使用文本编辑器打开configure.properties文件按照其中的示例和提示进行用户的添加、密码设定以及授权操作。
#修改下载缓冲区大小:
######修改下载缓冲区大小:
下载缓冲区决定了服务器使用多少内存为用户提供下载缓冲。进入 webapps/ROOT/etc 目录使用文本编辑器打开configure.properties文件更改buff.size参数。该参数不可超过2147483647且不可超过您计算机的内存大小。单位为byte单位换算1MB=1024KB=1024*1024byte
注意如果您需要更优化的性能处理高并发下载请配置bin目录下的catline.bat(windows)或catline.sh(Unix/Linux)文件修改相应的JVM参数默认内存堆大小为1GB。
#关闭服务器:
######关闭服务器:
windows:
进入bin目录运行shutdown.dat文件。
Linux/Unix(含Mac OS X):
使用终端进入bin目录运行shutdown.sh文件
./shutdown.sh
#关于服务器文件:
######关于服务器文件:
除了服务器主目录内的所有文件外本应用还会在您的用户目录下生成KohgylwIFT文件夹内部存放有运行服务器所必须的信息和日志文件。请勿在服务器运行的过程中修改或删除其内容。
#卸载:
删除服务器主目录并删除您用户目录下的KohgylwIFT文件夹即可。注意:如果您想重新安装本应用,则应该在重新安装前彻底删除旧的应用文件(即上述两项内容)。
######卸载:
删除服务器主目录并删除您用户目录下“文档”文件夹内的KohgylwIFT文件夹即可。
#查看日志信息:
######查看日志信息:
当本应用运行过程中出现问题时,系统会自动生成日志记录文件。这些文件存被放于您的用户目录下的 文档/KohgylwIFT/log 文件夹内(~/Documents/KohgylwIFT/log全部的日志文件名以“生成日期.klog”的形式构成。例如“2018_1_1.klog”。同一日内的全部日志会写入到同一个日期命名的文件内并以空行隔开。该文件以文本形式生成您可以使用任意文本编辑器打开并查看相应内容。每一个日志信息块的格式如下