47 lines
2.1 KiB
Markdown
47 lines
2.1 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# Pterodactyl for YunoHost
|
|
|
|
[](https://ci-apps.yunohost.org/ci/apps/pterodactyl/)  
|
|
|
|
[](https://install-app.yunohost.org/?app=pterodactyl)
|
|
|
|
*[Read this README in other languages.](./ALL_README.md)*
|
|
|
|
> *This package allows you to install Pterodactyl quickly and simply on a YunoHost server.*
|
|
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
|
|
|
|
## Overview
|
|
|
|
Pterodactyl® is a free, open-source game server management panel built with PHP, React, and Go. Designed with security in mind, Pterodactyl runs all game servers in isolated Docker containers while exposing a beautiful and intuitive UI to end users.
|
|
|
|
**Shipped version:** 1.11.7~ynh1
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Documentation and resources
|
|
|
|
- Official app website: <https://pterodactyl.io/>
|
|
- Official admin documentation: <https://pterodactyl.io/project/introduction.html>
|
|
- Upstream app code repository: <https://github.com/pterodactyl/panel>
|
|
- YunoHost Store: <https://apps.yunohost.org/app/pterodactyl>
|
|
- Report a bug: <https://github.com/YunoHost-Apps/pterodactyl_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/pterodactyl_ynh/tree/testing).
|
|
|
|
To try the `testing` branch, please proceed like that:
|
|
|
|
```bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/pterodactyl_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade pterodactyl -u https://github.com/YunoHost-Apps/pterodactyl_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|