Skip to content

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

License

Notifications You must be signed in to change notification settings

ysdragon/Pterodactyl-VPS-Egg

Repository files navigation

Pterodactyl VPS Egg

License CodeFactor

A powerful and lightweight Virtual Private Server (VPS) egg for Pterodactyl Panel, supporting multiple architectures and operating systems.

✨ Features

  • 🚀 Easy deployment and management
  • 🔧 Customizable configurations
  • 🔄 Multiple architecture support
  • 🖥️ Wide range of operating systems
  • 🔌 Multiple port support (TCP/UDP)
    • Dynamic port mapping
  • 🚀 Custom SSH server

🏗️ Supported Architectures

Architecture Status Notes
amd64 ✅ Full Support Recommended for most users
arm64 ✅ Full Support Ideal for ARM-based servers
riscv64 ⚠️ Limited Support Requires custom rootfs images

Important

For riscv64 architecture, you must provide or host your own rootfs images. Currently, only Chimera Linux offers native support for riscv64 in this egg.

Available Linux Distributions

Enterprise Linux

  • Rocky Linux
  • AlmaLinux
  • CentOS
  • Oracle Linux

Debian-based

  • Ubuntu
  • Debian
  • Kali Linux
  • Devuan Linux

Other Distributions

  • Alpine Linux
  • Arch Linux
  • Gentoo Linux
  • Void Linux
  • Slackware Linux
  • openSUSE
  • Fedora
  • Chimera Linux
  • Amazon Linux
  • Plamo Linux
  • Linux Mint
  • Alt Linux
  • openEuler

🚀 Quick Start

  1. Download the Egg

    • Download the egg-vps.json configuration file to your local machine.
  2. Import to Pterodactyl

    • Navigate to the Admin Panel
    • Go to Nests > Import Egg
    • Upload the egg-vps.json file
    • Configure as needed
  3. Deploy Your VPS

    • Create a new server using the VPS egg
    • Configure resources
    • Start your instance

How to use SSH?

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 and supports the following options:

  • SSH_PORT: The port on which the SSH server will listen. The default is 2222.
  • SSH_USER: The username for SSH authentication.
  • SSH_PASSWORD: The password for SSH authentication.
  • SSH_TIMEOUT: The timeout duration in seconds for SSH connections. Leave it empty or set it to 0 to disable the timeout.
  • SFTP_ENABLE: Enable or disable SFTP. Set to true to enable SFTP.

Example /.ssh_config Configuration

Here is an example configuration file:

SSH_PORT=50000
SSH_USER=user
SSH_PASSWORD=123123
SSH_TIMEOUT=0
SFTP_ENABLE=true

Contributing

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

License

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

About

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

Topics

Resources

License

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •