GITBOOK-90: Node creation guide
This commit is contained in:
OpenSource
gitbook-bot
parent
a24100424b
commit
60ad2858d6
BIN
.gitbook/assets/PlayerServersDaemon (1).jar
Normal file
BIN
.gitbook/assets/PlayerServersDaemon (1).jar
Normal file
Binary file not shown.
BIN
.gitbook/assets/PlayerServersDaemon v3.1-beta5.zip
Normal file
BIN
.gitbook/assets/PlayerServersDaemon v3.1-beta5.zip
Normal file
Binary file not shown.
Binary file not shown.
53
SUMMARY.md
53
SUMMARY.md
@ -4,11 +4,12 @@
|
||||
|
||||
* [🖥 PlayerServers - Overview](README.md)
|
||||
* [🚀 Plugin Installation Tutorial](overview/installation/README.md)
|
||||
* [🛳 Adding a node](overview/installation/adding-a-node.md)
|
||||
* [🎁 Templates](overview/installation/templates.md)
|
||||
* [📦 Adding pre-defined plugins](overview/installation/adding-pre-defined-plugins.md)
|
||||
* [🌐 Pterodactyl configuration](overview/pterodactyl-configuration/README.md)
|
||||
* [Download custom wings](overview/pterodactyl-configuration/download-custom-wings.md)
|
||||
* [How to create tokens](overview/pterodactyl-configuration/how-to-create-tokens.md)
|
||||
* [🌐 Pterodactyl configuration](overview/installation/pterodactyl-configuration.md)
|
||||
* [🕊 Download custom wings](overview/pterodactyl-configuration/download-custom-wings.md)
|
||||
* [🔓 How to create tokens](overview/pterodactyl-configuration/how-to-create-tokens.md)
|
||||
* [📜 Current Config files](overview/config.md)
|
||||
* [🚫 Limitations](overview/limitations/README.md)
|
||||
* [Permission-based RAM](overview/limitations/permission-based-ram.md)
|
||||
@ -18,30 +19,30 @@
|
||||
|
||||
***
|
||||
|
||||
* [👵 Legacy (v2.x)](legacy-v2.x/README.md)
|
||||
* [Updates](legacy-v2.x/updates/README.md)
|
||||
* [PlayerServers - General](legacy-v2.x/updates/master.md)
|
||||
* [v1.1 to v1.2](legacy-v2.x/updates/v1.1-to-v1.2.md)
|
||||
* [8.0 to v1.0](legacy-v2.x/updates/8.0-to-v1.0.md)
|
||||
* [5.0 to 6.0](legacy-v2.x/updates/5.0-to-6.0.md)
|
||||
* [3.7-D to 4.0](legacy-v2.x/updates/update1.md)
|
||||
* [Basic instructions](legacy-v2.x/basic-instructions.md)
|
||||
* [Plugin management](legacy-v2.x/plugin-management.md)
|
||||
* [Plugin Installation Tutorial](legacy-v2.x/installation.md)
|
||||
* [Editing config files](legacy-v2.x/editing-config-files.md)
|
||||
* [Current Config & Messages File](legacy-v2.x/config.md)
|
||||
* [Permissions & Commands](legacy-v2.x/permissions-and-commands.md)
|
||||
* [Limitations](legacy-v2.x/limitations/README.md)
|
||||
* [Permission-based RAM](legacy-v2.x/limitations/permission-based-ram.md)
|
||||
* [Max players limitation](legacy-v2.x/limitations/max-players-limitation.md)
|
||||
* [Max plugins limitation](legacy-v2.x/limitations/max-plugins-limitation.md)
|
||||
* [Adding pre-defined plugins](legacy-v2.x/adding-pre-defined-plugins.md)
|
||||
* [Creating MySQL database](legacy-v2.x/creating-mysql-database.md)
|
||||
* [Additional Tutorials (FAQ)](legacy-v2.x/additional-tutorials-faq.md)
|
||||
* [Screen (accessing consoles)](legacy-v2.x/screen.md)
|
||||
* [👵 Legacy (v2.x)](legacy/README.md)
|
||||
* [Updates](legacy/updates/README.md)
|
||||
* [PlayerServers - General](legacy/updates/master.md)
|
||||
* [v1.1 to v1.2](legacy/updates/v1.1-to-v1.2.md)
|
||||
* [8.0 to v1.0](legacy/updates/8.0-to-v1.0.md)
|
||||
* [5.0 to 6.0](legacy/updates/5.0-to-6.0.md)
|
||||
* [3.7-D to 4.0](legacy/updates/update1.md)
|
||||
* [Basic instructions](legacy/basic-instructions.md)
|
||||
* [Plugin management](legacy/plugin-management.md)
|
||||
* [Plugin Installation Tutorial](legacy/installation.md)
|
||||
* [Editing config files](legacy/editing-config-files.md)
|
||||
* [Current Config & Messages File](legacy/config.md)
|
||||
* [Permissions & Commands](legacy/permissions-and-commands.md)
|
||||
* [Limitations](legacy/limitations/README.md)
|
||||
* [Permission-based RAM](legacy/limitations/permission-based-ram.md)
|
||||
* [Max players limitation](legacy/limitations/max-players-limitation.md)
|
||||
* [Max plugins limitation](legacy/limitations/max-plugins-limitation.md)
|
||||
* [Adding pre-defined plugins](legacy/adding-pre-defined-plugins.md)
|
||||
* [Creating MySQL database](legacy/creating-mysql-database.md)
|
||||
* [Additional Tutorials (FAQ)](legacy/additional-tutorials-faq.md)
|
||||
* [Screen (accessing consoles)](legacy/screen.md)
|
||||
* [Screen (advanced)](https://linuxize.com/post/how-to-use-linux-screen/)
|
||||
* [Templates](legacy-v2.x/templates.md)
|
||||
* [Multi-Node Support](legacy-v2.x/multi-node-support.md)
|
||||
* [Templates](legacy/templates.md)
|
||||
* [Multi-Node Support](legacy/multi-node-support.md)
|
||||
* [Unofficial Video Tutorial](https://www.youtube.com/watch?v=VApcwAG4y5c)
|
||||
* [MC-Market Thread](https://www.mc-market.org/threads/583445/#post-4508558)
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ description: >-
|
||||
PlayerServers (older than v3)
|
||||
---
|
||||
|
||||
# 👵 Legacy
|
||||
# 👵 Legacy (v2.x)
|
||||
|
||||
{% content-ref url="../" %}
|
||||
[..](../)
|
||||
@ -1,7 +1,7 @@
|
||||
# 📜 Current Config files
|
||||
|
||||
{% hint style="info" %}
|
||||
The below page explains how to use this feature on PlayerServers 3. This is only relevant if you're a beta tester. To view this page for PlayerServers 3, click [here.](../legacy-v2.x/config.md)
|
||||
The below page explains how to use this feature on PlayerServers 3. This is only relevant if you're a beta tester. To view this page for PlayerServers 3, click [here.](../legacy/config.md)
|
||||
{% endhint %}
|
||||
|
||||
Below you can see the contents of the newest BungeeCord PlayerServers configuration file.
|
||||
|
||||
@ -22,9 +22,9 @@ Operating Systems marked with ⛔️ are currently not supported at all, but the
|
||||
| **Ubuntu** | <p>18.04</p><p>(Bionic)</p> | ✅ | The plugin was tested on this OS and confirmed to have no issues. |
|
||||
| **Ubuntu** | 16.04 | ⚠️ | Untested, but the plugin should work |
|
||||
| **Debian** | <p>9</p><p>10</p><p>11</p> | ✅ | <p>Tested, the plugin worked but the instructions from this guide might be invalid for that OS.</p><p></p><p>Some additional repos might be required.</p> |
|
||||
| **Debian** | <p>9<br>8</p> | ⚠️ | Untested, additional repos may be required |
|
||||
| **CentOS** | 7 & 8 | ⚠️ | **Not tested**, though we had reports of centOS working without any issues. |
|
||||
| **Windows** | <p>Server 2016</p><p>Server 2019</p><p>Server 2022</p><p>10</p><p>11</p> | ❌❓ | <p><strong>Tested, not working.</strong> It <strong>may</strong> work though, by installing Ubuntu subsystem for Windows. </p><p></p><p>You can find more tutorials about that on Youtube.</p> |
|
||||
| **Debian** | 8 | ⚠️ | Untested, additional repos may be required |
|
||||
| **CentOS** | 7 & 8 | ⚠️ | **Not tested**, though we had reports of centOS working without any issues and we do not see any reason for it not to work there. |
|
||||
| **Windows** | <p>Server 2016</p><p>Server 2019</p><p>Server 2022</p><p>10</p><p>11</p> | ✅ | <p><strong>Tested, works perfectly.</strong><br><strong></strong><br><strong></strong>PlayerServers v3+ introduced the full Windows support by using Docker for instance management</p> |
|
||||
| **MacOS** | <p>Mojave</p><p>Catalina</p><p>Big Sur</p><p>Monterey<br>Ventura</p> | ✅ | <p>Should work without any problems as it comes with</p><p>screen & fuser pre-installed. <br><br>Tested on M1 processors as well. On M1 machines, ARM JVM like Azul Zulu is highly recommended.</p> |
|
||||
|
||||
## Requirements
|
||||
@ -49,8 +49,8 @@ After the first boot of the server, you will see some errors generated by the pl
|
||||
|
||||
Now navigate to the `plugins folder -> PlayerServers` and open up the config.yml file. It is recommended to open it using some sort of advanced text editor (like [Notepad++](https://notepad-plus-plus.org) or [VisualStudio Code](https://code.visualstudio.com)). After that, you will have to enter your MySQL informations. If you don't have a MySQL server running already, please follow the link below.
|
||||
|
||||
{% content-ref url="../../legacy-v2.x/creating-mysql-database.md" %}
|
||||
[creating-mysql-database.md](../../legacy-v2.x/creating-mysql-database.md)
|
||||
{% content-ref url="../../legacy/creating-mysql-database.md" %}
|
||||
[creating-mysql-database.md](../../legacy/creating-mysql-database.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
After the configuration of MySQL database, boot up your BungeeCord server. The plugin should successfully launch this time.
|
||||
|
||||
50
overview/installation/adding-a-node.md
Normal file
50
overview/installation/adding-a-node.md
Normal file
@ -0,0 +1,50 @@
|
||||
---
|
||||
description: Learn how to create a node for servers to be deployed to.
|
||||
---
|
||||
|
||||
# 🛳 Adding a node
|
||||
|
||||
## Introduction
|
||||
|
||||
In order to create subservers, you need to have nodes configured. Each node can have a configurable amount of servers running at the same time. A node can be the same machine that you host your BungeeCord on, or any other machine connected to the internet.
|
||||
|
||||
## Instructions
|
||||
|
||||
### Download Daemon
|
||||
|
||||
In order to create a node, you'll need to download the latest Daemon.
|
||||
|
||||
{% file src="../../.gitbook/assets/PlayerServersDaemon v3.1-beta5.zip" %}
|
||||
Download the latest daemon
|
||||
{% endfile %}
|
||||
|
||||
After downloading it, put it in a separate folder and extract it, preferably **out** of your BungeeCord folder. This is not a plugin, but a separate software made for handling server requests.
|
||||
|
||||
Now run the Daemon with the following command:
|
||||
|
||||
{% code title="Command to start Daemon" %}
|
||||
```sh
|
||||
java -Xmx500M -jar PlayerServeshersDaemon.jar
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
After running it, type `exit` to stop your Daemon.
|
||||
|
||||
Now, edit your config.toml generated inside Daemon folder to your preference and make sure to use the same token as in config.toml when creating a new node.
|
||||
|
||||
### Create node in-game
|
||||
|
||||
The last step would be to add the node to PlayerServers. To do so, type the following command:
|
||||
|
||||
{% code overflow="wrap" %}
|
||||
```sh
|
||||
/psadmin node create <nodename> <ip> <port> <minPort> <maxPort> <maxOnline> <token>
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
* NodeName is any name you want to give to your node
|
||||
* IP is the ip of the machine the node is located on
|
||||
* Port is the port, configurable in config.toml of your Daemon.
|
||||
* MinPort and MaxPort represent the port range in which your servers are going to be created on. For example, if you put 30000 and 30100 as min and max port respectively, your servers will get a random port between those two numbers when created on this node.
|
||||
* MaxOnline is the max number of online instances at once on this node.
|
||||
* Token is the token configured in Daemon's config.toml
|
||||
@ -6,6 +6,6 @@ description: >-
|
||||
|
||||
# 📦 Adding pre-defined plugins
|
||||
|
||||
In order to add plugins to the plugin-installer GUI and make those plugins available to ALL of your players and their servers, you need to navigate to your BungeeCord plugins folder, than go to the PlayerServers folder, and from there, navigate to the `plugins-to-be-added-ingame` subfolder.
|
||||
In order to add plugins to the plugin-installer GUI and make those plugins available to all of your players and their servers, you need to navigate to your BungeeCord plugins folder, than go to the PlayerServers folder, and from there, navigate to the `server-plugins` subfolder.
|
||||
|
||||
After that, put the .jar files of all the plugins you want your players to be able to install on their sub-servers.
|
||||
|
||||
@ -9,28 +9,12 @@ description: Learn how to setup templates with plugins, mods, worlds and configu
|
||||
In PlayerServers, Templates are an essential way of managing the creation of your servers.
|
||||
|
||||
{% hint style="info" %}
|
||||
_At minimum you are required to have a default Template folder with Spigot.jar file inside. Without that, it will not be possible to create a subserver._
|
||||
_At minimum you are required to have a `default` Template folder with Spigot.jar file inside. Without that, it will not be possible to create a subserver._
|
||||
{% endhint %}
|
||||
|
||||
## Instructions
|
||||
|
||||
1. Create folder in /templates/\<yourtemplate>
|
||||
2. Put all the server files there INCLUDING Spigot.jar (do not include server.properties or spigot.yml)
|
||||
3. If the folder includes plugins, <mark style="color:yellow;">please do not include PSServerCore.jar or it's configuration files</mark>
|
||||
4. If your server includes plugins, please add all of them to plugins-to-be-installed-ingame folder
|
||||
5. Add your template to config.yml as in the following example:
|
||||
|
||||
```yaml
|
||||
templates:
|
||||
default:
|
||||
# Below you should add all the plugins from your template in the described format
|
||||
plugins:
|
||||
- EssentialsX-2.18.1.0.jar;Essentials;Provides an essential, core set of commands for Bukkit.
|
||||
```
|
||||
|
||||
**As you can see, the template is the following:** \
|
||||
<mark style="color:blue;">JarFileNameFromPluginsToBeInstalledIngameFolder</mark>;<mark style="color:yellow;">PluginNameFromPlugin.yml</mark>;<mark style="color:green;">Description</mark>
|
||||
|
||||
* <mark style="color:blue;">JarFileNameFromPluginsToBeInstalledIngameFolder</mark> - the name of the jar file from the plugins to be installed ingame folder (example: EssentialsX-2.18.1.0.jar)
|
||||
* <mark style="color:yellow;">PluginNameFromPlugin.yml</mark> - Find it by openning the plugin with WinRar, for example. Inside, you will see plugin.yml. Copy the plugin name from there
|
||||
* <mark style="color:green;">Description</mark> - As described in the previous step, there is also a plugin description in plugin.yml. Copy it in the description part. NOTE THAT NOT ALL THE PLUGINS CONTAIN DESCRIPTION. In that case, you can create a custom one.
|
||||
2. Put all the server files there **including Spigot.jar** (you must not include server.properties or spigot.yml)
|
||||
3. If the folder includes plugins, please do not include PSServerCore.jar or it's configuration files
|
||||
4. If your server includes plugins, please add all of them to the server-plugins folder
|
||||
|
||||
@ -4,7 +4,7 @@ description: >-
|
||||
your subservers.
|
||||
---
|
||||
|
||||
# Download custom wings
|
||||
# 🕊 Download custom wings
|
||||
|
||||
In order to make sure your players can't remove ServerCore from their servers and thus removing the only thing that will stop their server from being online 24/7, this modification is highly recommended.
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
description: Learn how to create Pterodactyl client and application API token.
|
||||
---
|
||||
|
||||
# How to create tokens
|
||||
# 🔓 How to create tokens
|
||||
|
||||
## Introduction
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user