# Command Line One-Click Deployment Guide
Deployment Instructions
This guide is applicable for local deployment of the FinClip Community Edition. The FinClip Community Edition can be used to experience the full functionality 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 the various 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 it can be used. 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 in a command-line environment using a "one-click deployment" script. You can also click on the left-hand table of contents to switch to deployment instructions for different environments.
# 1. Prerequisites
# 1.1 Deployment Configuration
Before deploying and installing the FinClip Community Edition, please ensure your system meets the following requirements. Failure to meet these requirements may affect the deployment outcome or even cause the deployment to fail.
| Category | Minimum Requirement |
|---|---|
| CPU | 4 cores |
| Memory | 8 GB |
| Hard Disk | 50 GB |
| Device Count | 1 unit |
| Bandwidth | Recommended ≥ 10Mbps |
# 1.2 Service Preparation
Before starting the installation, please ensure that Docker is available in the current environment and that the wget and curl tools are installed:
- wget is a tool for downloading files in Linux. wget is open-source software developed for Linux.
- curl is a file transfer tool in Linux that works on the command line using URL rules.
# 2. Deployment and Installation
Please Note
The deployment time for the FinClip Community Edition may vary depending on your network bandwidth. The average time required is approximately 20 minutes.
# 2.1 Obtain Community Edition Deployment Resources
Pull the script: Enter the system terminal interface and input 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
The prompt message is as follows:
FinClip installation directory (Change directory or press <Enter> for /home/ubuntu ):
At this point, please 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
The prompt message is as follows:
Press
At this point, please 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 then 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, 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, 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 earlier, replace "8000" with the corresponding port number. The Operation Console is primarily 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: What should I do if FinClip prompts a network error?
On computers with lower performance, if the FinClip backend prompts a network error, you can try restarting the gateway service using the sudo docker restart gateway command and then try again.