From e1d91dcf47d7dae9bb7d1b62e62c6a52558ddab4 Mon Sep 17 00:00:00 2001 From: iaretechnician Date: Wed, 26 Nov 2025 19:31:15 -0500 Subject: [PATCH] Align instructions and FAQ with WDS docs --- .github/agent.md | 8 + .github/copilot-instructions.md | 8 + modules/faq/faq.rss | 463 ++++---------------------------- 3 files changed, 68 insertions(+), 411 deletions(-) diff --git a/.github/agent.md b/.github/agent.md index 558c2550..95821878 100644 --- a/.github/agent.md +++ b/.github/agent.md @@ -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@`, 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. diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 558c2550..95821878 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -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@`, 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. diff --git a/modules/faq/faq.rss b/modules/faq/faq.rss index a8a57a21..ecab8b54 100644 --- a/modules/faq/faq.rss +++ b/modules/faq/faq.rss @@ -1,449 +1,90 @@ - + xmlns:content="http://purl.org/rss/1.0/modules/content/"> - IAREGAMER FAQ - https://iaregamer.com - + GSP FAQ + https://worlddomination.software/projects/gsp + Quick answers for GameServer Panel (GSP) operators en - Serendipity 2.0.4 - http://www.s9y.org/ - Wed, 17 Jun 2020 20:10:54 GMT + World Domination Software FAQ Generator + Tue, 11 Feb 2025 12:00:00 GMT - RSS: IAREGAMER FAQ - - https://iaregamer.com + RSS: GSP FAQ + https://worlddomination.software/projects/gsp 100 21 - What if I need help with my server? - General - - - (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 - - - + How do I sign in and navigate the control panel? + Control Panel Basics + Sign in at https://<your-panel>/ with your panel credentials. The left navigation groups the core areas: Servers, Tools, Billing, and Support. Once logged in, the same opengamepanel_web session also opens the storefront via Modules → Billing.

+

Need the big picture? The GSP project overview explains how the panel, storefront, and agents fit together.

+ ]]> - What is the Query Port (or other port) for my server - General - - - 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) - - - - - - - - What are subusers and groups? How do I add them? - Panel - - - <iframe width="560" height="315" src="https://www.youtube.com/embed/g45JbifloFQ" frameborder="0" allowfullscreen></iframe> - - - - - - - My server won't start. Error: "Failed to start the remote server. Error code: -1" or "Failed with server query" - Error Messages - - -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. - - - - - What is my Query or Rcon port? - Ark - - - Query port is your SERVER port +2 - - - - - What is my Query or Rcon port? - Arma - - - Query port is your SERVER port +1 - - - - - - What is my Query or Rcon port? - Conan Exiles - - - Query port is your SERVER port +2 - Rcon port is your SERVER port + 3 - - - - - What is my Query port? - Dayz - - - Dayz MOD query port is your SERVER port +1 - Dayz STANDALONE query port is your SERVER port +3 - - - - - What is my Query or Rcon port? - Killing Floor - - - Query port is your SERVER port +1 - - - - - - I get an ERROR when trying to connect to the FTP using my client - Panel - - - Does the error mention TLS or secure connection? Try different encryption settings. Our FTP servers do not have TLS enabled. - - - - - How can I backup and restore my Gameserver database? - Panel - - -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 - - - - - - Why can't I delete some files in my game server folder? - Panel - - - We protect the <strong>server executable</strong> and the <strong>startup script</strong> to disallow modifications by the user. -If you need to change this file, contact support. - - - - - - - - How do I validate my files with Steam? - Panel - - - 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. - - - - - - How do I restart my server? - Dayz - - -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. - - - - - What is the Game Monitor and how do I use it? - Game Monitor - - - The Game Monitor is your main control center for managing your game server. From here you can: -

- Server Status: View real-time information about your server including player count, map, and server status -
- Start/Stop/Restart: Control your server's power state with dedicated buttons -
- Update Server: Keep your game server files up to date with automatic or manual updates -
- View Logs: Monitor server logs to troubleshoot issues or track player activity -
- RCON Console: Send commands directly to your server if supported by the game -

