Advanced Usage

Advanced Usage

Unlock the full potential of ShieldPM with these advanced configurations and features.

---

📋 Quick Navigation

Feature	Description	Link
GoAccess Analytics	Real-time web log analyzer	Below
PHP-FPM	Serve PHP apps directly	PHP Hosting Guide
Custom Nginx Config	Load Balancing, Upstreams	Below
Dashboard Notes	Sticky notes widget	Below
Streams (TCP/UDP)	Forward non-HTTP traffic	Streams Guide

---

📊 GoAccess Analytics

ShieldPM includes GoAccess, a real-time web log analyzer.

• Enable: Set GOA=true in compose.yaml (Docker) or /data/.env (Native/LXC).
• Access: Open http://<your-server-ip>:91 (Port 91 by default).
• GeoIP: To enable GeoIP stats, download the MaxMind GeoLite2 databases (Country, City, ASN) into the goaccess/geoip folder inside your data directory.

🐘 PHP-FPM Integration

You can serve PHP applications directly through ShieldPM.

External PHP-FPM (Recommended)

This approach keeps your containers clean and separated.

1. Run a separate PHP-FPM container and mount the application files so the Nginx and PHP-FPM containers see them at compatible paths.
2. Configure the Nginx FastCGI location for the reachable PHP-FPM address and the correct shared SCRIPT_FILENAME. The per-host Path + Enable PHP option described in PHP Hosting targets ShieldPM's internal Unix socket and does not automatically connect to an external FPM container.

Internal PHP (Not Recommended)

• Enable PHP82=true (or PHP83=true/PHP84=true) in compose.yaml or /data/.env.
• In the UI, set the Proxy Host scheme to Path, enter the local site directory as Forward Hostname/IP, enable PHP and select the matching version. ShieldPM connects to an internal Unix socket; the version numbers are not network ports.

🛠️ Custom Nginx Configurations

Defined Locations

You can add custom Nginx directives to specific locations in the Locations tab of a Proxy Host.

Tip

Example: Protecting a path Add a location /admin, and in the Custom Config gear icon:

allow 192.168.1.0/24;
deny all;

1. Create a http_top.conf file in your custom Nginx config directory:

   • Docker: /opt/shieldpm/custom_nginx/http_top.conf (maps to /data/custom_nginx/)
   • Native / LXC: /data/custom_nginx/http_top.conf

2. Define your upstream block:

   upstream my_backend {
       least_conn;               # Load balancing strategy
       server 10.0.0.1:80;
       server 10.0.0.2:80;
       server 10.0.0.3:80 down;  # Mark server as down
   }

3. In the UI, point your Proxy Host scheme to http and Forward Host to my_backend.

Stream Hosts (TCP/UDP Forwarding)

ShieldPM isn't just for HTTP/HTTPS. You can forward raw TCP/UDP traffic (e.g., Game Servers, Database ports). 👉 Read the full Streams documentation

---

📝 Dashboard Notes

The Dashboard includes a Sticky Notes widget where you can create colored notes to keep track of important information, reminders, or documentation for your infrastructure.

Features

• Create / Edit / Delete notes directly on the Dashboard.
• Color Options: Yellow, Blue, Green, Red, Purple, and Gray.
• Permissions: Users need the Dashboard Notes View permission to see the widget and Manage permission to add, edit or delete notes.

Usage

1. Go to the Dashboard (home page).
2. Find the Notes widget.
3. Click the + button to create a new note.
4. Enter your text, choose a color, and save.

---

🏠 Home | 🐞 Report a Bug