Sign inSign up

majorleaguedale1/step_npm_plugin

By majorleaguedale1

•Updated 8 months ago

A plugin to provide automated certificate generation from a Smallstep CA.

Image
0

2.2K

majorleaguedale1/step_npm_plugin repository overview

⁠Smallstep CA Nginx Proxy Manager Plugin

⁠Introduction

This plugin is a small automation tool that monitors Nginx Proxy Manager for additions to proxy hosts. All proxy hosts that are added without any form of SSL certificate will have a certificate generated using Smallstep's step-cli.

⁠References

GitHub⁠

⁠Setup

To run the manager, you simply need to run the container using either the CLI arguments or corresponding ENV variables.

⁠Docker Compose Example
version: '3.8'

services:
  step-npm-plugin:
    container_name: step-npm-plugin
    image: majorleaguedale/step-npm-plugin:latest
    restart: always
    environment:
      - LOG_LEVEL=INFO
      - STEP_CA_DOMAIN=ca.example.com               # Step CA Domain Name
      - STEP_CA_FINGERPRINT=cr3987adeef348c8d89a890 # Step CA Fingerprint
      - STEP_CA_PROVISIONER_PASS=<MyPassword>       # CA Provisioner password (See DOCKER_STEPCA_INIT_PASSWORD)
      - [email protected]                   # User will need to be created in NPM manually
      - NPM_PASS=<MyPassword>                       # Password for user manually created in NPM
⁠Settings & Configuration

"*" required

Env VariableCLI SwitchDescriptionValues/ExamplesDefault
LOG_LEVEL--log-levelLog level for the plugin to use.DEBUG, INFO, WARNING, ERROR, CRITICALINFO
SCHEDULE--schedulePlugin run interval. Can be specified as seconds, minutes, hours up to the maximum of 1 day.10s, 20m, 4h10s
STEP_CA_SCHEME-ssScheme used by Step CA (http/https)http or httpshttps
STEP_CA_DOMAIN*-sdDomain Name to reach step CAca.example.com-
STEP_CA_PORT-spPort number used by Step CA90009000
STEP_CA_FINGERPRINT*-sfFingerprint to identify Step CA--
STEP_CA_PROVISIONER_PASS*-spwProvisioner Password to decrypt the JWT for Step-CLI--
NPM_SCHEME-nsNginx Proxy Manager Scheme to access the management interfacehttp or httpshttp
NPM_HOST*-nhNginx Proxy Manager IP or Hostnamenpm.example.com-
NPM_PORT-npNginx Proxy Manager Port Number8181
NPM_USER*-nuNginx Proxy Manager Username[email protected]⁠-
NPM_PASS*-npwNginx Proxy Manager Password--

Tag summary

Content type

Image

Digest

sha256:77ee6d240…

Size

50.3 MB

Last updated

8 months ago

docker pull majorleaguedale1/step_npm_plugin