# Linux Deployment Guide

Deployment Instructions

This guide applies to the local deployment of FinClip Community Edition. The 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 FinClip editions.

Please Note

The FinClip Community Edition requires you to have Docker and Linux experience and must be deployed and installed on your personal computer or server before use. We recommend using the FinClip SaaS Edition (opens new window), which requires no installation or deployment and includes a free monthly resource package for your use.

This deployment guide describes how to deploy the Community Edition of FinClip on a Linux server (applicable to both CentOS and Ubuntu) using a "one-click deployment" script. You can also click the left-hand menu to switch to deployment instructions for different environments.

# 1. Prerequisites

# 1.1 Deployment Configuration

Before deploying and installing FinClip Community Edition, please ensure your system meets the following requirements. Failure to meet these requirements may affect the deployment outcome or even cause deployment to fail.

Category Minimum Requirements
System Freshly installed Ubuntu 18.04 / CentOS 7.8
Kernel Ubuntu: 4.15 or above / CentOS: 3.10 or above
CPU 8 cores
Memory 8 GB (background tasks cleared) / 12G (active IDE running)
Hard Disk 50 GB
Device Count 1 unit

Confirm Kernel Version: Log in to the server and enter uname -a

Confirm System Version:

  • Ubuntu: Execute cat /etc/issue
  • CentOS: Execute cat /etc/redhat-release
  1. Enterprise customers should NOT install Redhat systems! Redhat is a paid commercial system. Without proper Redhat licensing, the system will lack necessary software repositories, adding numerous unnecessary deployment preparation steps.
  2. If using a system that is not freshly installed, you may encounter issues such as local port conflicts or insufficient performance.

# 2. Deployment and Installation

Please Note

  1. The deployment time for FinClip Community Edition may vary depending on network bandwidth, averaging about 20 minutes.
  2. We recommend using the "one-click deployment" method. If you require an "offline deployment" method, please refer to here.

# 2.1 Pull the Script

Access 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

During script execution, two prompts will appear:

# 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 message "FinClip deployment completed" appears on the screen, it indicates the deployment process has finished. You can access and use FinClip 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, 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, 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 operation guides for the Enterprise Console and Operations Console, please click Enterprise Console Operation Guide or Operations Console Operation Guide.

# 4. Frequently Asked Questions

# Q1: How to uninstall FinClip?

You can navigate to the FinClip directory (set during installation) and execute the following commands to stop the services:

#Stop services
sudo docker-compose stop
#Remove containers
sudo docker-compose rm -s -v
#Delete data (Please ensure you are in the FinClip installation directory to avoid accidental deletion of other data)
rm -rf data  docker-compose.yaml  init.sql  kong.yml .env

# Q2: How to obtain cloud server resources? What are the costs?

  1. If you cannot provide or do not know how to purchase a cloud server, please contact our sales or technical support. We can rent a temporary server for you from Amazon Web Services (AWS).
  2. We recommend using convenient and fast cloud servers as your first choice. You can rent a cloud server temporarily using a "Pay-As-You-Go" method. The rental cost for a cloud server meeting the above configuration requirements is less than 1 RMB per hour.
  3. If you use a cloud server, we suggest selecting "Pay by data transfer" instead of the more expensive "Pay by bandwidth". Data transfer costs are less than 1 RMB per GB, and the traffic consumption for deploying the environment is typically not more than 4GB.
© FinClip with ❤ , Since 2017