- The monitor refreshes automatically to give you up-to-date information about your server's performance and status. - - - - - How do I start, stop, or restart my server? - Game Monitor - - - From the Game Monitor page: -

- Start: Click the "Start" button to launch your server. Wait for the status to show as "Online" -
- Stop: Click the "Stop" button to safely shut down your server -
- Restart: Click "Restart" to stop and start your server in one action -

- Important: Always use these controls rather than killing processes directly. This ensures proper shutdown and prevents data corruption. -

- If your server fails to start, check the server logs for error messages that can help identify configuration issues. - - - - - What is the Scheduler and how does it work? - Scheduler - - - The Scheduler is a cron-like system that allows you to automate server tasks at specific times or intervals. -

- What is Cron? Cron is a time-based job scheduler used in Unix-like systems (Linux). The panel's Scheduler brings this functionality to game server management. -

- Common uses: -
• Automatic server restarts (daily, weekly, etc.) -
• Scheduled server updates -
• Backup creation at regular intervals -
• Sending automated messages to players -
• Running custom scripts or commands -

- Access the Scheduler from the main menu to create, edit, or delete scheduled tasks for your servers. - - - - - How do I create scheduled tasks (for non-Linux users)? - Scheduler - - - The Scheduler uses cron syntax, which may be unfamiliar to Windows users. Here's a simple guide: -

- Cron Format: * * * * * (5 fields separated by spaces) -
Position 1: Minute (0-59) -
Position 2: Hour (0-23, where 0 = midnight) -
Position 3: Day of month (1-31) -
Position 4: Month (1-12) -
Position 5: Day of week (0-7, where 0 and 7 = Sunday) -

- Examples: -
• 0 6 * * * - Every day at 6:00 AM -
• 0 0 * * 0 - Every Sunday at midnight -
• */30 * * * * - Every 30 minutes -
• 0 4 * * 1 - Every Monday at 4:00 AM -

- Special characters: -
• * means "every" (every minute, hour, etc.) -
• */X means "every X units" (*/15 = every 15 minutes) -
• X,Y means "at X and Y" (1,15 = 1st and 15th) -
• X-Y means "from X to Y" (9-17 = 9 AM to 5 PM) - - - - - Common Scheduler examples for game servers - Scheduler - - - Here are practical examples for common server management tasks: -

- Daily Restart at 6 AM: -
Schedule: 0 6 * * * -
Action: Restart Server -

- Weekly Restart (Sunday 3 AM): -
Schedule: 0 3 * * 0 -
Action: Restart Server -

- Hourly Server Update Check: -
Schedule: 0 * * * * -
Action: Update Server -

- Daily Backup at Midnight: -
Schedule: 0 0 * * * -
Action: Create Backup -

- Maintenance Window (2 AM - 4 AM daily): -
Stop: 0 2 * * * -
Start: 0 4 * * * -

- Remember to consider your server's time zone and peak player hours when scheduling restarts or maintenance. - - - - - What is the Dashboard and what can I see there? - Dashboard - - - The Dashboard is your overview page that displays key information about all your servers and account: -

- Server Status Widgets: Quick view of all your servers' online/offline status -
- Resource Usage: CPU, memory, and disk usage for your servers -
- Player Activity: Current player counts across all your game servers -
- Recent Events: Server starts, stops, updates, and other activities -
- Quick Actions: Fast access to common tasks like starting/stopping servers -
- System Alerts: Important notifications about your servers or account -

- The Dashboard refreshes automatically and serves as your central command center for monitoring multiple game servers at a glance. - - - - - How do I manage server configuration files? + How do I use the File Browser? File Management - - - The panel provides several ways to edit your server configuration files: -

- Config Files Editor: Built-in editor for game-specific configuration files with syntax highlighting -
- File Manager: Browser-based file manager to upload, download, edit, and organize all server files -
- FTP Access: Use your favorite FTP client to manage files directly -

- Important Tips: -
• Always backup configuration files before making changes -
• Stop your server before editing critical config files -
• Some files are protected and cannot be modified for security reasons -
• Test configuration changes carefully - invalid configs can prevent server startup -
• Use the built-in editor when possible as it provides validation and syntax checking - + Open Tools → File Browser, 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.

+

