# Windows 部署指南

如果您的电脑为 Windows 操作系统,可以按照以下说明本地部署体验 Finclip 社区版。

# 1. 部署配置

我们建议您在 Windows 10(64 位) 及以上系统版本中部署安装 FinClip 社区版。​

此外,系统的最低硬件要求如下表所示:

类目 最低要求
CPU 8 核
内存 8 GB(后台任务被清空) / 12G(后台有活动 IDE)
硬盘 50 GB
设备数量 1 台
系统 Windows 10 (x64)
软件 点击下载 Docker Desktop for Windows (opens new window)

# 2. 安装前准备

# 2.1 准备虚拟化环境

FinClip 社区版需要通过 Docker 部署在本地操作系统上,而 Docker 的运行依赖系统中具有 Linux 操作内核的环境,因此需要通过在 Windows 中开启 Linux 虚拟化的形式,使操作系统具备运行 Docker 的环境。如果您不清楚自己的电脑是否已开启对应功能,请按照下列步骤检查。​

检查硬件是否开启虚拟化

打开任务管理器(快捷方式:Ctrl + Shift + Esc ),选择「性能 - CPU」,确认已开启了虚拟化。

如果没有开启,可进入系统 BIOS 设置界面,并在 Intel Virtualization Technology 中打开虚拟化开关(可参考 这里 (opens new window))。

image.png

检查系统是否已开启 Hyper-V

当确保 BIOS 中虚拟化相关开关已开启,但任务管理器中的虚拟化依然未显示“已启用”时,则需要打开控制面板查看相关服务是否已经开启,以下是对应的开启方法。​

第一步:打开「控制面板」,点击「程序 」

image.png

第二步:点击「程序和功能」下的「启用或关闭 Window 功能」

image.png

第三步:在 「启用或关闭 Window 功能」 中查看并勾选 Hyper-v 相关目录

image.png

请注意

请注意,对于安装了 Windows 10 家庭中文版操作系统系统的用户,可能在 「 Windows 功能」弹窗中无法找到 Hyper-V 相关目录,请参考 「常见问题 Q6」进行对应操作。

# 2.2 安装 Docker

我们提供手动安装或使用 winget 两种 Docker 的安装方式供您选择。​

手动下载安装

点击 这里 (opens new window) 下载 Docker Desktop for Windows,并在下载完成后双击 Docker Desktop Installer.exe 完成安装;​

使用 winget 安装

如果您的操作系统是最新版本的 Windows 10 及以上版本,您的系统中应该已经集成了微软官方的程序包管理器 (opens new window),您可以直接打开命令行输入以下命令:

$ winget install Docker.DockerDesktop

​ 请注意,安装完毕后需要重启电脑。

# 2.3 下载部署文件

请分别下载以下三个文件,并将下载的文件,放在同一文件夹下,文件夹需要以“英文字符”命名:

请注意

配置文件下载后,ENV文件需要重命名为 “.env”,请注意 “e” 前面有个英文句号 “.”,如下图所示。
image.png

# 3. 进行部署

# 3.1 Docker 启动配置

打开您在 2.2 中已经安装的 Docker Desktop, 在「Settings-Docker Engine」中填入以下配置:

{
 "registry-mirrors": [
   "https://registry.docker-cn.com"
  ],
 "insecure-registries": [],
 "debug": false,
 "experimental": true
}

如下图所示:

image.png

# 3.2 执行部署命令

在 2.3 中下载部署文件的目录下,打开 PowerShell( shift + 右键空白区域,选择 PowerShell),如图:

如果您本地安装了 git,也可以点击「Git Bash Here」打开 git 命令行进行操作

image.png

加载镜像包

在命令行中输入以下命令,加载镜像包:

docker load -i mop-20211122.gz

成功后看到如下图所示,即代表镜像包被成功加载

image.png

创建 Docker 容器

在命令行中输入一下命令,创建相关服务与容器

docker-compose up -d

成功后看到如下图所示,即代表所有服务都创建成功

image.png

# 4. 登录使用

当部署完成后,请打开浏览器,并在地址栏中输入对应的地址。​

