GSP/Panel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Align instructions and FAQ with WDS docs

Browse source
This commit is contained in:
Frank Harris 2025-11-26 19:31:15 -05:00
parent 75ae6cd870
commit e1d91dcf47
3 changed files with 68 additions and 411 deletions
Download patch file Download diff file Expand all files Collapse all files

8
.github/agent.md vendored
View file

@ -3,6 +3,14 @@
**Repo of truth:** `GameServerPanel/GSP`, branch `Panel-unstable`.
**Prime directive:** Read this document first. Keep `.github/agent.md` identical to this file—any edit here must be mirrored there in the same commit.
## Workspace deliverables (WDS 2025 refresh)
- Use the GSP/WDS/GSW branding across UI, docs, and comments; when heritage context matters add: “GSP is a heavily customized fork of OGP maintained by WDS.”
- Keep `bootstrap/` current: Ubuntu 24.04 panel + agent installers, Windows Server 2019 (Cygwin) agent installer + service wrapper, and the optional `docker/compose.yml` dev stack. All scripts must be idempotent, echo next steps, and document verify/rollback procedures in their README files.
- Author and maintain admin-only docs in `WDS_Website/content/projects/gsp.md` and `content/docs/gsp/*` (front-matter + the **Admin Documentation** banner). Cross-link these guides from panel features that need deep dives.
- Refresh user-facing help in `modules/faq/` (RSS + UI) so the seven core topics—panel basics, file browser, Adminer/MySQL, FTP/SFTP, task scheduler, sub-users, and support—link to the latest WDS admin docs.
- Track cross-repo progress in `WDS-Team/docs/wds-gsp-migration.md` and update `.github/copilot-instructions.md` + `.github/agent.md` in lockstep whenever these guardrails change.
- Enforce the shared security settings everywhere: SSH port 12322, MySQL accounts `localuser@localhost` and `remoteuser@<reporter-ip>`, shared secret stored at `/home/gameserver/tools/.password`, and mention optional DR/monitoring tools in admin docs when relevant.
## Deployment model & paths
- `modules/billing/` houses the public storefront. Those files are always present inside the panel repo and get deployed either (a) as the root of a dedicated virtual host or (b) through the panel module loader (`home.php?m=billing`).
- Because the storefront and the control panel live in the same tree, you may include panel helpers when needed. Use the dedicated bridge include (`modules/billing/includes/panel_bridge.php`) instead of sprinkling ad-hoc `../../includes/...` calls.

8
.github/copilot-instructions.md vendored
View file

@ -3,6 +3,14 @@
**Repo of truth:** `GameServerPanel/GSP`, branch `Panel-unstable`.
**Prime directive:** Read this document first. Keep `.github/agent.md` identical to this file—any edit here must be mirrored there in the same commit.
## Workspace deliverables (WDS 2025 refresh)
- Use the GSP/WDS/GSW branding across UI, docs, and comments; when heritage context matters add: “GSP is a heavily customized fork of OGP maintained by WDS.”
- Keep `bootstrap/` current: Ubuntu 24.04 panel + agent installers, Windows Server 2019 (Cygwin) agent installer + service wrapper, and the optional `docker/compose.yml` dev stack. All scripts must be idempotent, echo next steps, and document verify/rollback procedures in their README files.
- Author and maintain admin-only docs in `WDS_Website/content/projects/gsp.md` and `content/docs/gsp/*` (front-matter + the **Admin Documentation** banner). Cross-link these guides from panel features that need deep dives.
- Refresh user-facing help in `modules/faq/` (RSS + UI) so the seven core topics—panel basics, file browser, Adminer/MySQL, FTP/SFTP, task scheduler, sub-users, and support—link to the latest WDS admin docs.
- Track cross-repo progress in `WDS-Team/docs/wds-gsp-migration.md` and update `.github/copilot-instructions.md` + `.github/agent.md` in lockstep whenever these guardrails change.
- Enforce the shared security settings everywhere: SSH port 12322, MySQL accounts `localuser@localhost` and `remoteuser@<reporter-ip>`, shared secret stored at `/home/gameserver/tools/.password`, and mention optional DR/monitoring tools in admin docs when relevant.
## Deployment model & paths
- `modules/billing/` houses the public storefront. Those files are always present inside the panel repo and get deployed either (a) as the root of a dedicated virtual host or (b) through the panel module loader (`home.php?m=billing`).
- Because the storefront and the control panel live in the same tree, you may include panel helpers when needed. Use the dedicated bridge include (`modules/billing/includes/panel_bridge.php`) instead of sprinkling ad-hoc `../../includes/...` calls.

