Self-host New API with Levelrail

An LLM gateway and AI asset management system that unifies many model providers.

  • AuthorQuantumNous
  • LicenceAGPL-3.0
  • Memory512 MiB
  • Archarm64
  • Services3

How to self-host New API

  1. Pull the images

    3 images are pulled on your server.

    Show images
    • calciumion/new-api:v0.9.2.0
    • postgres:16-alpine
    • redis:7-alpine
  2. Create the app

    3 services start in a single Compose app, with 2 named volume mounts for your data, on port 3000.

  3. Fill in the secrets

    3 secrets are generated and stored encrypted, 5 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

New API requirements

Memory
About 512 MiB
Architectures
amd64 image published, arm64 image published
Ports
3000
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
AGPL-3.0, network copyleft (agpl) license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 3000 on the host, so open them in the VPS firewall only if you want that.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then New API. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the New API docs page.

Deploy New API your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy New API from the CLI

levelrail-cli templates deploy new-api --name my-new-api

Deploy New API with the API

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/new-api/deploy

New API configuration

New API services

ServiceImagePortsVolumes
new-api calciumion/new-api:v0.9.2.0 3000 none
postgres postgres:16-alpine none postgres_data -> /var/lib/postgresql/data
redis redis:7-alpine none redis_data -> /data

New API environment variables

VariableServiceValue
ERROR_LOG_ENABLED new-api Preset by the template
REDIS_CONN_STRING new-api Preset by the template
SESSION_SECRET new-api Generated at deploy
SQL_DSN new-api Generated at deploy
TZ new-api Preset by the template
POSTGRES_DB postgres Preset by the template
POSTGRES_PASSWORD postgres Generated at deploy
POSTGRES_USER postgres Preset by the template

Ports and volumes

Ports
3000
Volumes
2 named mounts: postgres_data -> /var/lib/postgresql/data, redis_data -> /data

New API FAQ

How much memory does New API need?

The catalog lists about 512 MiB of memory for New API across its 3 services.

Does New API run on arm64?

For New API, an arm64 image is published; amd64 is image published.

What licence is New API under?

New API is licensed under AGPL-3.0, which is network copyleft, so source sharing also applies when it is offered as a hosted service.

Does New API need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which database does New API bundle?

The template includes Postgres and Redis, running as its own service.

Which ports does New API use?

New API listens on port 3000 inside the stack.

Where does New API keep its data?

In named volumes: postgres_data mounted at /var/lib/postgresql/data and redis_data mounted at /data.

Can I deploy New API on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for New API, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image calciumion/new-api:v0.9.2.0, postgres:16-alpine, redis:7-alpine is what you deploy there.

levelrail-cli templates deploy new-api --name my-new-api