https://github.com/ysdragon/pterodactyl-vps-egg
A powerful and lightweight Virtual Private Server (VPS) egg for Pterodactyl/Pelican Panel
https://github.com/ysdragon/pterodactyl-vps-egg
pelican pelican-panel pterodactyl pterodactyl-egg pterodactyl-panel vps
Last synced: about 2 months ago
JSON representation
A powerful and lightweight Virtual Private Server (VPS) egg for Pterodactyl/Pelican Panel
- Host: GitHub
- URL: https://github.com/ysdragon/pterodactyl-vps-egg
- Owner: ysdragon
- License: mit
- Created: 2021-07-08T04:54:34.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-04T12:08:24.000Z (3 months ago)
- Last Synced: 2025-03-29T03:02:36.465Z (2 months ago)
- Topics: pelican, pelican-panel, pterodactyl, pterodactyl-egg, pterodactyl-panel, vps
- Language: Shell
- Homepage:
- Size: 124 KB
- Stars: 103
- Watchers: 8
- Forks: 58
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pterodactyl VPS Egg
[](https://github.com/ysdragon/Pterodactyl-VPS-Egg/blob/main/LICENSE)
[](https://www.codefactor.io/repository/github/ysdragon/pterodactyl-vps-egg)
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
- 
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
## 🚀 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.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 or bcrypt 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.
### Example `/ssh_config.yml` Configuration
Here is an example configuration file:
```yml
ssh:
port: "2222"
user: "root"
password: "password"
# timeout: 30
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](https://github.com/ysdragon/Pterodactyl-VPS-Egg/blob/main/LICENSE) file for more details.