See the File Browser admin guide for quotas, logging paths, and recovery steps.

+ ]]> - How do I use the File Manager? + How do I access MySQL via Adminer? + Databases + Go to https://<your-panel>/adminer.php, set host localhost, database gsp_panel, user localuser, and use the password stored in /home/gameserver/tools/.password. For reporting boxes, tunnel with ssh -p 12322 -L 3307:127.0.0.1:3306 and log in as remoteuser@<reporter-ip>.

+

The Adminer/MySQL guide covers exports, password rotation, and rollback.

+ ]]> + + + + How do I use FTP or SFTP? File Management - - - The File Manager is a web-based interface for managing your server files: -

- Navigation: Click folders to browse your server directory structure -
- Upload Files: Drag and drop files or use the upload button to add files to your server -
- Edit Files: Click on text files to open the built-in editor -
- Download Files: Right-click files to download them to your computer -
- Create Folders: Use the "New Folder" button to organize your files -
- Delete Files: Select files and click delete (be careful - this is permanent!) -
- Permissions: View and modify file permissions if your game requires specific settings -

- The File Manager supports most common file operations and is perfect for quick changes without needing a separate FTP client. - + SFTP is preferred: sftp -oPort=12322 username@<panel-host> with your panel password (keys supported). Legacy FTP over TLS (port 21) remains available per home under User → My Servers → FTP Details; re-save the user if credentials fall out of sync.

+

Full details live in the FTP & SFTP admin guide.

+ ]]> - What backup and restore options are available? - Backup & Restore - - - The panel provides comprehensive backup and restore functionality: -

- Automatic Backups: Schedule regular backups of your server files and data -
- Manual Backups: Create instant backups before making major changes -
- Database Backups: Export MySQL databases associated with your game servers -
- Selective Restore: Restore specific files or folders rather than entire server -
- Download Backups: Download backup files to your local computer for safekeeping -

- Best Practices: -
• Always backup before major updates or configuration changes -
• Keep multiple backup versions (daily, weekly, monthly) -
• Test restore procedures periodically to ensure backups work -
• Store important backups offline for maximum protection - + How do I schedule jobs (cron)? + Automation + Visit Tools → Task Scheduler, choose Add Task, select the server/home plus action (start/stop/update/script), and pick a frequency. Jobs are executed by ogp_cron and their output appears in modules/taskscheduler/logs/.

+

The Task Scheduler admin doc shows how to chain jobs, use dry-runs, and troubleshoot failures.

+ ]]> - How do I manage server updates? - Server Management - - - The panel provides multiple update options for keeping your servers current: -

- Automatic Updates: Enable automatic Steam updates when new game versions are released -
- Manual Updates: Check for and apply updates on-demand from the Game Monitor -
- Scheduled Updates: Use the Scheduler to update servers during low-traffic periods -
- Validation: Verify and repair corrupted game files using Steam's validation system -
- Rollback: Restore previous game versions if needed (when backups are available) -

- Update Tips: -
• Monitor update logs for any errors during the process -
• Consider backing up before major game updates -
• Some updates may require server restart or configuration changes -
• Test servers after updates to ensure mods and plugins still work - + How do I add or manage sub-users? + Account Management + Admins can create delegates via Administration → Users → Add sub-user. Pick the parent account, assign servers/modules, and save. Sub-users inherit billing but only see the resources you grant.

+

Walkthroughs live in the Sub-users & permissions guide.

+ ]]> - How do I use RCON to manage my server? - Server Management - - - RCON (Remote Console) allows you to send commands directly to your game server: -

- Accessing RCON: Click the "Console" or "RCON" button in your Game Monitor -
- Authentication: RCON may require a password set in your server configuration -
- Common Commands: -
• say [message] - Send message to all players -
• kick [player] - Remove a player from the server -
• ban [player] - Permanently ban a player -
• status - Show server status and player list -
• changelevel [map] - Change to a different map -

- Note: Available commands vary by game. Not all games support RCON functionality. Check your specific game's documentation for supported commands. - + How do I get help? + Support + Use the panel’s Support 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.

+

Operations procedures and escalation paths are collected in the WDS GSP admin docs.

+ ]]>