Netease Cloud Music API Enhanced Deployment

Based on NeteaseCloudMusicApiEnhanced/api-enhanced project.

Features

• Song unlocking (ungraying)
• Lossless audio (FLAC) support
• Community-maintained

Requirements

• Node.js 18+
• pnpm is recommended for dependency management

Recommended Methods

Method	Best for	Entry point
git clone	Long-running self-hosted deployment	git clone https://github.com/NeteaseCloudMusicApiEnhanced/api-enhanced.git
npx	Quick trial run	npx @neteasecloudmusicapienhanced/api@latest
bunx	One-shot startup with Bun	bunx @neteasecloudmusicapienhanced/api@latest
Docker Compose	Long-running container deployment	oven/bun:alpine + bunx @neteasecloudmusicapienhanced/api

::: note npx / bunx rely on the executable entry exported by the official npm package @neteasecloudmusicapienhanced/api. They download the package on first run, so git clone or Docker is still the better choice for persistent deployment. :::

Git Clone Deployment

1. Get the source code

git clone https://github.com/NeteaseCloudMusicApiEnhanced/api-enhanced.git
cd api-enhanced

2. Install dependencies

pnpm install

3. Run

node app.js

4. Customize port

Linux/macOS

PORT=4000 node app.js

Windows

set PORT=4000 && node app.js

NPX / Bunx Quick Start

Default port 3000

npx @neteasecloudmusicapienhanced/api@latest

bunx @neteasecloudmusicapienhanced/api@latest

Custom port

PORT=4000 npx @neteasecloudmusicapienhanced/api@latest

PORT=4000 bunx @neteasecloudmusicapienhanced/api@latest

Windows

set PORT=4000 && npx @neteasecloudmusicapienhanced/api@latest
set PORT=4000 && bunx @neteasecloudmusicapienhanced/api@latest

Environment Variables

Variable	Default	Description
CORS_ALLOW_ORIGIN	*	Allowed CORS origins. Multiple origins can be separated by commas.
ENABLE_PROXY	false	Whether to enable reverse proxy support.
PROXY_URL	https://your-proxy-url.com/?proxy=	Reverse proxy URL, only used when ENABLE_PROXY=true.
ENABLE_GENERAL_UNBLOCK	true	Enable global song unlocking
ENABLE_FLAC	true	Enable lossless audio
SELECT_MAX_BR	false	Select max bitrate when FLAC is enabled
FOLLOW_SOURCE_ORDER	true	Match tracks strictly in source order.

Docker Compose

This setup runs bunx @neteasecloudmusicapienhanced/api directly inside a Bun base image, which keeps the container definition simple and easy to update.

services:
  ncm-api-enhanced:
    image: oven/bun:alpine
    container_name: ncm-api-enhanced
    restart: always
    environment:
      - TZ=Asia/Shanghai
    ports:
      - "127.0.0.1:3003:3000"
    command: bunx @neteasecloudmusicapienhanced/api
    networks:
      - 1panel-network
    deploy:
      resources:
        limits:
          memory: 256M

networks:
  1panel-network:
    external: true

Start it with:

docker compose up -d

If you are not using 1Panel, replace 1panel-network with your own network name, or remove the networks section to let Compose create the default network.

FAQ

Login failed

If you encounter login issues, please try using email login.