⚙️ Deployment

tip

Minimum Hardware Requirements

• CPU: 2 cores
• Memory: 4G
• Disk Storage: 200G
• Operating System: Linux/Mac
• System Architecture: amd64/arm64

Program Dependencies

APIPark depends on MYSQL, Redis, InfluxDB databases. Below are the required versions for these databases:

Name	Version Requirement
MYSQL	>=5.7.x
Redis	>=6.2.x
InfluxDB	>=2.6

Deploy APIPark

You can choose any of the following methods to deploy APIPark with one click (applicable to both amd64/arm64 architectures):

One-click Deployment Script

note

Supported systems:

• CentOS 7.9 (representative for 7.x)
• CentOS 8.5 (representative for 8.x)
• Ubuntu 20.04
• Ubuntu 22.04
• Debian 12.4
• Alibaba Cloud Linux 3.2104
• Alibaba Cloud Linux 2.1903

Currently, only the above systems have been tested for installation. If you need one-click deployment for other systems, please submit an Issue.

Enter the one-click deployment command:

curl -sSO https://download.apipark.com/install/quick-start.sh; bash quick-start.sh

Follow the prompts to deploy. Once deployment is complete, the deployment information will be displayed as follows:

Configure InfluxDB

Initialize InfluxDB

tip

The one-click deployment script installs the InfluxDB database by default. Upon completion, it will display the access address for InfluxDB as shown below:

1. Open the InfluxDB address in a browser.

2. Fill in the initialization information, including username, password, organization name, and bucket name.

warning

Here, the Organization Name should be apipark, and the Bucket Name should be apinto.

Create API Tokens

tip

InfluxDB API Tokens are tokens used for authentication and authorization, allowing users and applications to securely access InfluxDB data and functions. Their main purposes are as follows:

1. Access Control: API Tokens can be used to control who can access data in the InfluxDB database. Each token can be associated with different permission levels, restricting access to specific databases, organizations, or resources.
2. Read/Write Permissions: API Tokens can distinguish between read and write permissions. You can create read-only tokens, write-only tokens, or tokens with both read and write permissions, thereby controlling the operational capabilities of different users or applications.
3. Secure Communication: API Tokens can work with HTTPS to ensure communication with InfluxDB is encrypted and secure, preventing unauthorized access and data breaches.
4. Multi-user Management: In multi-user or multi-tenant environments, API Tokens allow for the generation of different tokens for each user or application, with permissions assigned as needed.
5. Audit and Tracking: Through API Tokens, you can track which users or applications access what data at what time, facilitating logging and security audits.

1. After accessing the InfluxDB browser page, select API Tokens.

2. Generate an All Access API Token.

3. Enter description information and click SAVE.

4. Copy the generated API Token as it will be needed later for monitoring in Configure APIPark.