Skip to content

Docker Installation Guide

This document provides detailed steps for deploying New API using Docker.

Basic Requirements

  • Docker environment installed
  • Recommended system: Linux (Ubuntu/CentOS/Debian, etc.)
  • Port: Default is 3000

Deploy Directly Using Docker Image

docker run --name new-api -d --restart always \
  -p 3000:3000 \
  -e TZ=Asia/Shanghai \
  -v /your/data/path:/data \
  calciumion/new-api:latest

Note

Please replace /your/data/path with your desired local data storage path.

Using MySQL Database

docker run --name new-api -d --restart always \
  -p 3000:3000 \
  -e SQL_DSN="username:password@tcp(database-host:3306)/database-name" \
  -e TZ=Asia/Shanghai \
  -v /your/data/path:/data \
  calciumion/new-api:latest

Note

Please replace the database connection information in the parameters.

Accessing the System

After deployment, visit http://server-IP:3000. You will be guided to the initialization page to create the admin account and password (only required on first installation). After initialization, log in with the credentials you created.