# Personal Computer Deployment GuideDocument Deprecated Default Theme

Deployment Instructions

This guide is suitable for the local deployment of the FinClip Community Edition. The FinClip Community Edition can be used to experience the full functionality of the Mini-Program ecosystem. It is updated approximately quarterly, and the Community Edition is completely free to use.

# 1. Deployment Guide

If you need to deploy the FinClip Community Edition on a Windows or macOS computer, please click the links below:

You can also try one-click deployment via the command line:

# 2. Common Issues in Windows Deployment

Issues may arise during the Windows deployment process. Please refer to the following content.

# Q1: Directory Does Not Exist

Problem Symptom

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


Root Cause
The folder does not exist.

Solution

  1. Manually create the required folders, as shown in the figures:



  2. Execute the redeployment commands:

docker stop $(docker ps -q)      // Stop all containers
docker rm $(docker ps -aq)       // Delete all containers
docker-compose up -d             // Redeploy

# Q2: Insufficient Memory

Problem Symptom

Root Cause
The paging file is too small for this operation to complete. Insufficient memory, as Docker requires more than 2GB of memory to start.

Solution
Configure the computer's virtual memory. Set this according to your computer's configuration.

  1. Access Advanced System Settings

  2. Enter the Performance Settings page
  3. Enter the Virtual Memory change page
  4. Modify the system virtual memory
  5. After modification, restart the computer and redeploy the service.
docker stop $(docker ps -q)      // Stop all containers
docker rm $(docker ps -aq)       // Delete all containers
docker-compose up -d             // Redeploy

# Q3: Unable to Log In

Problem Symptom

Problem Diagnosis
Check the log information in the Kafka service and find the error message: out of memory. The main reason is insufficient memory.

Solution
Add the following to the docker-compose.yaml file: KAFKA_HEAP_OPTS: "-Xmx1G -Xms1G"

After modification, redeploy the service. If the out of memory error persists, the root cause can be identified as the server has limited memory, requiring adjustment of the startup configuration to reduce the startup memory size.

Solution:
Modify the Kafka memory setting according to the server configuration: KAFKA_HEAP_OPTS: " -Xmx512M -Xms512M", then redeploy the service.

docker stop $(docker ps -q) // Stop all containers
docker rm $(docker ps -aq) // Delete all containers
docker-compose up -d // Redeploy

# Q4: Kafka Error

Problem Symptom

Root Cause
A bug in Kafka on the Windows platform.

Solution:
Delete the log files in the Kafka directory and restart the Kafka service.

# 4. Login and Usage

# 4.1 Accessing the Management Console

Please open your browser and enter the following address to access the Management Console.

【Enterprise Side (for Mini-Program management, SDK integration)】
Address: http:// : /mop/mechanism/#/login

e.g., http://127.0.0.1:8000/mop/mechanism/#/login

【Operations Side (for Mini-Program review, member management)】
Address: http:// : /mop/operate/#/login

e.g., http://127.0.0.1:8000/mop/operate/#/login

Reminder

  • The IP Address here refers to the IP address of the server where the FinClip server is deployed;
  • The Port is the port indicated during the installation script (separate the IP and Port with an English colon "😊;
  • The default login account for both the Enterprise Side and the Operations Side is finclip@finogeeks.com, and the password is 123Abc.

# 4.2 Operation Guide

© FinClip with ❤ , Since 2017