File transfer
This commit is contained in:
83
README.md
83
README.md
@@ -1,7 +1,82 @@
|
||||
# Pterodactyl Addon
|
||||
# Pterodactyl Advanced Admin Addons
|
||||
|
||||
A custom addon for the Pterodactyl Panel.
|
||||
> **Author:** Ball Studios
|
||||
> **Repository:** https://git.balls.studio/BallStudios/pterodactyl_addon
|
||||
> **License:** MIT
|
||||
> **Target:** Pterodactyl Panel v1.12.4 + Wings latest stable
|
||||
|
||||
## Setup
|
||||
A production-ready, modular addon suite for Pterodactyl Panel adding four major features:
|
||||
|
||||
_Coming soon._
|
||||
| Module | Description |
|
||||
|--------|-------------|
|
||||
| 🌐 **Network Traffic Dashboard** | Real-time + historical traffic, port breakdown, container flow graph |
|
||||
| 🔐 **Role-Based Server Permissions** | Reusable roles with full deny/allow resolution, server-level overrides |
|
||||
| 📝 **File Revision History** | Compressed file diffs, restore, diff viewer, audit log |
|
||||
| ⌨️ **Console Command Autocomplete** | Minecraft command library, live player tracking, custom definitions |
|
||||
|
||||
---
|
||||
|
||||
## ⚡ One-Line Install
|
||||
|
||||
Run this as **root** on your Pterodactyl server:
|
||||
|
||||
```bash
|
||||
bash <(curl -fsSL https://git.balls.studio/BallStudios/pterodactyl_addon/raw/branch/main/install.sh)
|
||||
```
|
||||
|
||||
With a custom panel path (if not `/var/www/pterodactyl`):
|
||||
|
||||
```bash
|
||||
bash <(curl -fsSL https://git.balls.studio/BallStudios/pterodactyl_addon/raw/branch/main/install.sh) /path/to/pterodactyl
|
||||
```
|
||||
|
||||
### Update
|
||||
|
||||
```bash
|
||||
bash <(curl -fsSL https://git.balls.studio/BallStudios/pterodactyl_addon/raw/branch/main/update.sh)
|
||||
```
|
||||
|
||||
### Uninstall
|
||||
|
||||
```bash
|
||||
bash <(curl -fsSL https://git.balls.studio/BallStudios/pterodactyl_addon/raw/branch/main/uninstall.sh)
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> The installer backs up all patched core files before making any changes. The backup path is printed at the end of installation.
|
||||
|
||||
---
|
||||
|
||||
## Manual Install
|
||||
|
||||
If you prefer manual control, see [docs/INSTALL.md](docs/INSTALL.md) for step-by-step instructions.
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Installation Guide](docs/INSTALL.md)
|
||||
- [Update Guide](docs/UPDATE.md)
|
||||
- [Uninstall Guide](docs/UNINSTALL.md)
|
||||
- [Configuration Reference](docs/CONFIG.md)
|
||||
- [API Reference](docs/API.md)
|
||||
- [Security Notes](docs/SECURITY.md)
|
||||
- [Troubleshooting](docs/TROUBLESHOOTING.md)
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
| Requirement | Version |
|
||||
|---|---|
|
||||
| Pterodactyl Panel | v1.12.x |
|
||||
| PHP | 8.1+ |
|
||||
| Node.js | 22.x |
|
||||
| Yarn | 1.x |
|
||||
| MySQL/MariaDB | 8.0+ / 10.4+ |
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
MIT © Ball Studios — https://git.balls.studio
|
||||
|
||||
Reference in New Issue
Block a user