简体中文 | English

Introduction

apioak-admin is the control plane backend project of apioak gateway, based on Go 1.16 and Gin 1.7.2 development, the project matches the data surface project apioak. The project aims to simplify the use of apioak, optimize the user's operation, and achieve a minimal operation to complete the launch and release of a complete service configuration.

Quick start

For the convenience of use, the front-end and back-end projects are merged and packaged as out-of-the-box executable files, which only need to be downloaded in Releases Compress the package and decompress it, then configure the config/app.yaml configuration file in the corresponding directory and execute the executable file to complete the deployment of the project. Just access the contents of the server configuration item in the config/app.yaml configuration file.

Self-compiled

go build -o apioak-admin main.go

Rely

For the system dependencies necessary to install apioak-admin on different operating systems (MySQL >= 5.7 or MariaDB >= 10.2, etc.), please refer to: Dependency Installation Documentation.

Configuration

• Import the database configuration file to MySQL or MariaDB, the data table configuration file path /{path}/config/apioak.sql.

• Create a config directory in the directory where the apioak-admin executable file generated after compiling the command is located, and copy the configuration file app_example.yaml under the apioak-admin project to this directory, and change the name to app.yaml, and then configure in that configuration file.

  • database: database connection information.
  • token: User login to issue token configuration information.
  • server: Information about accessing the service after starting the service.
  • apioak: Data plane configuration synchronization connection information.
  • logger: Record log configuration information.
  • validator: The language of parameter verification information. zh:Chinese (default) / en:English

Run

./apioak-admin