complete codex docs
This commit is contained in:
parent
b5dcf01a8c
commit
3cefad183d
62 changed files with 2730 additions and 50 deletions
|
|
@ -1,54 +1,54 @@
|
|||
# Module Index
|
||||
|
||||
This is the current Panel module inventory. It is intentionally concise so future Codex sessions can decide which module to inspect in code.
|
||||
This is the master module inventory for the Panel. Use it as the first stop before opening module code.
|
||||
|
||||
| Module | Purpose | Current State | Dependencies | Notes |
|
||||
|---|---|---|---|---|
|
||||
| `TS3Admin` | Teamspeak 3 admin interface | Required, legacy niche | TS3 admin files | Keep if TS3 hosting is sold. |
|
||||
| `addonsmanager` | Server Content Manager | Required, actively evolving | DB tables, game XML, agent install scripts | Best current home for mods, add-ons, Workshop, and content installs. |
|
||||
| `administration` | Admin utilities | Required | Core admin pages | Includes logger/watch tools. |
|
||||
| `backup-restore` | Backup/restore UI | Optional, broken/testing | Hard-coded backup host/path logic | Hide until replaced. |
|
||||
| `billing` | Billing, provisioning, commerce | Optional, large custom module | Payment gateways, invoices, shop/provisioning docs | Important for commercial hosting. |
|
||||
| `circular` | Notification/circular messages | Optional | Panel UI | Good candidate for maintenance and announcement notices. |
|
||||
| `config_games` | Game XML definitions and CLI builder | Required | XML schema/parser | Critical for startup templates, queries, custom fields, and game capabilities. |
|
||||
| `cron` | Scheduler / CRON | Required | Agent scheduler methods, Panel action selection | Needs safe action registry and task history. |
|
||||
| `dashboard` | Main landing dashboard | Required | Panel auth and server summaries | Should surface status, support, billing, and alerts. |
|
||||
| `dsi` | Dynamic Server Image | Optional | Game imagery and cached assets | Useful for server cards and branding. |
|
||||
| `editconfigfiles` | Config file shortcuts | Optional | Game config metadata | Good for surfacing common editable files. |
|
||||
| `faq` | FAQ/help | Required | Site docs/content | Should link to game docs and common workflows. |
|
||||
| `fast_download` | FastDL support | Required | Source/GoldSrc-style web distribution | Still useful for older Source engine communities. |
|
||||
| `ftp` | FTP admin | Required | File transfer service, access rights | Needs security review but remains important. |
|
||||
| `gamemanager` | Server monitor, lifecycle, logs, RCON | Required | Agent RPC, game XML, query libraries | Core customer workflow module. |
|
||||
| `lgsl_with_img_mod` | LGSL server status images | Optional legacy | Query/image cache data | Secondary to agent truth. |
|
||||
| `litefm` | In-panel file manager | Required | File system access rights | Should be the preferred in-panel file tool. |
|
||||
| `lostpwd` | Password recovery | Required | Auth/account flow | Basic account support. |
|
||||
| `modulemanager` | Module installation/configuration | Required | Module metadata | Admin maintenance tool. |
|
||||
| `mysql` | MySQL hosting/admin | Required | MySQL service setup | Good future product tie-in for databases. |
|
||||
| `news` | Legacy news/announcements | Optional legacy | Old CMS-like data | Consider hiding unless modernized. |
|
||||
| `rcon` | RCON admin tool | Required | Server protocol support | Useful for commands, warnings, and scheduler integration. |
|
||||
| `register` | Account registration | Required | Auth flow | Basic customer onboarding. |
|
||||
| `server` | Server manager | Required | Agent/node management | Admin-facing node controls. |
|
||||
| `settings` | Global settings | Required | Auth, site config | Admin configuration area. |
|
||||
| `status` | Status page | Optional alpha | Status data | Not ready for customer-facing critical use. |
|
||||
| `steam_workshop` | Legacy Workshop module | Optional deprecated | Workshop DB helpers | Hidden/deprecated in favor of `addonsmanager`. |
|
||||
| `subusers` | Subuser permissions | Required | Authorization model | Important for commercial teams and communities. |
|
||||
| `support` | Support landing page | Required | Ticketing/docs | Better as an entry point than the full ticket workflow. |
|
||||
| `teamspeak3` | Teamspeak 3 web interface | Required if sold | TS3 service | Hide if not part of the product offering. |
|
||||
| `tickets` | Support ticket system | Optional but useful | DB tables, attachments, notifications | Stronger support workflow than `support` alone. |
|
||||
| `tshock` | Terraria/TShock utilities | Optional niche | Terraria/TShock game support | Expose only for supported games. |
|
||||
| `update` | Panel updates | Required admin tool | Patch/update system | Admin-only maintenance. |
|
||||
| `user_admin` | User management | Required | Auth/admin roles | Important for staff administration. |
|
||||
| `user_games` | Server provisioning and assignment | Required | Game homes, ports, billing integration | Core provisioning path. |
|
||||
| `util` | Utility tools | Required | Misc tools | Keep useful tools, hide legacy helpers that are not maintained. |
|
||||
| Module | Purpose | Status | Recommendation |
|
||||
|---|---|---|---|
|
||||
| [`TS3Admin`](TS3Admin.md) | Teamspeak 3 admin interface | Functional / niche | Keep or hide depending on product line |
|
||||
| [`administration`](administration.md) | Admin utilities and logging helpers | Functional / legacy-leaning | Keep |
|
||||
| [`addonsmanager`](SERVER_CONTENT_MANAGER.md) | Server Content Manager | Functional / actively evolving | Keep / Improve |
|
||||
| [`backup-restore`](backup-restore.md) | Backup and restore UI | Broken | Remove / Replace |
|
||||
| [`billing`](billing.md) | Billing, provisioning, commerce | Functional / partial | Keep / Rewrite |
|
||||
| [`circular`](circular.md) | Notification and circular messages | Functional | Keep / Improve |
|
||||
| [`config_games`](config_games.md) | XML game definitions and CLI builder | Production / functional | Keep / Improve |
|
||||
| [`cron`](SCHEDULER.md) | Scheduler / CRON | Functional / partial | Rewrite / Improve |
|
||||
| [`dashboard`](dashboard.md) | Main landing dashboard | Functional | Keep / Improve |
|
||||
| [`dsi`](dsi.md) | Dynamic Server Image | Legacy / functional | Keep / Audit |
|
||||
| [`editconfigfiles`](editconfigfiles.md) | Config file shortcuts | Functional / partial | Keep / Improve |
|
||||
| [`faq`](faq.md) | FAQ and help content | Functional | Keep / Improve |
|
||||
| [`fast_download`](fast_download.md) | FastDL support | Functional | Keep |
|
||||
| [`ftp`](ftp.md) | FTP administration | Functional / legacy-heavy | Keep / Rewrite |
|
||||
| [`gamemanager`](GAMEMANAGER.md) | Server monitor, lifecycle, logs, RCON | Production / functional | Keep / Improve |
|
||||
| [`lgsl_with_img_mod`](lgsl_with_img_mod.md) | LGSL server status images | Legacy | Deprecate / Keep as legacy |
|
||||
| [`litefm`](litefm.md) | In-panel file manager | Functional | Keep / Improve |
|
||||
| [`lostpwd`](lostpwd.md) | Password recovery | Functional | Keep |
|
||||
| [`modulemanager`](modulemanager.md) | Module installation and access rights | Functional | Keep |
|
||||
| [`mysql`](mysql.md) | MySQL hosting/admin | Functional / future-facing | Keep / Future |
|
||||
| [`news`](news.md) | Legacy news / announcements | Legacy | Deprecate / Hide unless modernized |
|
||||
| [`rcon`](rcon.md) | RCON admin tool | Functional | Keep / Improve |
|
||||
| [`register`](register.md) | Account registration | Functional | Keep |
|
||||
| [`server`](server.md) | Remote server and node manager | Production / administrative | Keep / Improve |
|
||||
| [`settings`](settings.md) | Panel settings and themes | Production | Keep |
|
||||
| [`status`](status.md) | Status page | Experimental / alpha | Rewrite / Deprecate |
|
||||
| [`steam_workshop`](steam_workshop.md) | Legacy Workshop module | Deprecated | Deprecate / Merge |
|
||||
| [`subusers`](subusers.md) | Subuser permissions | Functional | Keep / Improve |
|
||||
| [`support`](support.md) | Support landing page | Functional | Keep / Merge with tickets workflow |
|
||||
| [`teamspeak3`](teamspeak3.md) | Teamspeak 3 web interface | Functional if sold | Keep or hide based on product line |
|
||||
| [`tickets`](tickets.md) | Support ticket system | Production / functional | Keep / Improve |
|
||||
| [`tshock`](tshock.md) | Terraria/TShock utilities | Alpha / partial | Keep conditional / Improve |
|
||||
| [`update`](update.md) | Panel update tooling | Production / admin-only | Keep |
|
||||
| [`user_admin`](user_admin.md) | User management | Production | Keep / Improve |
|
||||
| [`user_games`](user_games.md) | Server provisioning and assignment | Production / functional | Keep / Improve |
|
||||
| [`util`](util.md) | Miscellaneous utility tools | Functional / mixed | Keep / Rewrite selectively |
|
||||
|
||||
## Dependency Notes
|
||||
## Shared Dependencies
|
||||
|
||||
Common dependencies across many modules:
|
||||
|
||||
- `includes/lib_remote.php`
|
||||
- `Panel/includes/lib_remote.php`
|
||||
- auth/session and role checks
|
||||
- `config_games` XML parsing
|
||||
- DB access helpers
|
||||
- database access helpers
|
||||
- server home and IP/port records
|
||||
|
||||
## High-Value Modules
|
||||
|
|
@ -65,4 +65,3 @@ The modules most likely to matter in future investigations are:
|
|||
8. `billing`
|
||||
9. `tickets`
|
||||
10. `subusers`
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue