# Windows Deployment Guide
Deployment Instructions
This guide applies to the local deployment of FinClip Community Edition. FinClip Community Edition can be used to experience all features of the Mini-Program ecosystem and is updated approximately quarterly. The Community Edition is completely free to use.
You can click here (opens new window) to view the differences between various FinClip editions.
Please Note
FinClip Community Edition requires you to have Docker Linux experience and complete deployment and installation on your personal computer or server before use. We recommend using FinClip SaaS Edition (opens new window), which requires no installation or deployment and provides a free resource package for you to use monthly.
This deployment guide covers completing the deployment operations for FinClip Community Edition in the Windows operating system. You can also click the left-side directory to switch to deployment instructions for different environments.
# 1. Prerequisites
# 1.1 Deployment Configuration
We recommend deploying and installing FinClip Community Edition on Windows 10 (64-bit) or later system versions.
The minimum hardware requirements for the system are shown in the table below:
| Category | Minimum Requirements |
|---|---|
| CPU | 4 cores |
| Memory | 8 GB (background tasks cleared) / 12G (with active IDE running in background) |
| Hard Disk | 50 GB |
| Device Count | 1 unit |
| System | Windows 10 (x64) |
| Software | Click to Download Docker Desktop for Windows (opens new window) |
# 1.2 Service Preparation
FinClip Community Edition needs to be deployed on the local operating system via Docker. Docker operation relies on the system having an environment with a Linux operating kernel. Therefore, it is necessary to enable Linux virtualization in Windows so that the operating system has the environment required to run Docker. If you are unsure whether your computer has enabled this feature, please follow the steps below to check.
Check if Hardware Virtualization is Enabled
Open Task Manager (shortcut: Ctrl + Shift + Esc), select "Performance - CPU", and confirm that virtualization is enabled.
If it is not enabled, enter the system BIOS settings interface and turn on the virtualization switch in Intel Virtualization Technology (you can refer to here (opens new window)).

Check if Hyper-V is Enabled in the System
When you have confirmed that the virtualization-related switches in the BIOS are enabled, but virtualization still does not show as "Enabled" in Task Manager, you need to open Control Panel to check if the related services are enabled. The following is the corresponding enabling method.
Step 1: Open "Control Panel", click on "Programs"

Step 2: Click on "Turn Windows features on or off" under "Programs and Features"

Step 3: In the "Turn Windows features on or off" window, locate and check the Hyper-V related directories

Please Note
Please note that for users who have installed the Windows 10 Home Chinese Edition operating system, the Hyper-V related directories may not be found in the "Windows Features" pop-up window. Please refer to "Frequently Asked Questions Q6" for corresponding operations.
# 1.3 Install Docker
Click here (opens new window) to download Docker Desktop for Windows. After downloading, double-click Docker Desktop Installer.exe to complete the installation.
Please note that you need to restart your computer after installation is complete.
# 2. Deployment and Installation
You need to download the following files first. After downloading the image files, please extract them:
- compose 配置: https://static.finogeeks.club/deploy/finclip-ce/finclip-community-v1.33.0.tar.gz (opens new window)
镜像文件: https://static.finogeeks.club/deploy/finclip-ce/images-v1.33.0.tgz (opens new window)
# 2.1 Video Tutorial
# 3. Getting Started
After the deployment process is complete, you can access and use the services via the following addresses:
# 3.1 Enterprise Console Usage Guide
Please enter "http://127.0.0.1:8000/login?app_type=dev (opens new window)" in your browser's address bar. If you deployed on a remote server, you need to replace "127.0.0.1" with the corresponding IP address. If you modified the port number earlier, you need to replace "8000" with the corresponding port number. The Enterprise Console is mainly used for Mini-Program publishing/unpublishing, application association, and SDK integration.
# 3.2 Operation Console Usage Guide
Please enter "http://127.0.0.1:8000/login?app_type=ops (opens new window)" in your browser's address bar. If you deployed on a remote server, you need to replace "127.0.0.1" with the corresponding IP address. If you modified the port number earlier, you need to replace "8000" with the corresponding port number. The Operation Console is mainly used for Mini-Program review and member management.
Username and Password
The default username for logging into the Enterprise Console and Operation Console is "finclip", the password is "Finclip@@2024", and the verification code is "123456".
To learn more about the practical operation guides for the Enterprise Console and Operation Console, please click Enterprise Console Operation Guide or Operation Console Operation Guide.
# 4. Frequently Asked Questions
# Q1: How to handle errors when executing the command docker-compose up?
Common causes are "File directory does not exist" or "Insufficient memory causing errors". The solutions are as follows:
(1) File directory does not exist
Due to the file directory not existing, the following error occurs when executing the command 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
Or an error similar to the figure below:

Solution:
Step 1: Manually create the required folders
From the error code, "E:\code\finclip\data\mongo\db" is identified, so this folder needs to be created. The figure also indicates missing corresponding directories, so those folders also need to be created.


Step 2: Redeploy the containers
Enter the following commands sequentially in the command line to redeploy the containers:
docker stop $(docker ps -q) //Stop all containers
docker rm $(docker ps -aq) //Delete all containers
docker-compose up -d //Redeploy
(2) Insufficient memory causing error
Due to insufficient available system memory and buffer space (less than 2 GB), the required services and containers cannot be created. An error message The paging file is too small for this operation to complete appears when executing the command.


Solution:
Step 1: Modify the computer's virtual memory settings again; the minimum should not be less than 2 GB.

After completing the settings, please restart your computer.
Step 2: Execute the following code in the command line to redeploy the services
docker stop $(docker ps -q) //Stop all containers
docker rm $(docker ps -aq) //Delete all containers
docker-compose up -d //Redeploy
# Q2: After starting the services, unable to log in. What should I do?
If you are unable to log in to the Enterprise Console or Operation Console after deployment is complete, please follow the troubleshooting steps below.
You can right-click on a blank area of the login page, click "Inspect Element", then click on the "Network" tab and select "login". An error similar to the following will appear:
{ "message": "no Route matched with those values" }

Cause of the Problem:
Check the log information in the Kafka service and find the error message: out of memory. This indicates that the problem is still due to insufficient memory.

Solution:
In the environment variables section of the docker-compose.yaml file, add information about the allocatable memory:
KAFKA_HEAP_OPTS: "-Xmx1G -Xms1G" // Adjust based on computer configuration

After modification, please redeploy the services.
If you still encounter the out of memory error, it indicates that the server memory is small and the startup memory configuration needs to be adjusted.
Solution:
Step 1: Modify the environment variable configuration information in the docker-compose.yaml file
KAFKA_HEAP_OPTS: " -Xmx512M -Xms512M" // Adjust based on computer configuration
Step 2: Execute the following code in the command line to redeploy the services
docker stop $(docker ps -q) //Stop all containers
docker rm $(docker ps -aq) //Delete all containers
docker-compose up -d //Redeploy
# Q3: How to handle Kafka errors?
ERROR ERRor while deleting the clean shutdown file in dir /kafka/kafka-logs-70fcf2ad734f (kafka.server.LogDirFailureChannel)

Cause of the Problem:
A bug with Kafka on the Windows platform.
Solution:
Delete the log files in the Kafka directory and restart the Kafka service.
