Skip to main content

Nginx Proxy Manager

@jamesakeech/nginx-proxy-managerv2026.08.08.1· 14d agoMODELS
01README

Full lifecycle management of an Nginx Proxy Manager instance. sync fans out one resource per proxy host, redirection host, dead host, stream, access list and certificate, plus an instance rollup that flags expiring certificates, plain-HTTP hosts and domains claimed by more than one host. The apply* methods are idempotent — they match an existing object by its natural key (domain set, listening port, access list name) and update it in place, so re-running a workflow converges instead of accumulating duplicates. setEnabled and delete dispatch on an object kind and take a list of ids, so a batch is one fan-out call rather than a run per id. Let's Encrypt certificates can be requested over HTTP-01 or DNS-01 (wildcards included), renewed, or replaced with uploaded PEM files.

02Models1
@jamesakeech/nginx-proxy-managerv2026.08.08.1nginx_proxy_manager.ts
fn sync()
Read the whole instance and write one resource per proxy host,
fn applyProxyHost()
Create or update a proxy host. Without `id`, an existing host with
fn applyRedirectionHost()
Create or update a redirection host. Without `id`, an existing
fn applyDeadHost()
Create or update a dead (404) host. Without `id`, an existing host
fn applyStream()
Create or update a TCP/UDP stream. Without `id`, an existing
fn applyAccessList()
Create or update an access list. Without `id`, an existing list
fn requestCertificate()
Request a Let's Encrypt certificate. Reuses an existing
fn uploadCertificate()
Upload an externally issued certificate from PEM files on the
fn renewCertificate()
Renew Let's Encrypt certificates by id. Renews every id given,
fn setEnabled()
Enable or disable hosts and streams by id. Takes a list so a batch
fn delete()
Delete objects of one kind by id. Verify ids against a fresh

Resources

instance(infinite)— Instance-wide rollup: version, object counts, certificate expiry
proxyHost(infinite)— One proxy host: its domains, upstream, TLS and access-list
redirectionHost(infinite)— One redirection host: the domains redirected, where to, and with
deadHost(infinite)— One dead (404) host: domains parked so they answer without being
stream(infinite)— One TCP/UDP stream: the listening port and where it forwards to.
accessList(infinite)— One access list: its address rules and basic-auth usernames, plus
certificate(infinite)— One certificate: provider, covered domains, and days until expiry.
change(infinite)— Outcome of the most recent run of one mutating method: what was
03Stats
A
100 / 100
Downloads
1
Archive size
43.6 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
04Platforms
05Labels