# Docker Deployment GuideDocument Deprecated Default Theme

You can deploy the FinClip Community Edition using Docker. To ensure the best experience, please confirm that your hardware meets the following minimum requirements:

Category Minimum Requirement
CPU 8 cores
Memory 8 GB (background tasks cleared) / 12G (active IDE in background)
Hard Disk 50 GB
Number of Devices 1

# 1. Using on Windows

If your operating system is Windows, please refer to this process.

Please Note

Docker supports 64-bit versions of Windows 10 Pro, and Hyper-V must be enabled (not required for versions v1903 and above), or 64-bit versions of Windows 10 Home v1903 and above.

# 1.1 Install Docker

Manual Download and Installation

Click here (opens new window) to download Docker Desktop for Windows. After downloading, double-click Docker Desktop Installer.exe to complete the installation;

Install using winget

If your operating system is the latest version of Windows 10 or above, your system should already have the Microsoft Official Package Manager (opens new window) integrated. You can directly open the command line and enter the following command:

$ winget install Docker.DockerDesktop

Please note that a computer restart is required after installation.

# 1.2 Run Docker

Type Docker in the Windows search bar and click Docker Desktop to start running.

image.png

After Docker starts, a whale icon will appear in the Windows taskbar.

image.png

Wait a moment. When the whale icon becomes static, it indicates that Docker has started successfully. Afterwards, you can open PowerShell to use Docker.

# 2. Using on macOS

If your operating system is macOS, please refer to this process.

Please Note

Docker Desktop for Mac (opens new window) requires macOS Mojave 10.14 or later.

# 2.1 Install Docker

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 Homebrew (opens new window) is already installed on your computer, you can install Docker directly via Homebrew. Please enter the following command in the terminal:

$ brew install --cask docker

# 2.2 Run Docker

Find the Docker icon in Applications and click to run it.

image.png

After running, you will see an additional whale icon in the top menu bar. This icon indicates the running status of Docker.

image.png

Clicking the whale icon will pop up an operation menu.

image.png

Afterwards, you can check the installed Docker version via the command line in the terminal.

$ docker --version
Docker version 20.10.0, build 7287ab3

# 3. Using on CentOS

If your operating system is CentOS, please refer to this process.

Please Note

Docker supports 64-bit versions of CentOS 7/8, and requires a kernel version no lower than 3.10. CentOS 7 meets the minimum kernel requirement, but due to the relatively low kernel version, some features (such as the overlay2 storage driver) cannot be used, and some features may be unstable.

# 3.1 Preparation

Older versions of Docker were called docker or docker-engine. To ensure stability, first uninstall any old versions using the following command:

$ sudo yum remove docker \
                  docker-client \
                  docker-client-latest \
                  docker-common \
                  docker-latest \
                  docker-latest-logrotate \
                  docker-logrotate \
                  docker-selinux \
                  docker-engine-selinux \
                  docker-engine

# 3.2 Install using yum

Please Note

Do not use the yum command to install Docker directly without configuring the Docker YUM repository first.

Execute the following command to install dependency packages:

$ sudo yum install -y yum-utils

Due to network issues within China, it is recommended to use a domestic source. Execute the following command to add the yum software repository:

$ sudo yum-config-manager \
    --add-repo \
    https://mirrors.aliyun.com/docker-ce/linux/centos/docker-ce.repo
$ sudo sed -i 's/download.docker.com/mirrors.aliyun.com\/docker-ce/g' /etc/yum.repos.d/docker-ce.repo
# Official source
# $ sudo yum-config-manager \
#     --add-repo \
#     https://download.docker.com/linux/centos/docker-ce.repo

# 3.3 Install Docker

Update the yum software source cache and install docker-ce

$ sudo yum install docker-ce docker-ce-cli containerd.io

# 3.4 Additional Settings

Because CentOS 8's firewall uses nftables, but Docker does not yet support nftables, we can use the following settings to use iptables instead:

Change /etc/firewalld/firewalld.conf

# FirewallBackend=nftables
FirewallBackend=iptables

Or execute the following commands:

$ firewall-cmd --permanent --zone=trusted --add-interface=docker0

$ firewall-cmd --reload

# 3.5 Automated Installation using Script

For testing or development environments, Docker officially provides a convenient installation script to simplify the process. This script can be used on CentOS systems. Additionally, you can use the --mirror option to install using a domestic source:

If you want to install a test version of Docker, get the script from test.docker.com

# $ curl -fsSL test.docker.com -o get-docker.sh
$ curl -fsSL get.docker.com -o get-docker.sh
$ sudo sh get-docker.sh --mirror Aliyun
# $ sudo sh get-docker.sh --mirror AzureChinaCloud

After executing this command, the script will automatically complete all preparations and install the stable version of Docker on your system.

# 3.6 Start Docker

$ sudo systemctl enable docker
$ sudo systemctl start docker

# 4. Start Deployment

# 4.1 Download Deployment Files

Please download the following files to the same directory. After downloading, we need to enter the directory to perform the deployment and installation operations.

Please note: After downloading the image file, please extract it;

# 4.2 Build FinClip Community Edition Application

After installing and opening Docker, navigate to the directory containing the configuration files via the command line and enter the following command to complete the deployment.

(1) Load the image package file using the command

docker load -i finclip.tar

(2) Create the container

docker-compose up -d

After deployment is complete, service initialization will take a few minutes. Please wait patiently.

# 5. Start Using

After deployment is complete, please open your browser and enter the corresponding address in the address bar.

【Enterprise Console】Please enter "http://127.0.0.1:8000/mop/mechanism/#/login (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, 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.

【Operation Console】Please enter "http://127.0.0.1:8000/mop/operate/#/login (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, you need to replace "8000" with the corresponding port number. The Operation Console is mainly used for Mini-Program review and member management.

The default username for logging into the Enterprise Console and Operation Console is "finclip@finogeeks.com", and the password is "123Abc".

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.

© FinClip with ❤ , Since 2017