# macOS Deployment Guide

Deployment Instructions

This guide applies to 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.

You can click here (opens new window) to view the differences between the various FinClip editions.

Please Note

The FinClip Community Edition requires you to have experience with Docker and Linux and to complete the deployment and installation on your personal computer or server before it can be used. We recommend using the FinClip SaaS Edition (opens new window), which requires no installation or deployment and even provides a free resource package for you to use monthly.

This deployment guide describes the steps to deploy the Community Edition of FinClip on the macOS operating system. You can also click the left-hand table of contents to switch to deployment instructions for different environments.

# 1. Prerequisites

# 1.1 Deployment Configuration

We recommend deploying and installing the FinClip Community Edition on macOS version 10.12 or later.

The minimum hardware requirements for the system are shown in the table below:

Category Minimum Requirements
CPU 8 cores
Memory 8 GB (with background tasks cleared) / 12G (with active IDE in background)
Hard Disk 50 GB
OS Version macOS 10.12
Software Click to download Docker Desktop for Mac (Intel chip) (opens new window)
Click to download Docker Desktop for Mac (Apple chip) (opens new window)

If you are using macOS but are unsure how to check the relevant information, you can do the following:

Check in 'About This Mac'

image.png

Click on the " - About This Mac" in the top-left corner of the desktop. You can see the current system version, along with the corresponding CPU and memory information in the "Overview" section. Click on the "Storage" tab at the top to view the hard disk information and available space on your computer.

Alternatively, you can open the Terminal and enter the command system_profiler SPHardwareDataType to view the current system version and hardware information.

# 1.2 Install Docker

Please Note

As the Homebrew method can be slow to access from within China, it is recommended that you obtain Docker via the manual download and installation method.

Manual Download and Installation

Click here (opens new window) to download Docker Desktop for Mac. If your computer has an M1 chip (arm64 architecture), please click here (opens new window) to download.

Like other macOS software, installation is very simple. Double-click the downloaded .dmg file, then drag the Docker whale icon to the Applications folder (you will need to enter your user password during this process).

image.png

Install using Homebrew

If you already have Homebrew (opens new window) installed on your computer, you can install Docker directly via Homebrew. Please enter the following command in the terminal:

$ brew install --cask docker

# 2. Deployment and Installation

Please Note

The duration of the FinClip Community Edition deployment may vary slightly depending on your network bandwidth; the average time required is about 20 minutes.

# 2.1 Pull the Script

Open the system terminal interface and enter the following command:

bash -c "$(curl -fsSL https://static.finogeeks.club/deploy/finclip-ce/install-v1.33.0.sh)"

# 2.2 Deployment Prompts

Two prompts will appear during script execution:

# Prompt 1: Select Installation Directory

Prompt message is as follows:

FinClip installation directory (Change directory or press <Enter> for /home/ubuntu ):

At this point, confirm the installation directory for FinClip. The default is the current directory. You can enter a path to change it, for example, /opt/finclip.

# Prompt 2: Configure Access Port

Prompt message is as follows:

Press to use the default port (8000), or enter manually:

At this point, set the access port for FinClip. The default is 8000.

# 3. Getting Started

When the text "FinClip deployment completed" appears on the screen, it means the deployment process has finished. You can access and use it 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 earlier, replace "8000" with the corresponding port number. The Enterprise Console is primarily used for Mini-Program publishing/unpublishing, app association, and SDK integration.

# 3.2 Operations 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 earlier, replace "8000" with the corresponding port number. The Operations Console is primarily used for Mini-Program review and member management.

Username and Password

The default username for logging into the Enterprise Console and Operations Console is "finclip", the password is "Finclip@@2024", and the verification code is "123456".

To learn more about the practical operational guidance for the Enterprise Console and Operations Console, please click Enterprise Console Operational Guide or Operations Console Operational Guide.

# 4. Frequently Asked Questions

# Q1: When executing the deployment command docker-compose up -d, an error Cannot start service xxx... occurs. How to handle it?

The specific error content is as shown in the figure below:

image.png

Error Cause:

It is possible that Docker does not have access permissions to the address from which you downloaded the configuration file. You can modify Docker's file sharing directory as prompted, or copy the configuration file to a directory that Docker has permission to access.

# Q2: When executing the deployment command docker-compose up -d, an error ...variable is not set. Defaulting to a blank string. occurs. How to handle it?

The specific error content is as shown in the figure below:

image.png

Error Cause:

The configuration file docker-compose.yaml is being read, but it cannot read the value of a variable set in the configuration information. The variable value is in the env file. Please check if the ENV file name does not start with a ".". In this case, you need to rename the file to ".env".

# Q3: On computers with lower performance, container startup may be relatively slow.

On computers with lower performance, if the FinClip backend reports a network error, you can try restarting the gateway service using the command sudo docker restart gateway and then try again.

© FinClip with ❤ , Since 2017