pelican_ynh/README.md

Pterodactyl for YunoHost

Lire ce readme en français.

This package allow you to install Pterodactyl quickly and simply on a YunoHost server.
If you don't have YunoHost, please see here to know how to install and enjoy it.

Overview

Pterodactyl is the open-source game server management panel built with PHP7, Nodejs, and Go. Designed with security in mind, Pterodactyl runs all game servers in isolated Docker containers while exposing a beautiful and intuitive UI to administrators and users. Stop wasting time fiddling with other systems — make game servers a first class citizen on your platform.

Shipped version: 0.7.12

Screenshots

Demo

• Pterodactyl demo Please note this is the official Pterodactyl demo, this demo is not hosted on a YunoHost server.

Installing guide

This app can be installed by YunoHost admin web-interface or by running following command:

     $ sudo yunohost app install https://github.com/YunoHost-Apps/pterodactyl_ynh
     
     After install :
     
     1. Login in panel
     2. Create Location
     3. Create Node
     4. Copy configuration node for the core.json
     5. Edit the core.json
     $ sudo nano /srv/daemon/config/core.json
     6. For SSL change folder location for SSL Certificate & SSL Key
     $ /etc/yunohost/certs/yourDomain.tld/crt.pem = SSL Certificate
     $ /etc/yunohost/certs/yourDomain.tld/key.pem = SSL Key
     7. Start wings service
     $ sudo systemctl start wings

Upgrade this package:

    $ sudo yunohost app upgrade pterodactyl -u https://github.com/YunoHost-Apps/pterodactyl_ynh

Documentation

• Official documentation: https://pterodactyl.io/project/introduction.html
• YunoHost documentation: If specific documentation is needed, feel free to contribute.

YunoHost specific features

Multi-users support

As Pterodactyl do not support LDAP for now #594, this app will not be synced with YunoHost users.

Supported architectures

• x86-64 -
• ARMv8-A -

Limitations

• LDAP not working by now
• You'll need to manually open some ports if you want to have more than one daemon running.

Links

• Report a bug: https://github.com/YunoHost-Apps/pterodactyl_ynh/issues
• App website: https://pterodactyl.io
• Upstream app repository: https://github.com/pterodactyl/
• YunoHost website: https://yunohost.org/

---

Developers info

Please do your pull request to the develop branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/pterodactyl_ynh/tree/develop --debug
or
sudo yunohost app upgrade pterodactyl -u https://github.com/YunoHost-Apps/pterodactyl_ynh/tree/develop --debug