vampirerune/nps repository overview

⁠NPS Server

NPS server image maintained at vampirerune/nps. It keeps existing NPC binaries and configuration compatible while adding independent tunnel ID pools, managed SOCKS5 tunnels, and hardened Web/API authentication.

⁠Image tags

Supported platforms: linux/amd64 and linux/arm64.

⁠Before starting

Download the public configuration template and replace the placeholder management password with a unique password of at least 12 characters:

mkdir -p ./conf
curl -fsSL \
  https://raw.githubusercontent.com/VAMPIRE0924/NPS/main/conf/nps.conf \
  -o ./conf/nps.conf
chmod 600 ./conf/nps.conf

Keep public_vkey and auth_key empty unless those features are required. Never publish real keys, passwords, certificates, or persisted JSON data.

⁠Docker Compose (Linux host network)

services:
  nps:
    image: vampirerune/nps:main
    container_name: nps
    restart: unless-stopped
    network_mode: host
    volumes:
      - ./conf:/nps/conf

docker compose up -d
docker compose logs -f nps

Host networking is recommended on Linux because NPS may listen on dynamically configured tunnel ports. With the public template, the main ports are HTTP 80, HTTPS 443, Web 8080, and NPC bridge 8024.

⁠Docker bridge network

If host networking is unavailable, publish every configured service and tunnel port explicitly:

docker run -d \
  --name nps \
  --restart unless-stopped \
  -p 80:80/tcp \
  -p 443:443/tcp \
  -p 8080:8080/tcp \
  -p 8024:8024/tcp \
  -v "$PWD/conf:/nps/conf" \
  vampirerune/nps:main

Add both TCP and UDP mappings for every port-forward rule when bridge networking is used.

⁠Upgrade

Back up conf/, then pull and recreate the container:

docker compose pull
docker compose up -d

For reproducible production deployment, pin a numbered version instead of main. NPS and its matching /nps/web assets are shipped together in the image. Existing NPC installations do not need to be replaced.

⁠Links

• Source and documentation: https://github.com/VAMPIRE0924/NPS⁠
• Releases and checksums: https://github.com/VAMPIRE0924/NPS/releases⁠
• API authentication: https://github.com/VAMPIRE0924/NPS/blob/main/API.md⁠