mod4ever/npm-auto-discovery repository overview

services:
  npm-auto-discovery:
    image: ghcr.io/mod4ever/npm-auto-discovery:latest
    restart: unless-stopped
    env_file: .env
    group_add:
      - "${DOCKER_GID:-996}"
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro
    networks:
      - proxy-network
    healthcheck:
      test: ["CMD-SHELL", "wget -qO- http://localhost:${HEALTH_PORT:-8080}/health || exit 1"]
      interval: 30s
      timeout: 5s
      retries: 3
      start_period: 10s

networks:
  proxy-network:
    external: true
    name: ${PROXY_NETWORK_NAME:-proxy-network}

NPM_URL=http://your-npm-host:81
[email protected]
NPM_PASSWORD=yourpassword

docker compose up -d

services:
  myapp:
    image: myapp:latest
    environment:
      VIRTUAL_HOST: "myapp.example.com"     # Required — triggers proxy host creation
      VIRTUAL_PORT: "8080"                   # Optional — default: 80
      VIRTUAL_SSL_CERT_ID: "42"              # Optional — use existing NPM cert by ID
    networks:
      - proxy-network  # Must be on the same network as npm-auto-discovery

./npm-auto-discovery --version   # e.g. 1.0.0
./npm-auto-discovery --help

networks:
  proxy-network:
    external: true
    name: proxy-network

# Docker
docker logs npm-auto-discovery | grep error_code

# PM2
npm run pm2:logs -- --lines 500 | grep error_code
# or search the raw log file
grep error_code /root/.pm2/logs/npm-auto-discovery-out-0.log

# Install PM2 globally
npm install -g pm2

# Install dependencies, then build the self-contained binary
npm install
npm run build:sea

# Configure credentials in .env (copy from template)
cp .env.example .env
# Edit .env: set NPM_URL, NPM_EMAIL, NPM_PASSWORD

# Start with PM2 (uses pm2.sea.config.cjs)
npm run pm2:start

# Save process list for auto-restart on reboot
npm run pm2:save
pm2 startup   # generates the system startup command — run the printed command as root

npm run build:sea && npm run pm2:restart

npm install
npm run build
npm run pm2:start:node

npm run build && npm run pm2:restart

# Step 1: Build CJS bundle
npm run build

# Step 2: Generate SEA preparation blob
# Requires dist/main.cjs from Step 1 — run npm run build first if skipping Step 1
node --experimental-sea-config sea-config.json

# Step 3: Copy the node binary
cp $(which node) npm-auto-discovery

# Step 4: Inject the blob into the binary
npx postject npm-auto-discovery NODE_SEA_BLOB sea-prep.blob \
  --sentinel-fuse NODE_SEA_FUSE_fce680ab2cc467b6e072b8b5df1996b2

# Step 5: Run the binary
NPM_URL=http://npm:81 [email protected] NPM_PASSWORD=pass \
  ./npm-auto-discovery

npm run build:sea

# Install dependencies
npm install

# Run in development mode (hot-reload via tsx)
npm run dev

# Run tests with coverage
npm test

# Build production bundle
npm run build

# Type-check + lint
npm run check