Skip to content

Security Scanner

Thank you for your purchase!

Important

This addon only adds some files to your nodes. Because of that, these steps need to be done on your Wings server, not the panel.

Installation

Step 1: Create Directory & Upload Files

Create the SecurityScanner directory and upload the files:

bash
sudo mkdir -p /opt/securityscanner
bash
cd /opt/securityscanner

Upload all SecurityScanner files to /opt/securityscanner using SFTP or your preferred file transfer method.

Step 2: Install Dependencies

Install Node.js and project dependencies:

bash
curl -fsSL https://deb.nodesource.com/setup_22.x | sudo bash -
bash
sudo apt install nodejs
bash
cd /opt/securityscanner && npm install

Step 3: Configure

Edit config.yml with your Pterodactyl API keys and server paths:

bash
nano /opt/securityscanner/config.yml

Important

You need an Application API key (starts with ptla_), not a Client API key. Set the correct Wings base path where your server files are stored (usually /var/lib/pterodactyl/volumes).

Configuration

Pterodactyl API Configuration

In your config.yml, configure:

yaml
pterodactyl:
  url: 'https://your-panel.com'
  apiKey: 'ptla_your_api_key_here'
  serverListEndpoint: '/api/application/servers'

Wings Server Paths

Set the correct paths for your Wings installation:

yaml
wings:
  basePath: '/var/lib/pterodactyl/volumes'
  serverPathPattern: '%s'
  scanMode: 'all'

Discord Notifications (Optional)

Enable Discord webhook notifications:

yaml
discord:
  enabled: true
  webhookUrl: 'https://discordapp.com/api/webhooks/YOUR_WEBHOOK_URL'
  severityThreshold: 'critical'

Step 4: Run the Service

Install PM2 and start the service:

bash
sudo npm install -g pm2
bash
cd /opt/securityscanner && sudo pm2 start index.js --name "securityscanner"
bash
sudo pm2 startup && sudo pm2 save

Usage

Once running, Security Scanner will automatically:

  • Scan all server files for malware and security threats
  • Monitor for suspicious files and patterns
  • Send notifications via Discord (if configured)
  • Log all security events

Managing the Service

CommandDescription
sudo pm2 statusCheck service status
sudo pm2 logs securityscannerView logs
sudo pm2 restart securityscannerRestart the service
sudo pm2 stop securityscannerStop the service

Need Help?

Join our Discord Server and open a ticket for support.

© 2025 Security Scanner - BuiltByOtte. All rights reserved.

Last updated: