PteroGroups

Group, sort and manage servers from multiple Pterodactyl panels on one dashboard.

No reviews yet

Requirements


Panel	Pterodactyl 1.x (tested on 1.15)
OS	Ubuntu or Debian
Web server	nginx or Caddy (Apache: manual setup)
Access	root
License	A Lattice license key with Ptero Groups

Node.js is installed for you if it is missing.

unzip ptero-groups-*.zip
cd ptero-groups-*/
sudo bash install.sh --license LAT-XXXXX-XXXXX-XXXXX-XXXXX

Reload the dashboard. You will see a Groups button above your servers.

Option	Use
`--license KEY`	Your Lattice license key
`--panel PATH`	Panel folder if not `/var/www/pterodactyl`
`--panel-url URL`	Panel URL if it cannot be read from `.env`
`--port PORT`	Local port for the service (default 47811)
`--skip-proxy`	Do not touch the web server config

ptero-groups is installed with the addon. Run it as root.

Command	Does
`ptero-groups status`	Version, service, license and panel patch status
`ptero-groups license`	Show license status
`ptero-groups license set KEY`	Set your license key and restart
`ptero-groups license refresh`	Check your license with Lattice now
`ptero-groups restart`	Restart the service
`ptero-groups logs`	Recent logs (`logs follow` to follow)
`ptero-groups patch`	Re-apply the panel patch after a panel update

Unzip the new version and run its installer. Your settings, license and groups are kept.

unzip ptero-groups-LATEST.zip
cd ptero-groups-LATEST/
sudo bash install.sh

Command	Removes
`sudo bash uninstall.sh --keep-data`	Everything except your groups and config
`sudo bash uninstall.sh --purge`	Everything

The panel is restored exactly as it was.

Feature	How
Groups	Groups > New group. Rename, recolor and delete from the group's menu
Move servers	Drag the handle on a server, or right click > Move to group
Collapse	Click a group header
Other panels	Groups > Remote panels. Add the panel URL and a client API key from that panel
Hide panels or servers	Use the switches in Remote panels
Rename remote servers	Right click > Rename on this panel. Only you see the name
Console, files and server pages	Click a remote server. Databases, schedules, users, backups, network, startup, settings and activity work like on the panel, and each page has its own URL (/remote/server/...), so back and forward work

Each user has their own groups and remote panels.

File: /etc/ptero-groups/config.json. Run ptero-groups restart after changes.

Key	Meaning
`licenseKey`	Your Lattice license key
`panelUrl`	Public panel URL
`panelUpstream`	How the service reaches the panel locally
`port`	Local service port
`logLevel`	`info` or `debug`

Problem	Fix
No Groups button	Hard refresh, then run `ptero-groups status`
"Ptero Groups is inactive"	Run `ptero-groups license`. Set the key with `ptero-groups license set KEY`
Remote console will not connect	The other panel's node must be reachable from this server
Groups gone after a panel update	Run `ptero-groups patch`
Anything else	`ptero-groups logs`

Open a ticket on Lattice: https://license.atlantisservices.net/support