Skip to content

InTheDaylight14/nginx-proxy-manager-switches

Repository files navigation

NPM Switches Custom Integration

GitHub Release

GitHub Activity

License hacs Project Maintenance Community Forum

Installation

Recommended via HACs

  1. Use HACS, in HACS > Integrations > Explore & Add Repositories search for "NPM Switches".
  2. Restart Home Assistant.
  3. Add Integration or in the HA UI go to "Configuration" -> "Integrations" click "+" and search for "NPM Switches".

Manual Download

  1. Use the tool of choice to open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. Download this repository's files.
  4. Move or Copy the entire npm_switches/ directory (folder) in your HA custom_components directory (folder). End result should look like custom_components/npm_switches/.
  5. Restart Home Assistant.
  6. Add Integration or in the HA UI go to "Configuration" -> "Integrations" click "+" and search for "NPM Switches".

Usage

'NPM Switches' offers integration with a local Nginx Proxy Manager server/instance. It will login into and retrieve a token from the NPM server every 24 hours. This token is used to query the state of each proxy host every 60 seconds. It is also used to enable or disable a proxy host via local api call to the NPM server.

This integration provides the following entities:

  • Switches - One switch for every proxy host that is configured
    • Optional Switches: Redirection Hosts, Streams, 404 Hosts
  • Sensors:
    • Number of enabled and disabled proxy hosts (and, if enabled during configuration, redirection, stream, and 404 hosts)
  • Buttons:
    • Renew certificate buttons

Features to be developed:

  • Truly unique Unique IDs
  • Reconfiguration of an entry should the NPM url or login info change
  • Better error messages on failed configuration

If you want to contribute to this please read the Contribution guidelines

Component built with integration_blueprint.


About

Home Assistant HACs repository that provides switches to enable or disable Nginx Proxy Manager proxies.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •