为知笔记服务端docker镜像使用说明
2019/9/17
为知笔记服务端提供了docker镜像,您只需要简单几步,就可以将为知笔记服务端部署在自己的服务器甚至自己的电脑上面(windows/linux/mac)。
系统需求
- 操作系统:Windows / macOS / Linux
- CPU: Intel / AMD x64
- 内存:至少4G,推荐8G或者更多
安装docker
如果您已经安装了docker,则可以跳过该步骤。
请到docker官网,下载相应的docker应用。
windows或者mac环境,请到这里下载: https://www.docker.com/products/docker-desktop。注意:你可能需要注册一个docker账号才可以下载docker 桌面客户端。
如果是linux,请自行搜索docker安装方法。
安装完成后,请运行docker客户端。
注意,要启动为知笔记服务端所有功能,需要将docker引擎的内存设置为至少4G(默认为2G)。请在docker里面进行设置。如果您的系统内存不够,可以通过禁止为知笔记搜索服务,来降低内存占用(使用默认的2G内存)。
请在docker客户端里面,找到选项(Preferences),然后调整docker引擎内存占用,将内存调整到4G。
如果您的电脑内存紧张,也可以调整下面的为知笔记服务启动参数,将里面的SEARCH=true去掉,就可以继续使用2G内存来运行为知笔记服务了。通过这种方式,您将无法使用全文检索功能。
下载并启动为知笔记服务端docker镜像
windows系统:
请按下键盘上面的Win+R,或者点击开始菜单,选择运行,然后在对话框里面输入:
powershell
将会打开命令行窗口。
然后在命令行窗口里面输入:
D:\
cd \
md wizdata
将会在D盘根目录下面建立一个wizdata文件夹,所有为知笔记服务端的数据,都将会保存在这个目录里面。您也可以自己修改这个目录。
注意:在windows上面启动docker镜像之后,还需要进行时区设置。请参考后面的常见问题部分。
然后在命令行里面继续输入:
docker run --name wiz -it -d -v D:\wizdata:/wiz/storage -p 80:80 -e SEARCH=true wiznote/wizserver
第一次运行镜像,因为需要下载docker镜像,并且初始化数据,速度要慢一些。请耐心等待。(根据网络状况,可能需要10分钟或者更长时间。)在下载完成后,第一次启动镜像大概需要2-3分钟时间。
然后打开浏览器,在地址栏里面输入:http://localhost,如果服务正常,则会出现下面的界面
如果遇到下面的界面:
通常表示为知笔记服务还没有启动起来,请继续等待并刷新浏览器。
注意:启动后请参考常见问题进行时区的设置
如果您当前服务器/电脑的80端口已经被占用,则可以使用其他的端口,例如使用8080端口 mac/linux:
docker run --name wiz -it -d -v ~/wizdata:/wiz/storage -p 8080:80 -e SEARCH=true wiznote/wizserver
windows:
docker run --name wiz -it -d -v D:\wizdata:/wiz/storage -p 8080:80 -e SEARCH=true wiznote/wizserver
您也可以自行修改端口。注意,修改端口后,在浏览器里面,则需要输入相应的端口号,例如:
http://localhost:8080
如果您需要为局域网内其他用户提供服务,则需要获取自己电脑的ip地址(局域网ip,具体方法,请自行搜索),然后在浏览器地址栏里面输入类似下面的地址即可:
http://192.168.1.186
如果不是80端口,则需要包含端口号,例如:
http://192.168.1.186:8080
如果是Windows系统,通常情况下,您需要在Windows防火墙中开放相应的端口。
常用命令
修改启动参数,并重新启动服务,例如修改映射端口,或者设置是否启动搜索服务:
docker stop wiz
docker rm wiz
docker run --name wiz -it -d -v ~/wizdata:/wiz/storage -p 80:80 -e SEARCH=true wiznote/wizserver
其中第三行,请自行修改为自己需要的命令行。
系统重新启动后,重新启动服务:
docker start wiz
更新服务命令行:
docker stop wiz
docker rm wiz
docker pull wiznote/wizserver:latest
docker run --name wiz -it -d -v ~/wizdata:/wiz/storage -p 80:80 -e SEARCH=true wiznote/wizserver
其中最后一行,请自行修改为自己需要的命令行