463
modules/faq/faq.rss
View file

@ -1,449 +1,90 @@
<?xml version="1.0" encoding="utf-8" ?>
<rss version="2.0"
<rss version="2.0"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:admin="http://webns.net/mvcb/"
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
xmlns:wfw="http://wellformedweb.org/CommentAPI/"
xmlns:content="http://purl.org/rss/1.0/modules/content/"
>
xmlns:content="http://purl.org/rss/1.0/modules/content/">
<channel>
<title>IAREGAMER FAQ</title>
<link>https://iaregamer.com</link>
<description></description>
<title>GSP FAQ</title>
<link>https://worlddomination.software/projects/gsp</link>
<description>Quick answers for GameServer Panel (GSP) operators</description>
<dc:language>en</dc:language>
<generator>Serendipity 2.0.4 - http://www.s9y.org/</generator>
<pubDate>Wed, 17 Jun 2020 20:10:54 GMT</pubDate>
<generator>World Domination Software FAQ Generator</generator>
<pubDate>Tue, 11 Feb 2025 12:00:00 GMT</pubDate>
<image>
<url></url>
<title>RSS: IAREGAMER FAQ - </title>
<link>https://iaregamer.com</link>
<title>RSS: GSP FAQ</title>
<link>https://worlddomination.software/projects/gsp</link>
<width>100</width>
<height>21</height>
</image>
<item>
<title>What if I need help with my server?</title>
<category>General</category>
<content:encoded>
(1) if your server is not responding, submit a ticket or contact us on Discord
(2) if you need help with scripting, contact us on Discord and let us know what you need
(3) confused? contact us on Discord
</content:encoded>
<title>How do I sign in and navigate the control panel?</title>
<category>Control Panel Basics</category>
<content:encoded><![CDATA[
<p>Sign in at <code>https://&lt;your-panel&gt;/</code> with your panel credentials. The left navigation groups the core areas: <strong>Servers</strong>, <strong>Tools</strong>, <strong>Billing</strong>, and <strong>Support</strong>. Once logged in, the same opengamepanel_web session also opens the storefront via <em>Modules → Billing</em>.</p>
<p>Need the big picture? The <a href="https://worlddomination.software/projects/gsp">GSP project overview</a> explains how the panel, storefront, and agents fit together.</p>
]]></content:encoded>
</item>
<item>
<title>What is the Query Port (or other port) for my server</title>
<category>General</category>
<content:encoded>
Each game has its own category with specific information about that game including the query (and other) ports.
Look in the FAQ category for your game.
If your game is not listed, or the query port is not specified then its probably the SAME as your SERVER PORT. If it still doesnt work, submit a ticket and we will find out ASAP for you (and update the FAQ)
</content:encoded>
</item>
<item>
<title>What are subusers and groups? How do I add them?</title>
<category>Panel</category>
<content:encoded>
&lt;iframe width=&quot;560&quot; height=&quot;315&quot; src=&quot;https://www.youtube.com/embed/g45JbifloFQ&quot; frameborder=&quot;0&quot; allowfullscreen&gt;&lt;/iframe&gt;
</content:encoded>
</item>
<item>
<title>My server won't start. Error: &quot;Failed to start the remote server. Error code: -1&quot; or &quot;Failed with server query&quot;</title>
<category>Error Messages</category>
<content:encoded>
Often the message (Failed with Server Query) means its just taking a long time for the server to start, give it some time and see what happens.
Check your logs for error messages.
Your server MAY have been misconfigured and is not starting correctly.
BUT have you recently changed any files?
The most common reason is the server is crashing or fails to start because of invalid, missing files
or something is misconfigured.
Restore the BACKUP you made before editing your server. (You DID backup, right?)
If you have NOT made any changes, contact support and we will investigate.
</content:encoded>
</item>
<item>
<title>What is my Query or Rcon port?</title>
<category>Ark</category>
<content:encoded>
Query port is your SERVER port +2
</content:encoded>
</item>
<item>
<title>What is my Query or Rcon port?</title>
<category>Arma</category>
<content:encoded>
Query port is your SERVER port +1
</content:encoded>
</item>
<item>
<title>What is my Query or Rcon port?</title>
<category>Conan Exiles</category>
<content:encoded>
Query port is your SERVER port +2
Rcon port is your SERVER port + 3
</content:encoded>
</item>
<item>
<title>What is my Query port?</title>
<category>Dayz</category>
<content:encoded>
Dayz MOD query port is your SERVER port +1
Dayz STANDALONE query port is your SERVER port +3
</content:encoded>
</item>
<item>
<title>What is my Query or Rcon port?</title>
<category>Killing Floor</category>
<content:encoded>
Query port is your SERVER port +1
</content:encoded>
</item>
<item>
<title>I get an ERROR when trying to connect to the FTP using my client</title>
<category>Panel</category>
<content:encoded>
Does the error mention TLS or secure connection? Try different encryption settings. Our FTP servers do not have TLS enabled.
</content:encoded>
</item>
<item>
<title>How can I backup and restore my Gameserver database?</title>
<category>Panel</category>
<content:encoded>
In your Game Monitor, click on the MYSQL button and then login to PHPMYADMIN.
Select EXPORT and save the file on your local PC.
To RESTORE, delete ALL TABLES, FUNCTIONS and DATA from your DB then IMPORT your file
</content:encoded>
</item>
<item>
<title>Why can't I delete some files in my game server folder?</title>
<category>Panel</category>
<content:encoded>
We protect the &lt;strong&gt;server executable&lt;/strong&gt; and the &lt;strong&gt;startup script&lt;/strong&gt; to disallow modifications by the user.
If you need to change this file, contact support.
</content:encoded>
</item>
<item>
<title>How do I validate my files with Steam?</title>
<category>Panel</category>
<content:encoded>
If you click on the INSTALL/UPDATE button it will validate all your Steam files. If you want to WIPE your server and reinstall fresh, 'check' the checkbox on the upper left of the
FILE MANAGER and REMOVE all files. Then press INSTALL/UPDATE and Steam will replace all the missing files.
</content:encoded>
</item>
<item>
<title>How do I restart my server?</title>
<category>Dayz</category>
<content:encoded>
BEC is preinstalled with your server. You can set the scheduler.xml to restart at intervals.
There is a scheduler_faq.xml file inside your bec/config folder that will explain in detail
how to configure the scheduler.
As always, if you need help just ask on Discord.
</content:encoded>
</item>
<item>
<title>What is the Game Monitor and how do I use it?</title>
<category>Game Monitor</category>
<content:encoded>
The Game Monitor is your main control center for managing your game server. From here you can:
<br /><br />
<strong>Server Status:</strong> View real-time information about your server including player count, map, and server status
<br />
<strong>Start/Stop/Restart:</strong> Control your server's power state with dedicated buttons
<br />
<strong>Update Server:</strong> Keep your game server files up to date with automatic or manual updates
<br />
<strong>View Logs:</strong> Monitor server logs to troubleshoot issues or track player activity
<br />
<strong>RCON Console:</strong> Send commands directly to your server if supported by the game
<br /><br />
The monitor refreshes automatically to give you up-to-date information about your server's performance and status.
</content:encoded>
</item>
<item>
<title>How do I start, stop, or restart my server?</title>
<category>Game Monitor</category>
<content:encoded>
From the Game Monitor page:
<br /><br />
<strong>Start:</strong> Click the "Start" button to launch your server. Wait for the status to show as "Online"
<br />
<strong>Stop:</strong> Click the "Stop" button to safely shut down your server
<br />
<strong>Restart:</strong> Click "Restart" to stop and start your server in one action
<br /><br />
<strong>Important:</strong> Always use these controls rather than killing processes directly. This ensures proper shutdown and prevents data corruption.
<br /><br />
If your server fails to start, check the server logs for error messages that can help identify configuration issues.
</content:encoded>
</item>
<item>
<title>What is the Scheduler and how does it work?</title>
<category>Scheduler</category>
<content:encoded>
The Scheduler is a cron-like system that allows you to automate server tasks at specific times or intervals.
<br /><br />
<strong>What is Cron?</strong> Cron is a time-based job scheduler used in Unix-like systems (Linux). The panel's Scheduler brings this functionality to game server management.
<br /><br />
<strong>Common uses:</strong>
<br />• Automatic server restarts (daily, weekly, etc.)
<br />• Scheduled server updates
<br />• Backup creation at regular intervals
<br />• Sending automated messages to players
<br />• Running custom scripts or commands
<br /><br />
Access the Scheduler from the main menu to create, edit, or delete scheduled tasks for your servers.
</content:encoded>
</item>
<item>
<title>How do I create scheduled tasks (for non-Linux users)?</title>
<category>Scheduler</category>
<content:encoded>
The Scheduler uses cron syntax, which may be unfamiliar to Windows users. Here's a simple guide:
<br /><br />
<strong>Cron Format:</strong> * * * * * (5 fields separated by spaces)
<br />Position 1: Minute (0-59)
<br />Position 2: Hour (0-23, where 0 = midnight)
<br />Position 3: Day of month (1-31)
<br />Position 4: Month (1-12)
<br />Position 5: Day of week (0-7, where 0 and 7 = Sunday)
<br /><br />
<strong>Examples:</strong>
<br />• <code>0 6 * * *</code> - Every day at 6:00 AM
<br />• <code>0 0 * * 0</code> - Every Sunday at midnight
<br />• <code>*/30 * * * *</code> - Every 30 minutes
<br />• <code>0 4 * * 1</code> - Every Monday at 4:00 AM
<br /><br />
<strong>Special characters:</strong>
<br />• <code>*</code> means "every" (every minute, hour, etc.)
<br />• <code>*/X</code> means "every X units" (*/15 = every 15 minutes)
<br />• <code>X,Y</code> means "at X and Y" (1,15 = 1st and 15th)
<br />• <code>X-Y</code> means "from X to Y" (9-17 = 9 AM to 5 PM)
</content:encoded>
</item>
<item>
<title>Common Scheduler examples for game servers</title>
<category>Scheduler</category>
<content:encoded>
Here are practical examples for common server management tasks:
<br /><br />
<strong>Daily Restart at 6 AM:</strong>
<br />Schedule: <code>0 6 * * *</code>
<br />Action: Restart Server
<br /><br />
<strong>Weekly Restart (Sunday 3 AM):</strong>
<br />Schedule: <code>0 3 * * 0</code>
<br />Action: Restart Server
<br /><br />
<strong>Hourly Server Update Check:</strong>
<br />Schedule: <code>0 * * * *</code>
<br />Action: Update Server
<br /><br />
<strong>Daily Backup at Midnight:</strong>
<br />Schedule: <code>0 0 * * *</code>
<br />Action: Create Backup
<br /><br />
<strong>Maintenance Window (2 AM - 4 AM daily):</strong>
<br />Stop: <code>0 2 * * *</code>
<br />Start: <code>0 4 * * *</code>
<br /><br />
Remember to consider your server's time zone and peak player hours when scheduling restarts or maintenance.
</content:encoded>
</item>
<item>
<title>What is the Dashboard and what can I see there?</title>
<category>Dashboard</category>
<content:encoded>
The Dashboard is your overview page that displays key information about all your servers and account:
<br /><br />
<strong>Server Status Widgets:</strong> Quick view of all your servers' online/offline status
<br />
<strong>Resource Usage:</strong> CPU, memory, and disk usage for your servers
<br />
<strong>Player Activity:</strong> Current player counts across all your game servers
<br />
<strong>Recent Events:</strong> Server starts, stops, updates, and other activities
<br />
<strong>Quick Actions:</strong> Fast access to common tasks like starting/stopping servers
<br />
<strong>System Alerts:</strong> Important notifications about your servers or account
<br /><br />
The Dashboard refreshes automatically and serves as your central command center for monitoring multiple game servers at a glance.
</content:encoded>
</item>
<item>
<title>How do I manage server configuration files?</title>
<title>How do I use the File Browser?</title>
<category>File Management</category>
<content:encoded>
The panel provides several ways to edit your server configuration files:
<br /><br />
<strong>Config Files Editor:</strong> Built-in editor for game-specific configuration files with syntax highlighting
<br />
<strong>File Manager:</strong> Browser-based file manager to upload, download, edit, and organize all server files
<br />
<strong>FTP Access:</strong> Use your favorite FTP client to manage files directly
<br /><br />
<strong>Important Tips:</strong>
<br />• Always backup configuration files before making changes
<br />• Stop your server before editing critical config files
<br />• Some files are protected and cannot be modified for security reasons
<br />• Test configuration changes carefully - invalid configs can prevent server startup
<br />• Use the built-in editor when possible as it provides validation and syntax checking
</content:encoded>
<content:encoded><![CDATA[
<p>Open <strong>Tools → File Browser</strong>, pick the server/home, then upload, edit, extract ZIPs, or chmod files right in the browser. Drag-and-drop works for uploads under the PHP limit, and the audit log tracks who changed what.</p>
<p>See the <a href="https://worlddomination.software/docs/gsp/file-browser">File Browser admin guide</a> for quotas, logging paths, and recovery steps.</p>
]]></content:encoded>
</item>
<item>
<title>How do I use the File Manager?</title>
<title>How do I access MySQL via Adminer?</title>
<category>Databases</category>
<content:encoded><![CDATA[
<p>Go to <code>https://&lt;your-panel&gt;/adminer.php</code>, set host <code>localhost</code>, database <code>gsp_panel</code>, user <code>localuser</code>, and use the password stored in <code>/home/gameserver/tools/.password</code>. For reporting boxes, tunnel with <code>ssh -p 12322 -L 3307:127.0.0.1:3306</code> and log in as <code>remoteuser@&lt;reporter-ip&gt;</code>.</p>
<p>The <a href="https://worlddomination.software/docs/gsp/adminer-mysql">Adminer/MySQL guide</a> covers exports, password rotation, and rollback.</p>
]]></content:encoded>
</item>
<item>
<title>How do I use FTP or SFTP?</title>
<category>File Management</category>
<content:encoded>
The File Manager is a web-based interface for managing your server files:
<br /><br />
<strong>Navigation:</strong> Click folders to browse your server directory structure
<br />
<strong>Upload Files:</strong> Drag and drop files or use the upload button to add files to your server
<br />
<strong>Edit Files:</strong> Click on text files to open the built-in editor
<br />
<strong>Download Files:</strong> Right-click files to download them to your computer
<br />
<strong>Create Folders:</strong> Use the "New Folder" button to organize your files
<br />
<strong>Delete Files:</strong> Select files and click delete (be careful - this is permanent!)
<br />
<strong>Permissions:</strong> View and modify file permissions if your game requires specific settings
<br /><br />
The File Manager supports most common file operations and is perfect for quick changes without needing a separate FTP client.
</content:encoded>
<content:encoded><![CDATA[
<p>SFTP is preferred: <code>sftp -oPort=12322 username@&lt;panel-host&gt;</code> with your panel password (keys supported). Legacy FTP over TLS (port 21) remains available per home under <strong>User → My Servers → FTP Details</strong>; re-save the user if credentials fall out of sync.</p>
<p>Full details live in the <a href="https://worlddomination.software/docs/gsp/ftp-sftp">FTP &amp; SFTP admin guide</a>.</p>
]]></content:encoded>
</item>
<item>
<title>What backup and restore options are available?</title>
<category>Backup &amp; Restore</category>
<content:encoded>
The panel provides comprehensive backup and restore functionality:
<br /><br />
<strong>Automatic Backups:</strong> Schedule regular backups of your server files and data
<br />
<strong>Manual Backups:</strong> Create instant backups before making major changes
<br />
<strong>Database Backups:</strong> Export MySQL databases associated with your game servers
<br />
<strong>Selective Restore:</strong> Restore specific files or folders rather than entire server
<br />
<strong>Download Backups:</strong> Download backup files to your local computer for safekeeping
<br /><br />
<strong>Best Practices:</strong>
<br />• Always backup before major updates or configuration changes
<br />• Keep multiple backup versions (daily, weekly, monthly)
<br />• Test restore procedures periodically to ensure backups work
<br />• Store important backups offline for maximum protection
</content:encoded>
<title>How do I schedule jobs (cron)?</title>
<category>Automation</category>
<content:encoded><![CDATA[
<p>Visit <strong>Tools → Task Scheduler</strong>, choose <em>Add Task</em>, select the server/home plus action (start/stop/update/script), and pick a frequency. Jobs are executed by <code>ogp_cron</code> and their output appears in <code>modules/taskscheduler/logs/</code>.</p>
<p>The <a href="https://worlddomination.software/docs/gsp/task-scheduler">Task Scheduler admin doc</a> shows how to chain jobs, use dry-runs, and troubleshoot failures.</p>
]]></content:encoded>
</item>
<item>
<title>How do I manage server updates?</title>
<category>Server Management</category>
<content:encoded>
The panel provides multiple update options for keeping your servers current:
<br /><br />
<strong>Automatic Updates:</strong> Enable automatic Steam updates when new game versions are released
<br />
<strong>Manual Updates:</strong> Check for and apply updates on-demand from the Game Monitor
<br />
<strong>Scheduled Updates:</strong> Use the Scheduler to update servers during low-traffic periods
<br />
<strong>Validation:</strong> Verify and repair corrupted game files using Steam's validation system
<br />
<strong>Rollback:</strong> Restore previous game versions if needed (when backups are available)
<br /><br />
<strong>Update Tips:</strong>
<br />• Monitor update logs for any errors during the process
<br />• Consider backing up before major game updates
<br />• Some updates may require server restart or configuration changes
<br />• Test servers after updates to ensure mods and plugins still work
</content:encoded>
<title>How do I add or manage sub-users?</title>
<category>Account Management</category>
<content:encoded><![CDATA[
<p>Admins can create delegates via <strong>Administration → Users → Add sub-user</strong>. Pick the parent account, assign servers/modules, and save. Sub-users inherit billing but only see the resources you grant.</p>
<p>Walkthroughs live in the <a href="https://worlddomination.software/docs/gsp/sub-users">Sub-users &amp; permissions guide</a>.</p>
]]></content:encoded>
</item>
<item>
<title>How do I use RCON to manage my server?</title>
<category>Server Management</category>
<content:encoded>
RCON (Remote Console) allows you to send commands directly to your game server:
<br /><br />
<strong>Accessing RCON:</strong> Click the "Console" or "RCON" button in your Game Monitor
<br />
<strong>Authentication:</strong> RCON may require a password set in your server configuration
<br />
<strong>Common Commands:</strong>
<br />• <code>say [message]</code> - Send message to all players
<br />• <code>kick [player]</code> - Remove a player from the server
<br />• <code>ban [player]</code> - Permanently ban a player
<br />• <code>status</code> - Show server status and player list
<br />• <code>changelevel [map]</code> - Change to a different map
<br /><br />
<strong>Note:</strong> Available commands vary by game. Not all games support RCON functionality. Check your specific game's documentation for supported commands.
</content:encoded>
<title>How do I get help?</title>
<category>Support</category>
<content:encoded><![CDATA[
<p>Use the panel’s <strong>Support</strong> menu to submit a ticket or join the WDS Discord via the footer link. Include server name, recent changes, and any error output. For outages, contact the DR on-call per the internal runbook.</p>
<p>Operations procedures and escalation paths are collected in the <a href="https://worlddomination.software/docs/gsp/">WDS GSP admin docs</a>.</p>
]]></content:encoded>
</item>
</channel>