Pterodactyl VPS Egg

A powerful and lightweight Virtual Private Server (VPS) egg for Pterodactyl Panel

Supporting multiple architectures and 20+ Linux distributions

📋 Quick Start • 🔧 Commands • 🔐 SSH Setup • 🖥️ GUI/VNC Setup • 🤝 Contributing

---

✨ Features

• 🚀 Easy Deployment - One-click installation and setup
• 🔧 Customizable - Flexible configurations for various use cases
• 🏗️ Multi-Architecture - Support for AMD64, ARM64, and RISCV64
• 🐧 20+ Linux Distros - Wide range of operating systems supported
• 🔌 Port Management - TCP/UDP support with dynamic port mapping
• 🖥️ GUI/Remote Desktop - VNC server with browser access via noVNC

🏗️ Supported Architectures

Architecture	Status	Notes
amd64	✅ Full Support	Recommended for most users
arm64	✅ Full Support	Ideal for ARM-based servers
riscv64	✅ Full Support	Ideal for RISCV-based servers

Note

This egg supports most rootfs images for the riscv64 architecture, including native support for Chimera Linux.

Available Linux Distributions

• Rocky Linux
• AlmaLinux
• CentOS
• Oracle Linux
• Ubuntu
• Debian
• Kali Linux
• Devuan Linux
• Alpine Linux
• Arch Linux
• Gentoo Linux
• Void Linux
• Slackware Linux
• openSUSE
• Fedora
• Chimera Linux
• Amazon Linux
• Plamo Linux
• Linux Mint
• Alt Linux
• Funtoo Linux
• openEuler
• Springdale Linux

🚀 Quick Start

📥 Installation

1. Download the Egg

   • Download the egg-vps.json configuration file from this repository.

2. Import to Pterodactyl

   • Navigate to your Pterodactyl Admin Panel
   • Go to Nests > Import Egg
   • Upload the egg-vps.json file
   • Configure the egg settings as needed

3. Deploy Your VPS

   • Create a new server using the VPS egg
   • Configure system resources (RAM, CPU, Disk, etc.)
   • Start your instance

🖥️ First Steps

Once your VPS is running:

1. Access the Console - Use the Pterodactyl web console to interact with your VPS
2. Run help - View all available custom commands
3. Customize Settings - Configure your environment as needed

🔧 Available Custom Commands

The VPS egg includes several built-in commands to help you manage your server:

Command	Description	Usage
help	Display available commands	help
clear / cls	Clear the screen	clear or cls
exit	Shutdown the server	exit
history	Show command history	history
reinstall	Reinstall the operating system	reinstall
install-ssh	Install the custom SSH server	install-ssh
status	Show system status information	status
backup	Create a system backup	backup
restore	Restore a system backup	restore <backup_file>
install-gui	Install desktop environment + VNC server	install-gui
start-vnc	Start the VNC server	start-vnc
stop-vnc	Stop the VNC server	stop-vnc
start-novnc	Start noVNC for browser access	start-novnc
stop-novnc	Stop noVNC	stop-novnc
start-tunnel	Start Cloudflare tunnel (public URL)	start-tunnel
stop-tunnel	Stop Cloudflare tunnel	stop-tunnel
gui-status	Show GUI server status	gui-status

Note

All commands are available immediately after the server starts. Use help to view this list anytime.

Warning

The reinstall command will completely wipe all data on the server. Use with caution.

🔐 SSH Configuration

Install the Custom SSH Server:

• After installing the desired distro, use the install-ssh command to install our custom SSH server.

Configuration Options

The configuration file is located at /ssh_config.yml and supports the following options:

SSH Options

Option	Description	Default
port	Port number for SSH server	2222
user	Username for SSH authentication	root
password	Password for SSH authentication (supports plain text, bcrypt hash, or argon2 hash)	password
timeout	Connection timeout in seconds (comment out or set to 0 to disable)	300

SFTP Options

Option	Description	Default
enable	Enable or disable SFTP support	true

Note

The timeout setting is optional and can be omitted from the configuration.

Warning

The default password "password" is insecure and MUST be changed immediately after installation for security reasons.

Example /ssh_config.yml Configuration

Here is an example configuration file:

ssh:
  port: "2222"
  user: "root"
  password: "password"
  # timeout: 30

sftp:
  enable: true

🖥️ GUI/Remote Desktop Configuration

The VPS egg supports full GUI/remote desktop functionality with VNC server and browser-based access via noVNC.

Install the Desktop Environment:

• After installing the desired distro, use the install-gui command to install a desktop environment and VNC server.

Available Desktop Environments

Desktop Environment	Description	Approximate Size
XFCE4	Lightweight and full-featured	~200MB
LXDE	Very lightweight	~100MB
LXQt	Modern lightweight Qt-based	~150MB
MATE	Traditional desktop experience	~300MB

Supported Distributions for GUI

Distribution	Status
Debian/Ubuntu/Kali/Devuan/Linux Mint	✅ Full Support
Alpine/Chimera	✅ Full Support
Arch Linux	✅ Full Support
Fedora	✅ Full Support
Void Linux	✅ Full Support
CentOS/Rocky/AlmaLinux/Oracle Linux	❌ Not Supported
openSUSE	❌ Not Supported

Configuration Options

The configuration file is located at /gui_config.yml and is automatically created during installation:

Desktop Options

Option	Description	Default
environment	Selected desktop environment	User selected
startup_command	Command to start the DE	Auto-detected

VNC Options

Option	Description	Default
port	Port number for VNC server	5901
password	Password for VNC authentication	User defined
resolution	Screen resolution	1280x720
depth	Color depth	24

noVNC Options

Option	Description	Default
enable	Enable noVNC web access	true
port	Port number for noVNC web interface	6080

Note

Remember to configure the VNC and noVNC ports in your Pterodactyl panel allocations!

Warning

The default VNC password should be changed immediately after installation for security reasons.

Example /gui_config.yml Configuration

Here is an example configuration file:

desktop:
  environment: "xfce4"
  startup_command: "startxfce4"

vnc:
  port: "5901"
  password: "your_secure_password"
  resolution: "1280x720"
  depth: "24"

novnc:
  enable: true
  port: "6080"

Accessing Your Desktop

1. Via VNC Client: Connect to <server-ip>:<vnc_port> using any VNC client
2. Via Browser (noVNC): Navigate to http://<server-ip>:<novnc_port> in your web browser
3. Via Cloudflare Tunnel: Use start-tunnel for a public URL (useful when behind NAT)

🤝 Contributing

Contributions are welcome! If you have any suggestions, improvements, or bug fixes, feel free to submit a pull request or open an issue.

How to Contribute

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

This project is open-source and available under the MIT License. See the LICENSE file for more details.