【企业端】请在浏览器地址栏中输入“http://127.0.0.1:8000/mop/mechanism/#/login (opens new window)”,如您是在部署远程服务器,则需要将“127.0.0.1”替换为对应的 IP 地址,如您在上文修改了端口,则需要将“8000”替换为对应的端口号码。企业端主要用于小程序上下架,应用关联,SDK 集成。​

【运营端】请在浏览器地址栏中输入“http://127.0.0.1:8000/mop/operate/#/login (opens new window)”,如您是在部署远程服务器,则需要将“127.0.0.1”替换为对应的 IP 地址,如您在上文修改了端口,则需要将“8000”替换为对应的端口号码。运营端主要用于小程序审核,成员管理。​

登录企业端与运营端的默认用户名为“finclip@finogeeks.com”,密码为“123Abc”​

想了解企业端与运营端更多的实际操作指引,请点击企业端操作指引 (opens new window),或运营端操作指引 (opens new window)

# 5. 常见问题

Q1:执行命令docker-compose up报错

常见问题原因分为“文件目录不存在”或“内存不足导致报错”,以下为解决方法:​

(1)文件目录不存在

由于文件目录不存在,导致执行命令 docker-compose up 时出现下列错误:

ERROR: for finclip_mongo_1  Cannot create container for service mongo: invalid volume specification: 'E:\code\finclip\data\mongo\db:/data/db:rw': invalid mount config for type "bind": bind source path does not exist: e:\code\finclip\data\mongo\db 

或与下图相类似错误

image.png

解决办法:

第一步,手动创建所需的文件夹

在报错代码中发现“E:\code\finclip\data\mongo\db”,因此需要新建此文件夹;在图中发现有提示缺失对应目录,因此也需要新建对应的文件夹。

image.png

image.png

第二步,重新部署容器

在命令行中依次输入以下命令,重新部署容器:

docker stop $(docker ps -q)      //停止所有容器 
docker rm $(docker ps -aq)       //删除所有容器 
docker-compose up -d             //重新部署     

​ (2)内存不足导致报错

由于当前系统可用内存与缓存区空间不足(少于 2 GB),无法创建所需要的服务与容器,执行命令时出现错误提示 The paging file is too small for this operation to complete

image.png

image.png

解决办法:

第一步,重新修改电脑的虚拟内存,最少不得小于 2 GB

image.png

设置完成后请重启电脑。​

第二步,在命令行执行如下代码,重新部署服务

docker stop $(docker ps -q)      //停止所有容器
docker rm $(docker ps -aq)       //删除所有容器
docker-compose up -d             //重新部署   

​ Q2:启动服务后,无法无法登录

当您在部署完成后,登录企业端或运营端时无法登录,请按照以下解决思路

您可以在登录页空白处右键,点击查看元素,并点击“Network”选中“login”,会出现如下图所示报错:

{"message":"no Route matched with those values"}

image.png

问题原因:

查看 kafka 服务中的日志信息,发现报错信息: out of memory。可知该问题原因依然为内存不足。

image.png

解决方法:

在 docker-compose.yaml 文件中环境变量部分,增加可调用的内存信息:

KAFKA_HEAP_OPTS: "-Xmx1G -Xms1G" // 该情况视电脑配置而定 

image.png

修改之后,请重新部署服务。​

如果发现还是报out of memory的错误,则代表服务器内存较小,需要调整启动内存配置。​

解决办法:

第一步,修改 docker-compose.yaml 文件中,环境变量配置信息

KAFKA_HEAP_OPTS: " -Xmx512M -Xms512M" // 该情况视电脑配置而定 

第二步,在命令行执行如下代码,重新部署服务

docker stop $(docker ps -q)      //停止所有容器 
docker rm $(docker ps -aq)       //删除所有容器 
docker-compose up -d             //重新部署     

​ Q3:kafka 报错,查看日志会出现如下错误,即

ERROR ERRor while deleting the clean shutdown file in dir /kafka/kafka-logs-70fcf2ad734f (kafka.server.LogDirFailureChannel)

image.png

问题原因:

kafka 在 windows 平台里的 BUG

解决办法:

删除 kafka 目录中的日志文件,重启 kafka 服务

image.png

© 2021 凡泰极客
  • 免费试用
  • 编组
  • 编组 2