From 4bc446f446f644b43951c6e267f2fa95582ec545 Mon Sep 17 00:00:00 2001 From: OpenSource Date: Wed, 24 Aug 2022 05:26:56 +0000 Subject: [PATCH] GitBook: [#77] Docker support --- SUMMARY.md | 4 ++- overview/adding-pre-defined-plugins.md | 17 ++++++++++ .../README.md} | 4 +-- overview/installation/docker-support.md | 32 +++++++++++++++++++ 4 files changed, 54 insertions(+), 3 deletions(-) create mode 100644 overview/adding-pre-defined-plugins.md rename overview/{installation.md => installation/README.md} (98%) create mode 100644 overview/installation/docker-support.md diff --git a/SUMMARY.md b/SUMMARY.md index 6982808..c0f31da 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -3,13 +3,15 @@ ## 📘 Overview * [🖥 PlayerServers - Overview](README.md) -* [🚀 Plugin Installation Tutorial](overview/installation.md) +* [🚀 Plugin Installation Tutorial](overview/installation/README.md) + * [🛳 Docker support](overview/installation/docker-support.md) * [📜 Current Config files](overview/config.md) * [🚫 Limitations](overview/limitations/README.md) * [Permission-based RAM](overview/limitations/permission-based-ram.md) * [Permission-based CPU](overview/limitations/permission-based-ram-1.md) * [Max players limitation](overview/limitations/max-players-limitation.md) * [Max plugins limitation](overview/limitations/max-plugins-limitation.md) +* [📦 Adding pre-defined plugins](overview/adding-pre-defined-plugins.md) *** diff --git a/overview/adding-pre-defined-plugins.md b/overview/adding-pre-defined-plugins.md new file mode 100644 index 0000000..3011fe7 --- /dev/null +++ b/overview/adding-pre-defined-plugins.md @@ -0,0 +1,17 @@ +--- +description: >- + In the tutorial below, you'll learn how to add pre-defined plugins to the + plugin-installer GUI. +--- + +# 📦 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. + +After that, put the .jar files of all the plugins you want your players to be able to install on their sub-servers. + +{% hint style="warning" %} +WARNING: Please do not put in too much plugins. **You should not have more than 45 plugins available there.** The plugin may handle more, but it is not recommended. + +The maximum of allowed plugins is: **75**, and after that number, the plugin will most likely break and not function properly. _Please kindly note that I **will not** support anyone that is adding more than 45 plugins to this directory._ +{% endhint %} diff --git a/overview/installation.md b/overview/installation/README.md similarity index 98% rename from overview/installation.md rename to overview/installation/README.md index b88d081..80e0c80 100644 --- a/overview/installation.md +++ b/overview/installation/README.md @@ -55,8 +55,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 usign 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/creating-mysql-database.md" %} -[creating-mysql-database.md](../legacy/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. diff --git a/overview/installation/docker-support.md b/overview/installation/docker-support.md new file mode 100644 index 0000000..73c3da5 --- /dev/null +++ b/overview/installation/docker-support.md @@ -0,0 +1,32 @@ +--- +description: >- + Since PlayerServers v3, we now offer Docker support as well for those that + care about security and network isolation of their subservers. +--- + +# 🛳 Docker support + +## Introduction + +Docker adds a secure isolation layer to your PlayerServers, so you can safely allow players to install all sorts of plugins without being afraid of them breaking something. + +## Tutorial + +### Docker installation + +For a quick install of Docker CE, you can execute the command below: + +```bash +curl -sSL https://get.docker.com/ | CHANNEL=stable bash +``` + +### Setup + +After successfully installing docker, you can enable docker support inside your config.yml. + +{% code title="Config.yml" overflow="wrap" lineNumbers="true" %} +```yaml +docker: + enabled: true +``` +{% endcode %}