Skip to content

Repository files navigation

ShieldPM

CI Status Version License

A modern, security-focused reverse proxy manager built on top of Nginx — with a clean web UI, advanced TLS management, and built-in protection features.


Caution

Migration from NPMplus required.

  • Update your compose.yaml to use ghcr.io/shedowe19/shieldpm:latest
  • Data now lives at /data/shieldpm (auto-migrated from /data/npmplus on first start)
  • Switched from Alpine to Debian Trixie — use Debian package names (e.g. php8.2-curl instead of php82-curl)
  • Downgrading is not possible — back up your data before upgrading

🚀 Quick Start

# 1. Download config
curl -o compose.yaml https://raw.githubusercontent.com/shedowe19/ShieldPM/refs/heads/develop/compose.yaml

# 2. Set your timezone and ACME email in compose.yaml, then start
docker compose up -d

Open the admin UI at https://<your-ip>:81

Default credentials:

  • Email: admin@example.org
  • Password: Check the container logs → docker logs shieldpm

🛠️ Tech Stack

Docker Nginx Node.js Express React TypeScript Vite Vitest SQLite MySQL MariaDB PostgreSQL Tailwind CSS Radix UI TanStack Query Framer Motion Lucide Knex.js Objection.js Caddy PHP GoAccess ModSecurity OpenAppSec CrowdSec MaxMind Cloudflare


✨ Features

  • Reverse Proxy — Manage Nginx hosts, redirects, and streams from a clean UI
  • SSL/TLS — Automatic Let's Encrypt certificates with HTTP/2 and HTTP/3 (QUIC) support
  • WAF — ModSecurity with OWASP CoreRuleSet + OpenAppSec integration
  • CrowdSec IPS — Community-powered intrusion prevention
  • Cloudflare Tunnels — Create and manage Zero Trust tunnels directly from the UI
  • PHP-FPM — Optional PHP 8.2 / 8.3 / 8.4 integration
  • Analytics — Built-in GoAccess dashboard on port :91
  • Auth Requests — SSO support via Authentik and similar providers
  • Multi-DB — SQLite (default), MySQL/MariaDB, or PostgreSQL
  • i18n — UI available in English, German, Spanish, French, and more

📚 Documentation

Full setup guides, configuration options, and advanced usage are in the Wiki.

Projekt-Wiki (Intern)

Die interne Entwicklerdokumentation für Entwickler und AI-Agenten befindet sich unter:


🔨 Development

# Frontend
cd frontend && yarn install && yarn dev

# Backend
cd backend && npm install && npm run dev

# Tests
npm test

🙏 Acknowledgments

Special thanks to @ZoeyVid for the foundational work on NPMplus, and to all contributors who help make ShieldPM better.

Questions or ideas? Head over to GitHub Discussions — we'd love to hear from you.


Maintained with ❤️ by the ShieldPM Contributors.

About

ShieldPM is an advanced, security-focused of Nginx Proxy Manager (NPM).

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages