pterodactyl_ynh/README.md

89 lines
3.6 KiB
Markdown
Raw Normal View History

2020-06-20 04:39:08 -04:00
# Pterodactyl for YunoHost
2019-01-02 05:26:13 -05:00
2020-06-20 04:39:08 -04:00
![](https://ci-apps.yunohost.org/ci/badges/pterodactyl.maintain.svg) ![](https://ci-apps.yunohost.org/ci/badges/pterodactyl.status.svg) [![Integration level](https://dash.yunohost.org/integration/pterodactyl.svg)](https://dash.yunohost.org/appci/app/pterodactyl)
2019-01-02 05:26:13 -05:00
[![Install Pterodactyl with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=pterodactyl)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allow you to install Pterodactyl quickly and simply on a YunoHost server.
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
2020-06-20 04:39:08 -04:00
## 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.
2021-03-06 03:08:39 -05:00
**Shipped version:** 1.2.2
## Screenshots
![](https://pterodactyl.io/frontpage/mockup-macbook-grey.png)
## Demo
* [Pterodactyl demo](https://demo.pterodactyl.io/)
2020-06-20 04:39:08 -04:00
Please note this is the official Pterodactyl demo, this demo is **not** hosted on a YunoHost server.
2019-01-02 05:26:13 -05:00
### Installing guide
This app can be installed by YunoHost **admin web-interface** or by **running following command**:
2019-01-02 05:26:13 -05:00
$ sudo yunohost app install https://github.com/YunoHost-Apps/pterodactyl_ynh
2019-02-21 11:46:46 -05:00
After install :
2019-02-21 12:00:47 -05:00
1. Login in panel
2. Create Location
2019-02-21 11:58:38 -05:00
3. Create Node
4. Copy configuration node for the core.json
5. Edit the core.json
2019-02-21 12:12:24 -05:00
$ sudo nano /srv/daemon/config/core.json
2019-02-21 11:58:38 -05:00
6. For SSL change folder location for SSL Certificate & SSL Key
2019-02-21 12:00:27 -05:00
$ /etc/yunohost/certs/yourDomain.tld/crt.pem = SSL Certificate
$ /etc/yunohost/certs/yourDomain.tld/key.pem = SSL Key
2019-02-21 11:58:38 -05:00
7. Start wings service
2019-02-21 12:00:27 -05:00
$ sudo systemctl start wings
2019-01-02 05:26:13 -05:00
### Upgrade this package:
2019-01-02 13:47:00 -05:00
$ sudo yunohost app upgrade pterodactyl -u https://github.com/YunoHost-Apps/pterodactyl_ynh
2019-01-02 05:26:13 -05:00
## Documentation
2020-06-20 04:39:08 -04:00
* 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
2020-06-20 04:39:08 -04:00
As Pterodactyl do not support LDAP for now [#594](https://github.com/pterodactyl/panel/issues/594), this app will not be synced with YunoHost users.
#### Supported architectures
2020-06-20 04:39:08 -04:00
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/pterodactyl%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/pterodactyl/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/pterodactyl%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/pterodactyl/)
## 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/
---
2021-03-06 03:08:39 -05:00
## Developers info
Please do 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.
```
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
```