diff --git a/folder/de/src/content/docs/about.mdx.mdx b/folder/de/src/content/docs/about.mdx.mdx new file mode 100644 index 0000000000..02c898354a --- /dev/null +++ b/folder/de/src/content/docs/about.mdx.mdx @@ -0,0 +1,65 @@ +--- +title: About Us +description: We're an administration wiki for Minecraft server administrators who are looking to enhance their server experience. +template: splash +--- + +We're building the ultimate Minecraft documentation project and if you're interested in making things even better this is the page for you. + +This page will be split up into three sections to help you get about: + + + +:::caution + +If you don't already have a Github account you will be required to make one before proceeding, you can create one at https://github.com/signup. + +::: + +### Submitting Ideas + +If you're an administrator looking for docs that we don't currently have information on then this is probably the section for you, it will explain how to raise a new Github issue with the information required for us to get the ball rolling with your request. + + + +Ensure you fill out the form with as much information as you can as this will help us build better documentation + +--- + +### Writing Content + +If you're interested in writing content / migrating your own doc environment over to our wiki a Github PR is your best option. Please also ensure you have followed our [styling guide](https://contribute.setup.md) to ensure your PR doesn't get rejected for lack of continuity. + +#### Single Articles + +If you're going to write a single article you can do so with the following steps, before you consider uploading a document please ensure you are using a template from our [sister github repository](https://github.com/setupmd/templates/tree/main/Docs). + + + +The setup.md contributors will then verify the PR is good and will approve your content. + +#### Migrating Wikis + +If you already use docusaurus for your own project, adding your content here is super easy and should be a drag and drop migration. You'll need to [submit a PR](https://smd.gg/pr) but it's recommended you reach out to us on [Discord](https://smd.gg/discord) so we can setup some indexing for your future content. + +--- + +### Improving Content + +As Minecraft continues to grow so will our project and we hope that if you spot inconsistancies in our project you'll hit the 'Edit Page' link at the bottom to submit a PR request with any corrections you wish to make. diff --git a/folder/de/src/content/docs/enhancements/Anti-X Tools/anticheat.mdx.mdx b/folder/de/src/content/docs/enhancements/Anti-X Tools/anticheat.mdx.mdx new file mode 100644 index 0000000000..aebeeaef0b --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Anti-X Tools/anticheat.mdx.mdx @@ -0,0 +1,282 @@ +--- +description: A brief introduction to Anti-Cheats and the community recommended solutions. +slug: e/anti-x/ac +title: Anti-Cheats +lastUpdated: 2024-02-25 +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +:::info +Throughout this guide 'Anti-Cheat(s)' may be referred to as 'AC' or 'ACs' +::: + +ACs are an integral part of any public server and help with catching hackers, since Minecraft's built-in anti-cheat is practically useless, it's better to turn it off than to endure the constant false positives it spews out. + +You should change the following settings within the `server.properties` file. + +```yml +... + +allow-flight=true + +... +``` + +Within the `spigot.yml` file you should also set the following values. + +```yml +... + + moved-wrongly-threshold: 100000.0 + moved-too-quickly-multiplier: 100000.0 + +... +``` + +For the recommended anti-xray settings [click here](https://www.setup.md/e/anti-x/ax). + +:::warning +We highly discourage the usage of auto-bans as no anti-cheat is perfect. If you want to auto-ban, consider having something like AntiCheatReplay so that you can undo false bans. +::: + +### Common Anti-Cheats + +This list consists common ACs and some pros and cons of each AC. + +#### NoCheatPlus Spigot / Paper & forks only + +##### Pros + + + +##### Cons + + + + + +--- + +#### Grim Spigot / Paper & forks only + +##### Pros + + + +##### Cons + + + + + +--- + +#### Vulcan Spigot / Paper & forks only + +##### Pros + + + +##### Cons + + + + + +--- + +#### Spartan Spigot / Paper & forks only + +##### Pros + +
    +
  • 14-day money-back guarantee
  • +
  • Good Bedrock Checks
  • +
  • Decent movement checks
  • +
+ +##### Cons + +
    +
  • EUR 22.49
  • +
  • Relatively poor combat checks
  • +
  • Crashes on start up at times
  • +
  • Sub-par performance
  • +
+ + + +--- + +#### Matrix Spigot / Paper & forks only + +##### Pros + +
    +
  • Decent movement and combat checks
  • +
+ +##### Cons + +
    +
  • Bad default config, but there are some [good ones](https://github.com/QuantumSuite/MatrixChecks) out there
  • +
  • USD 20.00 (With 95% Checks) and USD 129.00 (All Checks)
  • +
  • Dedicated Server Limit
  • +
  • Terrible performance; Ate up >5% of the ticks at 135 players
  • +
+ + + +--- + +#### Themis Spigot / Paper & forks only + +##### Pros + +
    +
  • Free
  • +
  • Proper Geyser-Floodgate (Bedrock Players) checks (Only reason to use this anti-cheat)
  • +
+ +##### Cons + +
    +
  • Bad Combat & Mediocre Movement checks (Bad Elytra, Timer, KillAura Checks)
  • +
  • Lack of checks in general
  • +
+ + +
+ +:::note +This anti-cheat is optimised for bedrock players. +::: + +--- + +#### SoaromaSAC (Config 6) Spigot / Paper & forks only + +##### Pros + +
    +
  • Free
  • +
+ +##### Cons + +
    +
  • Bad Checks
  • +
  • Infinite False Positives
  • +
  • Fake Open Source Link. Leads to a Rick Roll
  • +
+ + + +--- + +#### Negativity v1 & v2 All major Java platforms + +##### Pros + +
    +
  • Free & Open Source
  • +
  • Paid Version (v2) is Open Source
  • +
  • v2 supports a lot of platforms (Minestom, Sponge, Fabric & more)
  • +
+ +##### Cons + +
    +
  • Lacks some important checks (No Elytra Checks, NoSlow Checks etc)
  • +
  • Poor movement and combat checks
  • +
+ + + +--- + +#### Polar + +##### Pros + +
    +
  • Great movement and combat checks
  • +
  • Works out-of-the-box on most servers
  • +
  • Cloud-based detections, which helps reducing stress on server resources
  • +
+ +##### Cons + +
    +
  • Subscription plans starting at EUR 15/month
  • +
  • Limitations on player count, server instances and dedicated servers based on subscription plan
  • +
+ + + +### Recommendations + +Both Astro and Vulcan offer a great price to performance ratio. However, Astro will be significantly lighter on system resources. +Also, Vulcan will support Bedrock in the near future. Astro already supports it. + +:::tip +Remember, no anti-cheat is perfect. Players will be able to bypass anti-cheats, so we recommend having a moderator or two online to keep an eye out for any cheaters. +::: diff --git a/folder/de/src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx.mdx b/folder/de/src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx.mdx new file mode 100644 index 0000000000..1ee39234bd --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx.mdx @@ -0,0 +1,47 @@ +--- +description: A brief introduction to Anti-Exploits and the community recommended solutions. +slug: e/anti-x/ae +title: Anti-Exploit +lastUpdated: 2024-02-25 +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +Anti-Exploit plugins resolve issues such as crashes, dupes, abusive NBT etc. + +:::info +Some of these plugins might only be useful if you are not using the latest version of Paper. +::: + +#### Panilla + +Panilla prevents abusive NBT and packets. Average or lenient modes recommended. Recently was found to be messing with items contained within shulkers, so test the plugin before you install it on production. + + + + + + +--- + +#### LPX + +Avoids NettyCrashers, slightly prevents Anti-Anti-Xrays, logs packets and limits them. + + + +--- + +#### BookExploitFix + +Improve the security of your Minecraft server by filtering illegal content from player created books. Although personally I would completely disable books because I don't trust them at all, you may use this plugin instead. + + + + + diff --git a/folder/de/src/content/docs/enhancements/Anti-X Tools/antilag.mdx.mdx b/folder/de/src/content/docs/enhancements/Anti-X Tools/antilag.mdx.mdx new file mode 100644 index 0000000000..511bac4815 --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Anti-X Tools/antilag.mdx.mdx @@ -0,0 +1,85 @@ +--- +description: A brief introduction to Anti-Lag and alternative performance management tools. +slug: e/anti-x/al +title: Anti-Lag +lastUpdated: 2024-02-25 +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +Below is a list of tools and optimisations you can use to identify and mitigate TPS (server) lag. + +:::caution +**Anti-lag plugins such as ClearLagg "don't work".** + +These plugins periodically clear dropped items at a set interval - this makes a negligible difference to lag and most anti-lag plugins have poor detection that can result in more lag. Aside from the fact any "gains" seen by such tools are just hiding performance issues under a thin veil rather than actually fixing them. +::: + +#### Guides to Optimisation + +We have published a couple of proven guides on optimisations below that should be reviewed first. + + + +--- + +#### Spark + +A modern performance profiler for 1.8+ servers on any platform - Forge, Spigot, Fabric, almost anything that isn't the vanilla server! This isn't an anti-lag plugin per se but it can help you find what's _causing_ lag on your server. + +It now comes built-in with the Purpur performance JAR and its forks. + + + + + + + +--- + +#### FarmControl + +This plugin allows you to manage certain properties of farms on your server. Among other things, the plugin acts as a farm limiter, can remove the ability of mobs in farms to collide and perform random movements, or can completely disable the AI of mobs in farms. These actions can be performed either passively or in response to the server's performance degrading. + + + + + + +--- + +#### EntityDetection + +This plugin lets you quickly find chunks with large quantities of mobs/animals & tile entities. Not an anti-lag plugin, but can be incredibly useful + + + + + + +--- + +#### CAProtect-Lite + +Prevents players from lagging the server with minecarts and boats. If you have FarmLimiter, consider configuring that plugin to do what CAProtect does instead, as CAProtect is a bit more intensive. Otherwise, consider using AjMac's fork. + + + + + + +--- + +#### RedstoneLimiter + +RedstoneLimiter is a plugin that limits how many times individual redstone contraptions can be activated in a customizable amount of time to fix lag machines. + + + + + diff --git a/folder/de/src/content/docs/enhancements/Anti-X Tools/antixray.mdx.mdx b/folder/de/src/content/docs/enhancements/Anti-X Tools/antixray.mdx.mdx new file mode 100644 index 0000000000..d18466f8b8 --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Anti-X Tools/antixray.mdx.mdx @@ -0,0 +1,50 @@ +--- +description: A brief introduction to Anti-Xray and the community recommended solutions. +slug: e/anti-x/ax +title: Anti-Xray +lastUpdated: 2024-02-25 +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +As the name suggests, Anti-Xray will prevent players from finding ores using Xray clients/resource packs. This is done by sending packets to the player where all of the ores are replaced by stone. The ores only appear if the player establishes direct visual contact with them/updates them. Two of the most common Anti-Xray plugins are shown below: + +#### PaperMC + +PaperMC (A fork of Spigot) comes with a built-in Anti-Xray. This Anti-Xray usually does the trick just fine. It is simple to setup and causes no lag for both the server and the client (unless you hide caves (air), which will be much laggier for the client). A great guide is shown [here](https://docs.papermc.io/paper/anti-xray). Again, make sure that you do NOT add `air` to `hidden-blocks`. + + + +--- + +#### Orebfuscator + +If you're stuck using Spigot for whatever reason, you should probably use Orebfuscator. It may also work well in junction with Paper's Anti-Xray, as it can also +hide containers better. + + +
+:::note +Orebfuscator does have a tendency to turn chests into dirt when server is laggy, this is a visual thing and doesn't delete the contents of said chests +::: + +--- + +### RayTraceAntiXray + +Paper plugin for server-side async multithreaded ray tracing to hide ores that are exposed to air using Paper Anti-Xray engine-mode 1. Might be worth using instead of engine-mode 2 as that can cause lag on slow devices. Only recommended if you have extra threads and don't mind using ProtocolLib. + + diff --git a/folder/de/src/content/docs/enhancements/Anti-X Tools/intro.mdx.mdx b/folder/de/src/content/docs/enhancements/Anti-X Tools/intro.mdx.mdx new file mode 100644 index 0000000000..5237647b53 --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Anti-X Tools/intro.mdx.mdx @@ -0,0 +1,22 @@ +--- +sidebar_position: 1 +slug: e/anti-x +description: Understand the types of 'preventative' tools that exist for Minecraft servers. +title: Introduction +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +Minecraft is an open game by nature and as great as that is, it doesn't always work in every servers favour and sometimes they need to make changes in order to restrict certain aspects of gameplay for any number of multiple reasons. + +The most common types of plugins you'll see in this category are: + + + + + + + + +We will attempt to cover multiple examples of each where possible. diff --git a/folder/de/src/content/docs/enhancements/Economy/chest.mdx.mdx b/folder/de/src/content/docs/enhancements/Economy/chest.mdx.mdx new file mode 100644 index 0000000000..59dccbe225 --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Economy/chest.mdx.mdx @@ -0,0 +1,17 @@ +--- +description: A focus on traditional chest based plugins for your servers economy. +slug: e/eco/chest +title: Chest Based +--- + +A chest shop is a Minecraft resource buying - selling enhancement that is fully craftable in game using normally a standard chest and a wooden sign. These solutions normally bring a more player-to-player style interraction with players chosing to rent space in an admin market / build their own market. + +### Examples + +We have collated a small list of plugins you can use to get you started with on your Minecraft server below. + +
    +
  • [QuickShop](/e/pl/quickshop)
  • +
  • [ChestShop](/e/pl/chestshop)
  • +
  • [DukesMart](/e/pl/dukesmart)
  • +
diff --git a/folder/de/src/content/docs/enhancements/Economy/gui.mdx.mdx b/folder/de/src/content/docs/enhancements/Economy/gui.mdx.mdx new file mode 100644 index 0000000000..7844735528 --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Economy/gui.mdx.mdx @@ -0,0 +1,19 @@ +--- +description: A focus on GUI based plugins for your servers economy. +slug: e/eco/gui +title: GUI Based +lastUpdated: 2024-01-01 +--- + +A GUI based shop plugin allows users to buy and sell using an interface, normally that of chests and can sometimes be more accessible for your players. + +### Examples + +We have collated a small list of plugins you can use to get you started with on your Minecraft server below. + +
    +
  • [AuctionHouse](/e/pl/auctionhouse)
  • +
  • [PlayerAuctions](/e/pl/playerauctions)
  • +
  • [PlayerShops (BPS)](/e/pl/playershops)
  • +
  • [zAuctionHouse](/e/pl/zauctionhouse)
  • +
diff --git a/folder/de/src/content/docs/enhancements/Economy/intro.mdx.mdx b/folder/de/src/content/docs/enhancements/Economy/intro.mdx.mdx new file mode 100644 index 0000000000..0319535ab4 --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Economy/intro.mdx.mdx @@ -0,0 +1,26 @@ +--- +description: Recommended plugins to kick start your Minecraft server's economy. +slug: e/eco +title: What is an economy? +sidebar: + order: 1 +--- + +An economy is essential to your Minecraft server, it allows for players to buy and sell between one another or between your players and the server for in-game ranks / items etc. + +Economies within Minecraft, much like the real world, can dictate supply and demand with availabilities of resources to your players. For example if you were running admin shops it would be possible to run a discount on certain items and random points within the year or if you want to make a product more valuable then this can be achieved too. + +The goal with this section is to highlight some viable options for your server along with some example plugins that will allow you to build the framework for your own server's economy to take place. + +### Requirements + +Most, if not all plugins require your server to have an Economy API (such as [Vault](/e/pl/vault)) and an Economy Handler installed. + +Some example economy handlers are below: + +
    +
  • [EssentialsX](/e/pl/essentialsx)
  • +
  • [TheNewEconomy](/e/pl/theneweconomy) (Optional Vault Support)
  • +
  • [iConomy](/e/pl/iconomy)
  • +
  • [Gringott's Economy](/e/pl/gringottseco)
  • +
diff --git a/folder/de/src/content/docs/enhancements/Economy/shop.mdx.mdx b/folder/de/src/content/docs/enhancements/Economy/shop.mdx.mdx new file mode 100644 index 0000000000..9fd5bcd954 --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Economy/shop.mdx.mdx @@ -0,0 +1,44 @@ +--- +description: A focus on /shop based plugins for your servers economy. +slug: e/eco/shop +title: Command Based +--- + +### /shop Plugins + +/shop Plugins are server-sided shops, meaning that all items are bought and sold from and to the the server instead of a player. + +#### ShopGUI+ + +ShopGUI+ is probably the most well known /shop plugin out there. Kitted out with basically every feature you might need (other than a dynamically evolving economy), it is a pretty solid choice for most servers. +Too bad that it's 18 USD and performs poorly when scaled to higher player counts. Only worth buying if you want support for other plugins. + +
+Spigot +
+ +#### BossShopPro + +Solid /shop plugin with a lot of good features. I highly recommend that you find a fork to download instead of using the old SpigotMC version. + +
+Spigot +
+ +#### EconomyShopGUI + +Free, simple /shop plugin that just does the job. It also has a premium version for 12 USD. Free version is extremely limiting. + +
+Spigot +
+ +#### DeluxeMenus + +Now hear me out.. I know that DeluxeMenus isn't exactly a server-shop plugin, but it is nearly perfect for the job since it is EXTREMELY flexible. cj89898 has made a wonderful DeluxeMenus shop [here](https://github.com/cj89898/DeluxeMenus-DeluxeShop). + +You may also use a setup.md provided version [here](https://github.com/setupmd/templates/raw/main/Plugin%20Configurations/deluxemenusshop.zip). + +
+Spigot +
diff --git a/folder/de/src/content/docs/enhancements/Permissions/breakdown.mdx.mdx b/folder/de/src/content/docs/enhancements/Permissions/breakdown.mdx.mdx new file mode 100644 index 0000000000..467527519f --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Permissions/breakdown.mdx.mdx @@ -0,0 +1,28 @@ +--- +sidebar_position: 1 +slug: e/perms +title: How They Work +lastUpdated: 2024-01-01 +sidebar: + order: 4 + badge: + text: Important + variant: danger +--- + +When you're setting up a new server, a very important part of the process is managing permissions and **configuring them as you go**. + +Permissions are little pieces of text that indicate an action. When you grant a certain group of players this permission, the plugin will know that they are allowed to perform this action. They are usually laid out like `pluginname.permission`. + +An example is the `essentials.afk` permission. If you give this permission to a player, they will be able to perform the `/afk` command. + +:::note +You can use the wildcard (`*`) operator to indicate everything when supplying a permission. +Ex: `essentials.*` will give you every permission that starts with `essentials.`. +::: + +:::danger +It is a very bad idea to give someone (even yourself!) either the `*` or `*.*` permission(s). +::: + +So how does one grant permissions to their players? For this exact purpose people have created permission plugins. They allow you to create groups, usually associated with the term Rank. You can then give certain permissions to these groups, and assign players to these groups. diff --git a/folder/de/src/content/docs/enhancements/Permissions/plugins.mdx.mdx b/folder/de/src/content/docs/enhancements/Permissions/plugins.mdx.mdx new file mode 100644 index 0000000000..a8e5b6111d --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Permissions/plugins.mdx.mdx @@ -0,0 +1,17 @@ +--- +description: A focus on permission manager plugins for your server. +slug: e/perms/plugins +title: Plugins +lastUpdated: 2024-01-01 +--- + +Permission manager plugins allow you to define groups (ranks), and permission levels for all of your players on your server. + +### Examples + +We have collated a small list of plugins you can use to get you started with on your Minecraft server below. + +
    +
  • [LuckPerms](/e/pl/luckperms)
  • +
  • [PowerRanks](/e/pl/powerranks)
  • +
diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/AntiCrasher.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/AntiCrasher.mdx.mdx new file mode 100644 index 0000000000..c181f20c6b --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/AntiCrasher.mdx.mdx @@ -0,0 +1,11 @@ +--- +description: AntiCrasher behebt einen Crash-Exploit, welcher jede Version betrifft und nur in sehr aktuellen Builds von paper/pufferfish/purpur für 1.20.2 und einem Backport für pufferfish 1.20.1 behoben wurde +slug: e/pl/anticrasher +title: AntiCrasher +--- + +Behebt einen sehr beliebten und häufig genutzten Crash-Exploit, der die meisten Versionen von Minecraft betrifft + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/MiniMOTD.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/MiniMOTD.mdx.mdx new file mode 100644 index 0000000000..01da7628be --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/MiniMOTD.mdx.mdx @@ -0,0 +1,33 @@ +--- +description: MiniMOTD has the functionality to add an MOTD (Message Of The Day) to your server, which shows on the Multiplayer page of Minecraft before a player logs into your server. +slug: e/pl/minimotd +title: MiniMOTD +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Bungeecord, Waterfall & Velocity Spigot / Paper & forks only +
+MiniMOTD is a plugin of which allows you to **fully** customize your server's MOTD by: + +
    +
  • Adding multiple MOTD messages that can alternate between one another
  • +
  • Adding RGB gradients
  • +
  • Adding Placeholders
  • +
  • and much more...
  • +
+ +#### Note + +Whilst MiniMOTD can run on your backend server, if you are running a network via a proxy such as Bungeecord or Velocity, MiniMOTD will be ran on your proxy. Therefore, you should download MiniMOTD to your proxy rather than your individual servers. If you are just running one singular server, MiniMOTD will run directly on that server. + + + + + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/auctionhouse.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/auctionhouse.mdx.mdx new file mode 100644 index 0000000000..93b2115d67 --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/auctionhouse.mdx.mdx @@ -0,0 +1,24 @@ +--- +description: A GUI based player shop plugin to enhance your economy. +slug: e/pl/auctionhouse +title: AuctionHouse +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+A decent /ah plugin. Unfortunately, it does have it's fair share of issues. For example, it is one of the most laggiest plugins in every server and also has caused dupes here and there (rare but still possible). + +There are better options out there with far more customizability. + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/chestshop.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/chestshop.mdx.mdx new file mode 100644 index 0000000000..3befbc50a7 --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/chestshop.mdx.mdx @@ -0,0 +1,22 @@ +--- +description: A chest based player shop plugin to enhance your economy. +slug: e/pl/chestshop +title: ChestShop +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+A simple bare bones chest shop plugin, think 'QuickShop' without all the fancy bells and whistles. ChestShop makes a great plugin for anyone who just wants to get some simple buying and selling going in their server. + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/discordsrv.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/discordsrv.mdx.mdx new file mode 100644 index 0000000000..74e97937bb --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/discordsrv.mdx.mdx @@ -0,0 +1,22 @@ +--- +description: DiscordSRV acts as a bridge between a Discord server and your Minecraft server, allowing them to communicate. +slug: e/pl/discordsrv +title: DiscordSRV +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+DiscordSRV is a very commonly used plugin that acts as a bridge between your Minecraft and Discord servers, allowing them to communicate and for actions to be called via interactions in Discord and vice-versa. DiscordSRV also supports livechat functionality between your Minecraft and Discord server so players that aren't logged in can still chat. Moreover, DiscordSRV allows for linking a users Discord account to their Minecraft account on a per-instance basis. That said, the setup of DiscordSRV relies on the creation of an application and Bot on Discord's Developer Portal. + + + + + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/dukesmart.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/dukesmart.mdx.mdx new file mode 100644 index 0000000000..89c3e66970 --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/dukesmart.mdx.mdx @@ -0,0 +1,22 @@ +--- +description: A chest based player shop plugin to enhance your economy. +slug: e/pl/dukesmart +title: DukesMart +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+A plugin to watch as the light weight chest shop plugin was rumoured to be getting one final breath of life with a fork. + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/essentialsx.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/essentialsx.mdx.mdx new file mode 100644 index 0000000000..66130c749e --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/essentialsx.mdx.mdx @@ -0,0 +1,28 @@ +--- +description: EssentalsX introduces over 130 commands for servers of all sizes which will enhance the gameplay with QoL features for all. +slug: e/pl/essentialsx +title: EssentialsX +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +EssentialsX, formerly just Essentials is the core backbone to any Minecraft server, it introduces a wide range of utility commands (all of which are permission toggle controllable) that can be used to enhance the base gameplay over the vanilla commands. + + + + + + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/luckperms.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/luckperms.mdx.mdx new file mode 100644 index 0000000000..895140d4ef --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/luckperms.mdx.mdx @@ -0,0 +1,25 @@ +--- +description: Learn about the PowerRanks plugin and how to get a basic configuration up and running. +slug: e/pl/powerranks +title: PowerRanks +lastUpdated: 2024-01-01 +sidebar: + badge: + text: New + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+PowerRanks is an alternative to Luckperms, it's a Bukkit plugin that support Spigot and it's forks. PowerRanks does have support for NukkitX but has not been updated since Dec 2023. + + + + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/playerauctions.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/playerauctions.mdx.mdx new file mode 100644 index 0000000000..605c04b36d --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/playerauctions.mdx.mdx @@ -0,0 +1,24 @@ +--- +description: A GUI based player shop plugin to enhance your economy. +slug: e/pl/playerauctions +title: PlayerAuctions +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+It has great levels of customizability and flexibility, to the point where you can edit pretty much every aspect of every single menu. It also has compatibility with lots of other plugins and also an author who is always there to provide support. + +The plugin does however lack in the open source department. + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/playershops.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/playershops.mdx.mdx new file mode 100644 index 0000000000..15ce1dedb3 --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/playershops.mdx.mdx @@ -0,0 +1,23 @@ +--- +description: A GUI based player shop plugin to enhance your economy. +slug: e/pl/playershops +title: PlayerShops (BSP) +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +It allows every player to create their own shop GUI, similarly to BossShopPro. Players may sell their items in said shop. Might replacement for ChestShops. this plugin hasn't been updated in a while, though. + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/powerranks.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/powerranks.mdx.mdx new file mode 100644 index 0000000000..60165c89ee --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/powerranks.mdx.mdx @@ -0,0 +1,25 @@ +--- +description: Learn about the Luckperms plugin and how to get a basic configuration up and running. +slug: e/pl/luckperms +title: Luckperms +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Bungeecord, Waterfall & Velocity All major Java & Bedrock platforms +
+LuckPerms is probably the most feature-rich permissions plugin in existence currently. It supports many different kinds of servers, like Bukkit/Spigot or Sponge, but also all the major proxies like Velocity and Bungeecord. + + + + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/quickshop.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/quickshop.mdx.mdx new file mode 100644 index 0000000000..9380421371 --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/quickshop.mdx.mdx @@ -0,0 +1,33 @@ +--- +description: A chest based player shop plugin to enhance your economy. +slug: e/pl/quickshop +title: Quick Shop Remake +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+QuickShop Remake is a forked and maintained version of the long standing '[QuickShop](https://dev.bukkit.org/projects/quickshop)' plugin of the earlier Minecraft days. It allows players to buy and sell between one another and the 'admin store' using chests. + +### Features + +
    +
  • Full sign support
  • +
  • Full support for multi-currency
  • +
  • Supports Taxes
  • +
  • WorldGuard, Towny, PlotSquared and Factions support
  • +
+ +And so much more, the important links for this plugin can be found below. + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/ultimatetimber.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/ultimatetimber.mdx.mdx new file mode 100644 index 0000000000..96a97d627e --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/ultimatetimber.mdx.mdx @@ -0,0 +1,31 @@ +--- +description: A free plugin that freshens up the most basic task in Minecraft - cutting down a tree. +slug: e/pl/ultimatetimber +title: Ultimate Timber +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+Give your players a new and exciting way to cut down trees in Minecraft. + +### Features + +
    +
  • Auto pickup
  • +
  • Auto replant
  • +
  • Custom animations (inc block falling)
  • +
  • Custom item drops
  • +
  • Custom sounds
  • +
+ + + + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/vault.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/vault.mdx.mdx new file mode 100644 index 0000000000..1d8fc72841 --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/vault.mdx.mdx @@ -0,0 +1,29 @@ +--- +description: Vault API is a core framework for most economy, permission and chat plugins and has become a key dependency for many plugins. +slug: e/pl/vault +title: Vault API +lastUpdated: 2023-12-16 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +The Vault API is the longest standing, most reliable permissions, chat and economy API backbone for Minecraft. It's been around for about a decade at this point in time and with every update that passes reliability has always remained. + +Vault is a plugin that once added will rarely need updating and with a lot of plugins requiring it, you should make sure it's first on your download list! + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/worldedit.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/worldedit.mdx.mdx new file mode 100644 index 0000000000..038aa582bc --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/worldedit.mdx.mdx @@ -0,0 +1,28 @@ +--- +description: WorldEdit is a plugin that's been around for over a decade and can be used to help speed up large builds / world changes. +slug: e/pl/worldedit +title: WorldEdit +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+Worldedit is a no-brainer, this is a plugin that's been around for the entire lifespan of Minecraft multiplayer as we know it and it's not going anywhere fast. If you need to move large buildings in your world, export or import schematics this is the tool for you and your build team. Consider using WETS (WorldEdit Tick Spreader) OR AsyncWorldEdit OR FastAsyncWorldEdit, as they can perform tasks faster & prevent crashes. + +Ironically, FAWE performs far worse than WE at higher player counts while it is idle due to it unnecessarily listening to player interactions. If you want to squeeze every last drop of performance out of your server and are not actively using FAWE in any way, we recommend switching back to WE. AWE's idle performance is untested. + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/worldguard.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/worldguard.mdx.mdx new file mode 100644 index 0000000000..4cf011e9e5 --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/worldguard.mdx.mdx @@ -0,0 +1,26 @@ +--- +description: WorldGuard is one of the oldest forms of 'admin land claim' systems and has been a core plugin for many servers over the last decade or so. +slug: e/pl/worldguard +title: WorldGuard +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+If you're using WorldEdit then you've most likely already heard of WorldGuard but for those who haven't WorldGuard allows you to create 'admin land claims' which will prevent certain regions from being griefable. This is a perfect solution for building playershops, central landmarks in your server such as spawns and admin shops and more. Some plugins can even hook into the WorldGuard plugin and enhance it's capability offering a better overall experience to your players. + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Free/znpc.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Free/znpc.mdx.mdx new file mode 100644 index 0000000000..3c4475eaf0 --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Free/znpc.mdx.mdx @@ -0,0 +1,37 @@ +--- +description: An NPC plugin for your Minecraft server. +slug: e/pl/znpc +title: ZPNCs +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +### ZNPCs + +ZNPCs is another popular NPC plugin. Although it is better than Citizens from a performance perspective, it is quite janky and unpleasant to setup. + + + +--- + +### ZNPCsPlus + +ZNPCsPlus delivers great performance while also being easy to setup & edit. Recommended as long as you don't mind the lack of support in other plugins for it, V2 can be compiled from the Github page. + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Premium/citizens.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Premium/citizens.mdx.mdx new file mode 100644 index 0000000000..99924efc1c --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Premium/citizens.mdx.mdx @@ -0,0 +1,23 @@ +--- +description: An NPC plugin for your Minecraft server. +slug: e/pl/citizens +title: Citizens +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +Citizens is the most popular and widely supported NPC plugin in the market. It is purchasable on Spigot and open source as well. Free downloads can be found on it's Jenkins server. Not recommended for servers with high player counts as it can eat a lot of ticks. + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Premium/litebans.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Premium/litebans.mdx.mdx new file mode 100644 index 0000000000..8d226e9d8d --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Premium/litebans.mdx.mdx @@ -0,0 +1,37 @@ +--- +description: Litebans is a premium plugin that centralises ban management for 'networked' servers. +slug: e/pl/litebans +title: Litebans +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Recommended + variant: tip +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Bungeecord, Waterfall & Velocity Spigot / Paper & forks only +
+If you're looking for a method of syncing Minecraft bans between multiple Minecraft proxies, servers (or both) or perhaps you're looking for a way to give your end users some transparency over the punishments that are handed out within your community. If this sounds of interest then Litebans is the tool for you. + +This plugin allows for central management of all punishments via a database and provides you the ability to host a public punishment website for people to view additional details. + +### Features + +
    +
  • UUID based punishments (no username change ban evasions)
  • +
  • UI is fully customisable
  • +
  • Punishment templates
  • +
  • Punishment scope support (multi-server specific)
  • +
  • Web-UI included for free
  • +
+ + + + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/Premium/zauctionhouse.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/Premium/zauctionhouse.mdx.mdx new file mode 100644 index 0000000000..5e790f5a3e --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/Premium/zauctionhouse.mdx.mdx @@ -0,0 +1,25 @@ +--- +description: A GUI based player shop plugin to enhance your economy. +slug: e/pl/zauctionhouse +title: zAuctionHouse +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +A premium version of Player Auctions. You may find greater performance in addition to a few extra features, notably the Shulker viewer and a Sell inventory but that's about it. + +Player Auctions listed in the comparison page says that several features, such as multi-currency support & custom inventories, are not in PA. This is not true as PA does have said features. + + diff --git a/folder/de/src/content/docs/enhancements/Plugins/intro.mdx.mdx b/folder/de/src/content/docs/enhancements/Plugins/intro.mdx.mdx new file mode 100644 index 0000000000..7b20e4764f --- /dev/null +++ b/folder/de/src/content/docs/enhancements/Plugins/intro.mdx.mdx @@ -0,0 +1,16 @@ +--- +sidebar_position: 1 +slug: e/pl +title: Why Plugins +--- + +Our goal is to highlight some must have plugins for Minecraft, in order for them to make the list they have to meet the below criteria. + +
    +
  • Publish to reputable marketplaces
  • +
  • Premium plugins should be on Spigot marketplace
  • +
  • Provide a benefit to either server owners or it's players
  • +
  • Reputable development team
  • +
+ +This is not a definitive list and may change as we add more plugins diff --git a/folder/de/src/content/docs/guides/Minecraft/Optimisation/advanced.mdx.mdx b/folder/de/src/content/docs/guides/Minecraft/Optimisation/advanced.mdx.mdx new file mode 100644 index 0000000000..3c1d364a04 --- /dev/null +++ b/folder/de/src/content/docs/guides/Minecraft/Optimisation/advanced.mdx.mdx @@ -0,0 +1,107 @@ +--- +slug: guides/optimisation/advanced +title: Advanced Checklist +description: A more focused approach on squeezing out every last drop of performance at scale. +sidebar: + order: 3 +--- + +This section covers plugins that you can modify/replace to improve performance. Only recommended at higher player counts. + +#### TAB + +The plugin author's optimisation guide is linked below.. The `anti-override` options are especially important as TAB's overriding is quite intensive. An additional config worth changing to false is `unlimited-nametag-mode`. + +Regarding anti-override, first make sure that none of your plugins mess with the tablist or scoreboard other than TAB itself. Some common culprits might be BetterTeams, eGlow, Paper's collision rules and CMI. + +You will have to remove eGlow in order to take full advantage of this optimisation. Once you're done modifying/removing such plugins, make sure `enable-player-collisions` in Paper's configuration is true. After you do that, you can disable player collisions in TAB's config by changing `scoreboard-teams.enable-collisions`. + +Finally, switch `anti-override` from true to false. If your tablist does not have proper order, an external plugin is probably still modifying the tablist. + +
+Guide +
+ +--- + +#### ProtocolLib & it's Dependants + +ProtocolLib is not very well optimised. Lots of plugins also abuse ProtocolLib a lot, causing even worse performance. Examples are DeluxeCombat (If ProtocolLib hook is enabled) and InteractiveChat. Removal has resulted in significantly better performance in all large servers. + +Consider finding alternatives to plugins that use ProtocolLib, or fork them to use PacketEvents. + +--- + +#### Citizens + +Citizens often eats up >5% of ticks on larger servers. It is recommended that you use ZNPCsPlus instead if you don't mind a smaller catalogue of supported plugins. Overall, ZNPCsPlus was using 0.03% of the ticks at 330 players according to a spark report. + +
+GitHub +
+ +--- + +#### ajLeaderboards + +Although ajLeaderboards has seen great optimization patches in recent times, it is still a tad laggier than it really should be. We recommend LeaderHeadsRevamped instead. Yes, LHR still works perfectly even though it hasn't seen an update in ages. + +If you insist on using ajLeaderboards, make sure `register-lp-contexts` is set to false. + +
+Spigot +
+ +--- + +#### AntiCheat + +Vulcan as an anti-cheat does not scale well at higher player counts, where every bit of performance matters. >1.6% ticks eaten at 350+ players is supoptimal. AstroAC on the other hand only eats 0.03% of ticks at 330 players while having checks that are almost as good as Vulcan's. + +Polar might also be worth it but we have yet to check it's performance at higher player counts + +Spartan (Both Java and Bedrock) is an absolute no-go for even medium-sized servers. Performance is extremely poor and checks are subpar. + +
+Astro +
+ +--- + +#### FastAsyncWorldEdit + +Although FAWE performs far better than WE when it's actually being used for building, it's performance is, rather ironically, significantly worse than standard WorldEdit's at idle due to FAWE listening to player interaction events. + +If you nor any of your plugins are actively using FAWE, consider switching to standard WorldEdit. + +--- + +#### Vanish Plugins + +It is recommended to use AdvancedVanish instead of plugins like SuperVanish and PremiumVanish as their performance is rather poor in comparison. + +
+Spigot +
+ +--- + +#### Geyser + +To offload Geyser's performance impact on your Spigot/Proxy server, you can use Geyser Standalone. Worth it for servers that have a lot of bedrock players. + +#### DiscordSRV + +If you are fine with losing a few features, consider replacing DiscordSRV with Essentials Discord as it isn't as bloated. + +#### Auction House Plugins + +zAuctionHouse is recommended as it runs the smoothest while also having the most features. PlayerAuctions is an alright alternative if you want a free plugin, but it's performance is marginally inferior. Consider enabling zAuctionHouse's cacheItems setting as well. + +#### Stacking Plugins + +Stacking plugins can be very detrimental to server performance depending on their implementations and configurations. RoseStacker is the best we've used thus far, but might end up lagging the server a bit more than if you didn't have it installed. + +#### WorldGuard + +WorldGuard allows you to prevent it from listening to certain events in it's configuration file. Could prove useful for very specific servers, but not something the average server should tinker with. diff --git a/folder/de/src/content/docs/guides/Minecraft/Optimisation/intro.mdx.mdx b/folder/de/src/content/docs/guides/Minecraft/Optimisation/intro.mdx.mdx new file mode 100644 index 0000000000..e5952e9a46 --- /dev/null +++ b/folder/de/src/content/docs/guides/Minecraft/Optimisation/intro.mdx.mdx @@ -0,0 +1,29 @@ +--- +description: This section of setup.md goes in-depth for server optimisation +slug: guides/optimisation +title: Introduction +sidebar: + order: 1 +--- + +A section for optimising Minecraft servers. Optimising your server means to improve the performance of the server by implementing tweaks without heavily modifying desired mechanics. Advanced optimisation is only recommended for large servers suffering from poor performance. + +### Spark Profiler + +You should use the Spark Profiler for monitoring server performance e.g. vanilla mechanics, plugins, GC pauses and cycles, memory usage etc. + + + +### Server JAR + + is currently the fastest, most stable free Paper fork available. Another alternative would be [Purpur](https://purpurmc.org/downloads), which provides additional mechanics for players at the expense of rather negligible performance loss against Pufferfish. +As for proxies, [Velocity](https://papermc.io/software/velocity) is easily the best option. Although it doesn't have as many plugins as Bungeecord, it is far more stable and secure by default. Most popular plugins have already added support for Velocity. + +You may also want to take a look at [UniverseSpigot](https://polymart.org/resource/universespigot-1-20-1.4805). Highly recommended for servers with player counts exceeding 200 (and experiencing lag, of course). It's $70 price tag is certainly worth it. Do be careful with what settings you change as they can drastically affect gameplay. + +| Topic | Summary | +| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Basic Optimisation | Tweaks that will likely suffice for small to medium-sized servers (\< 100 Players) assuming that they have sufficient CPU & memory resources. | +| Advanced Optimisation | Tweaks made for larger servers with at least 150 players. | diff --git a/folder/de/src/content/docs/guides/Minecraft/Plugins/luckperms.mdx.mdx b/folder/de/src/content/docs/guides/Minecraft/Plugins/luckperms.mdx.mdx new file mode 100644 index 0000000000..eb154cf5c6 --- /dev/null +++ b/folder/de/src/content/docs/guides/Minecraft/Plugins/luckperms.mdx.mdx @@ -0,0 +1,98 @@ +--- +description: Learn about the Luckperms plugin and how to get a basic configuration up and running. +slug: guides/luckperms +title: Luckperms +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Advanced + variant: note +--- + +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +### The Basics + +LuckPerms embraces many concepts like "Inheritance" or " Contexts" that might be confusing for a beginner. Consider this section a breakdown of those. + +:::info +For a more in depth explanation of the plugin, one might use the [official wiki](https://luckperms.net/wiki). + +#### Permissions + +A permission is simply put just a piece of text that plugins use to determine what a player can do. They are usually split by periods (like `minecraft.command.kick` for the vanilla /kick command). A permission can have 3 states: + +- `true`: the player can then use the feature which is associated to the permission +- `false` the player is explicitly revoked access to this command or feature. +- undefined: this permission has not been set for this group and defaults to either `true` or `false`, depending how the plugin which uses the permission has determined. + +#### Groups + +A group (or a "rank" as some prefer to call it) is a collection of permissions and other kinds of data which can be given to a player. This simplifies management of, lets say, the staff team as you can simply create a group `admin` and grant it `*` (this permission automatically allows access to everything) which can then be given to your admins and they will all have the same permissions. In this example it might seem counter intuitive, but for ranks with 100s of different permissions, it will become useful. +::: + +One Group always exists: `default`. As its name implies, everybody is in this group, and it is used to give out permissions which every player should have. + +#### Inheritance + +Inheritance is very useful to minimise repeated work. Let us consider the following example: +You have a group `VIP` and a group `MVP`. The group `VIP` is only used to **add** features on top of the `MVP` group. Yet by setting the users group to `MVP`, they would have the permissions from `VIP` revoked. This is where inheritance comes into play. You can make `MVP` inherit `VIP`, so every permission that is granted to `VIP` is automatically reflected in the permissions of `MVP`. + +#### Contexts + +Contexts define the circumstances under which a permission or other data is applied. Still confused? + +Lets take the `gamemode` context as an example. Giving a permission to a player with the context `gamemode=creative` means that they player shall only have that permission if they are in game-mode creative. Quite simple, isn't it? Many plugins add their own contexts, such as EssentialsX' `vanished` pr `god`. + +--- + +### First Steps with LuckPerms + +#### Storage + +Your first step with LuckPerms will be choosing a storage solution. This is a very extensive topic, as each of the storage types come with their own advantages and disadvantages. +A good write up on this would be the [official article](https://luckperms.net/wiki/Storage-types) in the LuckPerms wiki. Essentially there are 3 types of storage: + +- Flat file (In-memory-databases, they work out-of-box) +- Text file (Slower than flat-file, but editable and readable in plain text) +- Database (fastest, readable, but requires an external Database Server) + +In case you run a multi-server setup (e.g. BungeeCord) your only option is a Database! + +#### Your First Commands! + +Once you have LuckPerms installed, you will notice that you do not have access to its primary command `/lp`. You could set it all up through your console, but for the sake of simplicity the command `lp user permission set * ` will give your player full access to every command to simplify the setup. + +Now that that's out of the way let's get started! + +Let's say we want the following architecture: + +![Ranks Example](https://smd.gg/d0bgqaa) + +This structure would allow us to use LuckPerms "promote" feature to, well, promote people. But for that to work, you have to setup "tracks" which the command should follow. Let's say for example you promote a `default` player. They should become a `VIP` and not an `Admin`! + +First we have to create all those groups. Which is simple enough. It's just `/lp creategroup `! + +LuckPerms has many features to edit in its groups and it might overwhelm you at the beginning. But really the only parts you need to know right now are `permission`, `parent`, `meta` and `setweight`. The rest are rather advanced or generally not needed. You already know how to add permissions, so go ahead, give out all the permissions you want your groups to have! In case you screw up somewhere, there always is `unset` to revoke it. +In order to setup the inheritance/promote feature, you simply have to use the `parent` subcommand like this: `/lp group admin parent add mod` or generically `/lp group parent add `. + +That's the entire magic! Your setup is now working! + +#### Prefixes and Rank Tags + +LuckPerms does include the ability to set prefixes and suffixes in its `meta` submenu. But it does not apply them on its own! For that you need other plugins. A general plugin you will need is [Vault](https://dev.bukkit.org/projects/vault). For now don't worry about what Vault on its own does, just know that it's important! + + This intro will be split into 2 parts: Chat and Nametags (Tablist or above the playerhead). + +##### Chat + +There is no end to the list of chat formatting plugins. Most of them offer support to customize your chat format, and as such your prefixes too. It really depends on the specific plugin, but most ones will have a placeholder which you can include in the chat format. + +#### Tablist and Nametag + +The entire story is a different one when we move to the Tablist part of this guide. There are only really 2 options: + + + + + diff --git a/folder/de/src/content/docs/guides/Minecraft/Plugins/terra.mdx.mdx b/folder/de/src/content/docs/guides/Minecraft/Plugins/terra.mdx.mdx new file mode 100644 index 0000000000..e20903f78d --- /dev/null +++ b/folder/de/src/content/docs/guides/Minecraft/Plugins/terra.mdx.mdx @@ -0,0 +1,85 @@ +--- +description: Configure a Terra world gen world for use in both Single and Multiplayer environments. +slug: guides/terra +title: Terra World Generation +lastUpdated: 2024-03-04 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +The setup.md wiki provides Terra worlds available for download monthly, the principle of this guide can be used in situations with / without our pre-provided files if you wish to generate things for yourself. + +Before continuing with configuring Terra we are assuming the following: + +
    +
  • You are using one of our provided world files
  • +
  • You are running atleast version 1.20.4
  • +
+ +Make sure you download one of our maps via our 'Additional Services' page. + + + +You will then need to scroll down to one of the following topic headers to complete setup. + +
    +
  • Paper & Forks
  • +
  • Fabric & Forge
  • +
+ +### Paper & Forks + +Download the latest `.jar` file from the Modrinth page using the link below and add it directly to your `/plugins/` folder inside the server directory. + + + +You will also need to append the following changes to the end of your `bukkit.yml` file **BEFORE** launching your server, this will ensure your server uses the Terra world gen plugin. + +``` +... + +worlds: + world: + generator: Terra:OVERWORLD + +... +``` + +Once this has been complete you can upload and unzip the World.XXXXXXX.zip folder into your server directory. This will automatically extract into a `world` folder and you should be ready to start your server. + +console logs + +Once the server is powered on, check for the three lines highlighted above. If these are displayed that means Terra is responsible for your world and chunk management / generation going forward. + +--- + +### Fabric & Forge + +Download the latest `.jar` file from the Modrinth page using the link below and add it directly to your `/mods/` folder inside the server directory. + + + +Add the following key to your `server.properties` file **BEFORE** launching your server, this will ensure your server uses the Terra world gen plugin. + +``` +... + +level-type=terra:overworld/overworld + +... +``` + +Once this has been complete you can upload and unzip the World.XXXXXXX.zip folder into your server directory. This will automatically extract into a `world` folder and you should be ready to start your server. diff --git a/folder/de/src/content/docs/guides/Minecraft/Self-Host/Standalone (Java)/linux.mdx.mdx b/folder/de/src/content/docs/guides/Minecraft/Self-Host/Standalone (Java)/linux.mdx.mdx new file mode 100644 index 0000000000..8e56d7ccf9 --- /dev/null +++ b/folder/de/src/content/docs/guides/Minecraft/Self-Host/Standalone (Java)/linux.mdx.mdx @@ -0,0 +1,230 @@ +--- +description: If you're just looking to setup a Minecraft server within Linux on your own personal machine then this is the tutorial for you. +slug: guides/self-host/linux +title: Linux +--- + +If you're in the position where you want to host a Minecraft server but you don't want to learn or interface with the command line too frequently then Windows will most likely be your OS of choice either on your own PC or a spare machine you have around the house. + +This guide will not cover the basics of deploying Windows, securing your OS and patch automation as we have already covered those within our [lab](https://setup.md/guides/lab) series. + +### Installing Java + +The first thing you need to do is ensure you have installed the relevant Java JDK version for your desired Minecraft version. The latest release of Minecraft (1.20.1) currently uses Java 17 so that is the version we will be installing in this tutorial. + +Ubuntu uses the `APT` package manager, it's generally considered a good idea to run the following commands before trying to install an application for the first time. + +```bash +... + +sudo apt update +sudo apt upgrade -y + +... +``` + +Once you've ensured the package list has been updated and installed packaged upgraded you can proceed with installing java depending on which Minecraft version you're looking to install you may need to change this command slightly. + +To identify which versions of JRE are installable you can run the following command. + +```bash +... + +apt search "jre-headless" + +... +``` + +This should result in the following output. + +```bash +... + +Sorting... Done +Full Text Search... Done + +default-jre-headless/stable,stable 2:1.11-72 amd64 + Standard Java or Java compatible Runtime (headless) + +openjdk-11-jre-headless/stable,stable-security,stable,stable-security 11.0.14+9-1~deb11u1 amd64 + OpenJDK Java runtime, using Hotspot JIT (headless) + +openjdk-17-jre-headless/stable,stable-security,stable,stable-security 17.0.2+8-1~deb11u1 amd64 + OpenJDK Java runtime, using Hotspot JIT (headless) + +... +``` + +:::info +Java 16 was not an LTS release and therefore isn't present in the list. + +You can now run the following command changing the `version-number` to determine if you would like to install Java 8, Java 11 or Java 17. + +::: + +```bash +... + +sudo apt install "openjdk-17-jre-headless" -y + +... +``` + +The above command will install Java 17 and will allow for us to create a server using the latest builds. You can confirm this has installed successfully by running the following command. + +```java +... + +java --version + +... +``` + +The above command should print out the latest build number for the Java 17 release we have just installed. If you have any errors you can checkout the following guide [troubleshooting java](/ts/java). + +### Creating the Minecraft server + +We are nearing the end of this guide, only a few more things to do! + +Before we download anything, we should make a directory to put our server in. You can do this by typing the following commands. + +```bash +... + +mkdir minecraft-server-folder +cd minecraft-server-folder + +... +``` + +Now we can deploy the server jar we're wanting to use, this tutorial will reference [purpur](https://purpurmc.org) but there are plenty of other server platforms and [this page](/t/server-software) explains the pros and cons of the major ones. + +```bash +... + +wget https://jar.smd.gg/download/purpur/latest/latest --content-disposition + +... +``` + +By adding the `--content-disposition` we're preventing the downloaded file being an extension-less file called `download`. + +To confirm the file has downloaded correctly you can use the `ls -al` command to display the contents of the `minecraft-server-folder`. + +```bash +... + +-rw-r--r-- 1 root root 42329978 Jul 9 08:07 purpur-1.20.1-2058.jar + +... +``` + +In order to start our server we need to create a file that accepts the EULA for Mojang. This can be done with the following command. + +```bash +... + +bash -c 'echo "eula=true" > eula.txt' + +... +``` + +We can now run the following command from the console in order to start our server, this will start the server and create all of the files it needs to run as expected. + +```bash +... + +java -Xmx4G -Xms4G -jar purpur-1.20.1-2058.jar nogui + +... +``` + +Once you see the line `Done in (seconds)` you can press `shift + c` to end the session or type `stop` like a normal server. + +So now technically everything is setup and ready - If your newly created VPS was sitting in your house you would be able to play right now... but it's not - so we need to open the 25565 port to the internet. + +#### Making it accessible over the internet (Port Forwarding) + +While we're still connected via SSH it will save time later for us to configure the servers local firewall now. + +:::info +This tutorial uses Ubuntu and UFW. If you chose another another distro at the start of this guide you will most likely have a different wrapper, if this is the case you will need to consult the docs for how best to open ports 25565 for TCP and UDP traffic. +::: + +To open TCP and UDP traffic within Ubuntu we need to use the following commands. + +```bash +... + +sudo ufw allow 22/tcp #this will allow us to continue SSH access +sudo ufw allow 25565/tcp #this will open the tcp port 25565 (minecraft game) +sudo ufw allow 25565/udp #this will open the udp port 25565 (minecraft query) +sudo ufw enable + +... +``` + +You can check UFW has successfully deployed and enabled by typing the following command. + +```bash +... + +sudo ufw status + +... +``` + +Switching back to the server, you should now be able to start the server again using the same command we used previously. + +```bash +... + +java -Xmx4G -Xms4G -jar purpur-1.20.1-2058.jar nogui + +... +``` + +You are now technically complete, you should be able to join your newly created server using the IPv4 address of the Linux box you're hosting on... There's a couple of things to note in the below 'Optional Configuration' settings which will help you down the line. + +#### Optional Configuration + +The above steps will get you up and running with the basics, but some settings can be adjusted further to make life easier for yourself as an admin. + +##### Adjusting RAM Allocation + +We go over adjusting the RAM allocation in more depth [here](/t/flags). + +##### Installing 'Screen' + +Screen is an application that allows for you to run your server in the background even after you close your SSH session. + +To install screen run the following command. + +```bash +... + +sudo apt install screen -y + +... +``` + +Now screen has been installed you can run the following commands to launch your server within screen. + +```bash +... + +screen +java -Xmx4G -Xms4G -jar purpur-1.20.1-2058.jar nogui + +... +``` + +To exit the screen session you should press `CTRL + A + D`. You should now be able to close the command prompt window without the server crashing. If you need to return to your screen windows you can use the command `screen -r`. + +##### Installing Plugins + +We go over installing plugins in more depth [here](/e/pl). + +##### JVM Flags (Aikar) + +We go over adjusting the start-up flags in more depth [here](/t/flags). diff --git a/folder/de/src/content/docs/guides/Minecraft/sftp.mdx.mdx b/folder/de/src/content/docs/guides/Minecraft/sftp.mdx.mdx new file mode 100644 index 0000000000..636a76aeff --- /dev/null +++ b/folder/de/src/content/docs/guides/Minecraft/sftp.mdx.mdx @@ -0,0 +1,84 @@ +--- +description: Learn how to upload files to Pterodactyl panels using SFTP. +slug: guides/using-sftp +title: Using SFTP +lastUpdated: 2024-08-10 +sidebar: + badge: + text: New + variant: success +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you're new to hosting a Minecraft server and you are looking to bring across a world file of your own or upload some plugins / mods to make your experience a little bit better, +this guide will focus on using SFTP in order to get around the 100MB file upload limit of the web-based file manager. + +### Requirements + +Depending on your computers operating system you will need to download one of the following SFTP tools, our tutorials will use FileZilla because this is cross platform. + +#### Windows + +The following clients are free for Windows users, there are alternatives however these are the most common and best supported solutions. + + + + + + +#### MacOS + +The Mac has a whole suite of paid SFTP products on the App Store however FileZilla is also Mac native and is the solution we recommend for this platform. + + + + + + +#### Linux (Deb) + +For simplicity we're also recommending FileZilla for Debian based distros. + + + +--- + +### Identifying your Credentials + +Once you have installed FileZilla the next step is for you to get connected to your Minecraft server. You can find the information within your provider panel, most providers are now using Pterodactyl so you need to find the following block of information below\*. + + +*Depending on your provider your panel will look different but they will all display this set of information +
+Copy the information from the `SFTP Address` and `Username` fields we will need this information within our FileZilla client. + +:::note + +Your SFTP password will be the same password you use to login to the panel, you can also configure SSH keys to use with SFTP but that is out of scope for this tutorial. +::: + +--- + +### Configuring FileZilla + +Once you have the information we're going to 'create a site' so we don't need to input this data everytime we want to file transfer, to do this select the site manager in the top left corner. + + + +Select 'New Site' and you can now fill in the section on the right hand side, you should change Protocol from FTP to SFTP else you will run into issues while connecting. + + + +Once you have copied this information over you should press 'Connect' and you will be presented with one final confirmation window, select 'Always trust this host' and then press 'Ok'. + + + +You will now be connected to your server via SFTP, you can upload/download, edit or delete files from the highlighted window below. + + diff --git a/folder/de/src/content/docs/guides/OVH/Optional/Configuration/hardening.mdx.mdx b/folder/de/src/content/docs/guides/OVH/Optional/Configuration/hardening.mdx.mdx new file mode 100644 index 0000000000..346dda5c95 --- /dev/null +++ b/folder/de/src/content/docs/guides/OVH/Optional/Configuration/hardening.mdx.mdx @@ -0,0 +1,249 @@ +--- +description: Device hardening guide and and explantion of the tools used to complete such activities. +slug: guides/lab/hardening +title: Hardening +sidebar: + badge: + text: Recommended + variant: tip +--- + +This document is designed specifcally for those who want to tighten up windows and add some preventative measures to lock down their machine, it should be made known that the more you lock down a machine the less functionality it will have. + +You should find a balance for your own environment that works best for you by either disabling or enhancing the provided policies, this page breaks down the NCSC guidelines for systems hosting '[OFFICAL](https://smd.gg/jx9p7xw)' data. + +### Windows Home + +As home based editions of Windows cannot use Group Policy below are some things you should look into securing and enabling. + +#### Permissions + +When setting up a new environment it's easy to give anything and everything full admin credentials in order to get something up and running but STOP and take the time to do things right. You should consider implementing a [principle of least privilege](https://www.f5.com/labs/articles/education/what-is-the-principle-of-least-privilege-and-why-is-it-important) from the get-go as it: + +- Enables greater control over who can manage / change a system +- Reduces the level of damage compromised accounts can cause +- Reduces the attack surface (entry points) +- Reduces risk through error / negligence / internal malicious attacks + +While Home users can't use Group Policy for file permissions it can all be easily controlled via the Windows UI, as part of the least privilege principle this will assist in ensuring data access is only performed on a 'need to know' / 'required for function', you can find a good explanation for this [here](https://youtu.be/S-tTcRC5Q2A?t=123) + +#### Patching + +Patch Tuesday, the second Tuesday of every month is the most important Tuesday in the calendar for your computer. It's the day that Microsoft delivers important updates that will address potentially dangerous exploits that can give an attacker full complete access to your machine, unless the machine will never be connected to the internet again after being deployed you should enable 'Automatically check for Windows Updates' (in Windows 10/11 you shouldn't be able to disable this via the settings UI). + +#### Applications + +Firstly, every application on your system is a potential entry point for an attacker, if you're never going to use it then uninstall it! This includes Windows features too, it's recommended that you atleast uninstall the following Windows features: + +- Internet Explorer +- SMB 1.0 + +This can be done by going to 'Control Panel' > 'Uninstall a program' > 'Turn Windows features on or off' and removing the tickbox next to the above entries. + +:::tip +A reboot will be required after completing this step +::: + +#### Windows (Defender) Security + +The following settings are configured within 'Windows Security' application and _should_ be enabled by default but regardless it's important to check. + +- Reputation based scanning is configured under the 'App and Browser control' setting +- Core Isolation is configured under the 'Device security' setting + - Memory Integrity is also a feature enabled within this section but you will need to 'View details' before you can toggle this on +- Exploit protection is configured under the 'Device security' setting along side the below nested items for this category + - Control Flow Guard + - Data Execution Protection + - Mandatory ASLR + +#### Windows OS + +There are a couple of things that are recommended if you're not actively using these features, firstly disable bluetooth if you're not using it and secondly turn off auto play as it has previously been used to exploit systems. + +- Autoplay settings can be found under 'Settings' > 'Devices' > 'Autoplay' + +--- + +### Windows Pro / Enterprise + +You can download the Group Policy template files from [here](https://github.com/ukncsc/Device-Security-Guidance-Configuration-Packs/raw/main/Microsoft/Windows/GPO/NCSC_Windows_GPO.zip). + +#### App Guard Policies + +The Windows App Guard policy will make the following changes to your PC. + +- General hardening of Defender App Guard policies. + +#### App Locker Policies + +The Windows App Locker policy will make the following changes to your PC. + +- Allows only execution of Microsoft signed applications, dlls, installers, scripts and appx + +:::tip +Development machines should be excluded from this policy otherwise they may end up not being able to run the required tools. +::: + +#### Bitlocker Policies + +The Windows bitlocker policy will make the following changes to your PC. + +- Disables standby mode when sleeping +- Encrypts the drive with XTS-AES 128 +- Disables devices such as thunderbolt that have direct memory access while a device is sleeping +- TPM bitlocker settings are configured +- Deny write access to removable media for devices configured to work with another organisation + +#### Computer Policies + +The Windows computer policy will make the following changes to your PC. + +- Prevents login with personal Microsoft accounts +- Disables user trusted root CAs +- Disables the ability for users to trust certificates +- Defines trusted root CAs for the device to use +- Prevents lock screen camera +- Requires a domain admin to change network location +- Defines proxy values +- Prevents installation of devices that match X hardware IDs +- Prevents installation of devices that use drivers matching X setup classes +- Disables Windows 'PC-Phone' link +- Disables sign-in with picture login +- Disables clipboard history +- Disables clipboard sync across devices +- Disables upload and publishing of user activities +- Disables activity feed +- Blocks universal windows apps from launching with Windows runtime API +- Removes the display password button on login forms +- Disables telemetry gathering +- Disables diagnostic data viewer +- Disables windows-to-go +- Disables cortana +- Disables search the web in windows start menu +- Disables all store applications within the MS Store +- Disables the MS Store +- Disables syncronisation of windows settings +- Ensures defender is enabled +- Disables windows error reporting +- Ensures Windows Hello is enabled for TPM 2.0 and disables lower +- Removes access to 'pause windows updates' +- Disables preview builds of windows +- Ensures a semi-annual release channel is configured using Windows update for business +- Disables Edge data collection +- Disables further telemetry +- Removes local password reset questions +- Edge pre-loading tabs disabled +- Edge extension sideloading disabled +- Blocks non-admins from enterting the device into safe-mode + +#### Device Guard + +The Windows device guard policy will make the following changes to your PC. + +- Enables virtualisation based securty +- Ensures code integrity +- Ensures credential guard is configured +- Ensures secure boot and direct memory access protection is configured + +:::tip +When enabling this policy you will need to ensure the VMs are created with Nested support otherwise Credential guard will fail to deploy. Option B would be to disable the 'Turn on Virtualisation Based Security' policy located in 'Computer Configuration' > 'Policies' > 'Administrative Templates' > 'System' > 'Device Guard' +::: + +#### Device Health + +This policy can be considered optional unless the device is enrolled into SCCM or another MDM platform. + +- Enables Device Health monitoring and reporting services + +#### Firewall Settings + +You should add further rules here if additional services are required for the network otherwise additional device / group based policies should be created using the 'Duplicate' feature and adding additional policies. + +- Enables Windows firewall +- Blocks inbound connections (unless explicitly stated) +- Allows outbound connections +- For both 'Private' and 'Personal' network settings outbound connections are blocked +- Configures outbound rules for the following services + - DHCP + - DNS + - Kerbose + - LDAP + - NCSI Probe + +#### OneDrive Settings + +This policy is entirely optional for home / lab environments where Office 365 business / dev subscriptions are not present. + +- Prevents personal OneDrive accounts syncing + +#### User Settings + +This policy is entirely optional but recommended for laptops / busy environments. + +- Ensures screen lockout time is set to 600 seconds + +#### Windows Defender + +The Windows defender policy will make the following changes to your PC. + +- Enables block on first sight +- Enrolls device to Microsoft MAPs (requirement for 'block on first sight' to work) +- Send sample file analysis +- Ensures real-time protection is enabled +- Prevents app installation from sources outside of the Microsoft Store +- Ensures smart screen is configured for Windows +- Ensures smart screen is configured for Edge +- Prevents you from being able to bypass the smartscreen prompt + +#### Installation Guide + +For Active Directory deployments you should use `Group Policy Management Editor` to import the policies. + +For single machine deployments you should consider `Powershell` to import the policies, the below command may help. + +```powershell + +... + +import-gpo -BackupId {folder-name} -TargetName {gpo} -path {c:\full\path\to\folder} -CreateIfNeeded + +... +``` + +#### Closing Thoughts + +From using these settings within our own environment you will want to make some changes, most specifically in the following areas. + +- Windows Firewall (opening RDP will prevent you needing to use proxmox viewer) +- App Guard (you will want to add any core non-ms apps you use in this policy e.g. chrome, firefox, vscode... anything that isn't published by Microsoft Corporation) + +--- + +### Ubuntu Script + +You can download the post-deployment bash script from [here](https://github.com/ukncsc/Device-Security-Guidance-Configuration-Packs/tree/main/Linux/UbuntuLTS) and manually run it on the server. + +Ubuntu, unlike Microsoft, does not require a certain edition for the script to work, at the time of writing this script worked on the latest LTS build of Ubuntu. + +#### Script break down + +- Firstly the script must be run as 'sudo' +- Secondly it will fetch the admin user +- You will then need to select the administrator account that you created during installation +- You will confirm the app repositories +- The system will complete an update, upgrade and install app armour +- Grub password is configured +- Automatic updates are configured +- Prevents standard users executing as `super user` +- Protects home directories +- Modified shell access for other users on the machine except admin account specified +- Configures pw complexity +- Enables app armour +- Enables system audting +- Disables error reporting service +- Option to disable Bluetooth +- Configures 600s lock screen timer +- Modifies lockscreen behaviour +- Optional settings for location services, privacy and usb restrictions +- Fixes folder permissions +- Sets up UFW without any rules diff --git a/folder/de/src/content/docs/guides/Services/domainpark.mdx.mdx b/folder/de/src/content/docs/guides/Services/domainpark.mdx.mdx new file mode 100644 index 0000000000..97c253e891 --- /dev/null +++ b/folder/de/src/content/docs/guides/Services/domainpark.mdx.mdx @@ -0,0 +1,85 @@ +--- +description: Hoste selbst eine Instanz von domain-park.org für zusätzliche Domains, welche du nicht nutzt. +slug: guides/domain-parking +title: Domain Parking +--- + +Wenn du mehrere Domains besitzt, kann es sich lohnen, einen Dienst wie `domain-park` zu nutzen. Somit wird sichergestellt, dass diese Domains sicher bleiben, auch wenn du sie nicht benutzt. Zum Glück ist domain-park ein Open-Source-Projekt und implementiert die folgenden Funktionen: + +- Beste Vorgehensweise für das Einhalten der Vorschriften von SPF, DKIM, DMARC und MX für geparkte domains +- Einfacher Bereitstellung ohne Serverkonfiguration pro Domain +- Möglichkeit zur Konfiguration von DMARC-Berichten + +Wenn du dich dafür entscheidest, eine Instanz (oder zwei) von Domain Park zu betreiben, solltest du die folgende Konfiguration anstreben: + +- Eine Domain, die du für alles benutzt, z.B. `servers.fun` +- Eine Domain, die du parken willst, z.B. `urho.st` +- Einen VPS (oder zwei) mit statischen (und öffentlichen) IP-Adressen, denen wir Hostnamen zuweisen können +- Ein DNS-Verwaltungspanel wie `Cloudflare DNS` + +:::danger +Die Cloudflare-Registry unterstützt keine externen Nameserver. Wenn du eine Domain bei Cloudflare registriert hast und diese dann auch parken möchtest, musst du eine alternative Lösung verwenden. +::: + +--- + +### Einen VPS erstellen + +Wenn du auf der Suche nach einem soliden VPS-Anbieter bist, schau dir Hetzner an. You can use our affiliate link https://smd.gg/joinhetzner for €20 free credit and in return we'll also get a little bit back from Hetzner. + +Wenn du Hetzner verwendest, solltest du 2x `CPX11 Instanzen` bestellen. Für das Betriebssystem sollte der neuste LTS-Build von Ubuntu (Debian funktioniert auch) installiert werden. Die Kosten sollten sich auf ca. 10€/Monat Belaufen. Es wird außerdem empfohlen, einen SSH-Schlüssel hinzuzufügen um eine passwortbasierte Authentifizierung zu vermeiden. + +--- + +### Setting up DNS (Active) + +So the first thing we will do is configure the DNS, this is because these _can_ take the longest to update in the background. + +- Login to your DNS provider and head to your DNS record section. +- Select 'Add' and create an `A Record` enter `one.ns` and point it to one of your VPS IPs + - **Optional**: If you have an IPv6 also add a `AAA Record` for the same hostname +- Repeat this but replace `one.ns` with `two.ns` + +:::tip + +If you're using Cloudflare for your "Active Domain" you should ensure the orange cloud is disabled. + +::: + +Once you have configured these addresses your DNS panel should look something like this. + +![IMG](https://uk.thot.cc/api/shares/U3NTk4N/files/7bb07f91-af5d-4741-bd3f-7cb20421e586?download=false) + +After a short while your records will have propagated and you should be able to check the A and AAA records for your hostname using a tool such as MXToolbox or the `dig` linux package. + +#### Dig Commands + +```bash +... + +dig one.ns.servers.fun A +dig one.ns.servers.fun AAA # Not configured in example + +dig two.ns.servers.fun A +dig two.ns.servers.fun AAA # Not configured in example + +... +``` + +Providing you replace `servers.fun` with your own domain you should see a response with the IP addresses you entered into your panel above. + +--- + +### Setting up DNS (Parked) + +On the domain you wish to park using your newly setup service you'll need to change your nameservers. You can do this within your domain's control panel (probably in a similar location to the DNS modification page). + +You should ensure you fill out the nameservers as per the screenshot below. Once these have been added correctly, save changes and await up-to 48 hours for this to complete. + +![IMG](https://uk.thot.cc/api/shares/Y2NjM0O/files/471bcb1d-42bf-4e52-a9b2-be56323eb3c5?download=false) + +When using these nameservers you will not be able to host **ANY** content via the domain as domain-park does not allow for it. We have configured our nameservers to redirect to this page when accessing any of our IPs / Hostnames directly. + +--- + +### Deploying Domain-Park diff --git a/folder/de/src/content/docs/guides/Services/oracle.mdx.mdx b/folder/de/src/content/docs/guides/Services/oracle.mdx.mdx new file mode 100644 index 0000000000..ad26338841 --- /dev/null +++ b/folder/de/src/content/docs/guides/Services/oracle.mdx.mdx @@ -0,0 +1,330 @@ +--- +description: A modified version of the guide produced by u/Belaboy1095969 on the Admincraft reddit using Ubuntu LTS. +title: Oracle Cloud +slug: guides/oracle-cloud +--- + +:::note + +Due to the increased popularity of the Oracle free tier, services may not be available in your desired region at the time of creating your account. You can either use another region close to your playerbase, wait until free capacity becomes available within your desired region or migrate to a paid account. + +::: + +This guide originally comes from the Admincraft subreddit user [u/Belaboy1095969](https://www.reddit.com/r/admincraft/comments/qo78be/creating_a_minecraft_server_with_oracle_cloud/), with full prior permission we have re-uploaded this tutorial into our central repository. + +If you're looking to host a basic server that is kept online (for free, 24/7) that you and your friends can play on then this is the guide for you. This guide comes with the following expectations, further expansion on some of these points can be requested within the setup.md [discord server](https://discord.gg/pXaQgzneed) if required. + +### You Will Need + +- A ~~Java Minecraft Account~~ Minecraft license, as of 07 June 2022 these games are now [bundled together](https://www.minecraft.net/en-us/article/java---bedrock-edition-pc-out-june-7). +- A credit / debit card for oracle account verification (anti-bot process) + +--- + +### Getting Started + +This guide will assume you have already gone through the sign-up process for the [OCI console](https://signup.cloud.oracle.com/?sourceType=_ref_coc-asset-opcSignIn&language=en_US). Once this step has been completed you can follow the rest of this guide. + +#### Creating a Virtual Machine instance. + +Don't Panic! This part isn't as complicated as it sounds. Once you have finished setting up your account, click the "Create a VM instance" panel. + +![img1](https://preview.redd.it/lb6qbe1fd0y71.png?width=912&format=png&auto=webp&s=eb13c09a39b8c9b4d8e8d6a7de588d96a4847afe) + +Give your VM instance a name. Anything will work, but make it easily identifiable. You can leave the default (Root) compartment selected. + +![img2](https://preview.redd.it/z0fcocxpd0y71.png?width=792&format=png&auto=webp&s=99637b502a83ff60f5189a73a77cfb5a88304e7f) + +Now, Scroll down to the "Image and Shape" section. Make sure "Ubuntu LTS 22.04 (Or just the latest build)" Is selected. Then click "Change shape". Under "Shape series", Select "Ampere". Now set the amount of Ram and CPU Cores you would like. + +:::tip +You should allocate no less than 2 CPU Cores and 8GB of ram to the VPS. After you have finished selecting the shape, make sure the "Always free eligible" Tag is showing. + +![img3](https://preview.redd.it/32bkfk8te0y71.png?width=757&format=png&auto=webp&s=d7f50ceae622064c9590c9ef41f82afdce809fed) + +::: + +Next, we need to create a VCN (Or Virtual Cloud Network). If you already have a VCN, use that. If not, select "Create a Virtual Cloud Network" Copy the settings in the picture below! + +![img4](https://preview.redd.it/xtozv7u9f0y71.png?width=766&format=png&auto=webp&s=6d1c1643aa182fc52b418854d95763bc19996c90) + +We'll need an SSH Key pair to access the server remotely. To generate a keypair, tick the box that says "Generate a new keypair" and then download both the public and private keys. Don't lose these, or else you won't be able to connect to your server remotely! + +![img5](https://preview.redd.it/rzk6yq65g0y71.png?width=791&format=png&auto=webp&s=1fcc085a62f2235d9fd179bb9bff1625ed95055b) + +Leave the boot volume settings alone and hit "Create"! + +Once you hit "Create", you will be redirected to your VM details and your VM will be in a "Provisioning" state. Wait for it to be in a running state, which should take 30-60 seconds. Under the "Instance access", you should see an IP Address. Copy it. + +#### Connecting to your VM with SSH. + +There are multiple SSH clients out there from classics such as PuTTY and newer clients such as Termius. For simplicity and universal sake we will use a command prompt / terminal window. + +Open a command prompt / terminal window and type in the following command : + +```bash +... + +ssh root@ -i "path-to-ssh-private.key" + +... +``` + +As this is your first time connecting you'll need to 'accept' either by pressing `Y` or typing `Yes` in the confirmation box. You should then see a screen similar to the below. + +![img6](https://preview.redd.it/ix7ilvzyl0y71.png?width=970&format=png&auto=webp&s=580fa11dcbce68b0dc12bb9e2ddd8e3d832830fc) + +Our VM is now deployed and ready to configure with Java and our server. + +#### Installing Java + +Ubuntu uses the `APT` package manager, it's generally considered a good idea to run the following commands before trying to install an application for the first time. + +```bash +... + +sudo apt update +sudo apt upgrade -y + +... +``` + +Once you've ensured the package list has been updated and installed packaged upgraded you can proceed with installing java depending on which Minecraft version you're looking to install you may need to change this command slightly. + +To identify which versions of JRE are installable you can run the following command. + +```bash +... + +apt search "jre-headless" + +... +``` + +This should result in the following output. + +```bash +... + +Sorting... Done +Full Text Search... Done + +default-jre-headless/stable,stable 2:1.11-72 amd64 + Standard Java or Java compatible Runtime (headless) + +openjdk-11-jre-headless/stable,stable-security,stable,stable-security 11.0.14+9-1~deb11u1 amd64 + OpenJDK Java runtime, using Hotspot JIT (headless) + +openjdk-17-jre-headless/stable,stable-security,stable,stable-security 17.0.2+8-1~deb11u1 amd64 + OpenJDK Java runtime, using Hotspot JIT (headless) + +... +``` + +:::info +Java 16 was not an LTS release and therefore isn't present in the list. + +You can now run the following command changing the `version-number` to determine if you would like to install Java 8, Java 11 or Java 17. + +::: + +```bash +... + +sudo apt install "openjdk-17-jre-headless" -y + +... +``` + +The above command will install Java 17 and will allow for us to create a server using the latest builds. You can confirm this has installed successfully by running the following command. + +```bash +... + +java --version + +... +``` + +The above command should print out the latest build number for the Java 17 release we have just installed. If you have any errors you can checkout the following guide [troubleshooting java](/ts/java). + +### Creating the Minecraft server + +We are nearing the end of this guide, only a few more things to do! + +Before we download anything, we should make a directory to put our server in. You can do this by typing the following commands. + +```bash +... + +mkdir minecraft-server-folder +cd minecraft-server-folder + +... +``` + +Now we can deploy the server jar we're wanting to use, this tutorial will reference [purpur](https://purpurmc.org) but there are plenty of other server platforms and [this page](/t/server-software) explains the pros and cons of the major ones. + +```bash +... + +wget https://jar.smd.gg/download/purpur/latest/latest --content-disposition +# You can replace 'purpur' for 'paper' if you prefer. +wget https://jar.smd.gg/download/purpur/latest/latest --content-disposition + +... +``` + +By adding the `--content-disposition` we're preventing the downloaded file being an extension-less file called `download`. + +To confirm the file has downloaded correctly you can use the `ls -al` command to display the contents of the `minecraft-server-folder`. + +```bash +... + +root@vps:~/minecraft-server-folder# ls -al +total 41348 +drwxr-xr-x 2 root root 4096 Jul 9 16:59 . +drwx------ 7 root root 4096 Jul 9 16:59 .. +-rw-r--r-- 1 root root 42329978 Jul 9 08:07 purpur-1.19-1708.jar + +... +``` + +In order to start our server we need to create a file that accepts the EULA for Mojang. This can be done with the following command. + +```bash +... + +bash -c 'echo "eula=true" > eula.txt' + +... +``` + +We can now run the following command from the console in order to start our server, this will start the server and create all of the files it needs to run as expected. + +```bash +... + +java -Xmx6G -Xms6G -jar purpur-1.19-1708.jar nogui + +... +``` + +Once you see the line `Done in (seconds)` you can press `shift + c` to end the session or type `stop` like a normal server. + +So now technically everything is setup and ready - If your newly created VPS was sitting in your house you would be able to play right now... but it's not - so we need to open the 25565 port to the internet. + +#### Making it accessible over the internet (Port Forwarding) + +While we're still connected via SSH it will save time later for us to configure the servers local firewall now. + +:::info +This tutorial uses Ubuntu and UFW. If you chose another another distro at the start of this guide you will most likely have a different wrapper, if this is the case you will need to consult the docs for how best to open ports 25565 for TCP and UDP traffic. +::: + +To open TCP and UDP traffic within Ubuntu we need to use the following commands. + +```bash +... + +sudo ufw allow 22/tcp #this will allow us to continue SSH access +sudo ufw allow 25565/tcp #this will open the tcp port 25565 (minecraft game) +sudo ufw allow 25565/udp #this will open the udp port 25565 (minecraft query) +sudo ufw enable + +... +``` + +You can check UFW has successfully deployed and enabled by typing the following command. + +```bash +... + +sudo ufw status + +... +``` + +The next steps are to do the same things within the Oracle Cloud interface. You will need to look for the category "Primary VNIC". Click the "Public Subnet" link. + +![img7](https://preview.redd.it/puhdgco6s0y71.png?width=724&format=png&auto=webp&s=62c56c8262c55129000a90726e05aa4de4039d19) + +Then click the "Default Security list" link. + +![img8](https://preview.redd.it/2poaepmcs0y71.png?width=537&format=png&auto=webp&s=3fa87f551aa084e5fb23699c670dab2a4d6c4d8a) + +And Add an "Ingress Rule". Copy the configuration shown here ,Then create another ingress rule with the same configuration, but change the "IP Protocol" to TCP, as shown below. + +![img9](https://preview.redd.it/23cjw70hs0y71.png?width=756&format=png&auto=webp&s=e33b04dab55c625d3fc68fd15c1d6adc7871c78c) + +Switching back to the server, you should now be able to start the server again using the same command we used previously. + +```bash +... + +java -Xmx6G -Xms6G -jar purpur-1.19-1708.jar nogui + +... +``` + +You are now technically complete, you should be able to join your newly created server and share the IP with your friends... There's a couple of things to note in the below 'Optional Configuration' settings which will help you down the line. + +#### Optional Configuration + +The above steps will get you up and running with the basics, but some settings can be adjusted further to make life easier for yourself as an admin. + +##### Adjusting RAM Allocation + +We go over adjusting the RAM allocation in more depth [here](/t/flags). + +##### Installing 'Screen' + +Screen is an application that allows for you to run your server in the background even after you close your SSH session. + +To install screen run the following command. + +```bash +... + +sudo apt install screen -y + +... +``` + +Now screen has been installed you can run the following commands to launch your server within screen. + +```bash +... + +screen +java -Xmx6G -Xms6G -jar purpur-1.19-1708.jar nogui + +... +``` + +To exit the screen session you should press `CTRL + A + D`. You should now be able to close the command prompt window without the server crashing. If you need to return to your screen windows you can use the command `screen -r`. + +##### Installing Plugins + +We go over installing plugins in more depth [here](/e/pl). + +##### JVM Flags (Aikar) + +We go over adjusting the start-up flags in more depth [here](/t/flags). + +--- + +### **Disclaimer** + +This guide has been modified slightly to cater for the needs of this project, setup.md has adjusted the following from the original article. + +- Moved from Oracle Linux to Ubuntu LTS +- Moved some Optional Configuration topics to either their own pages within our KB / hyperlinked to existing documents (this prevents topic duplication). +- Ordering / Combining of steps in relation to EULA and port forwarding. + +--- + +### Additional Note + +While Oracle cloud is great, ARM CPUs will fall short in high-demand workloads when it comes to Minecraft servers. If you find yourself outgrowing the Oracle instance you can check out the following [hosting guide](/h/types). diff --git a/folder/de/src/content/docs/hosting/bad-rep-providers.mdx.mdx b/folder/de/src/content/docs/hosting/bad-rep-providers.mdx.mdx new file mode 100644 index 0000000000..353bc7ff76 --- /dev/null +++ b/folder/de/src/content/docs/hosting/bad-rep-providers.mdx.mdx @@ -0,0 +1,6 @@ +--- +title: Bad Rep Hosts +description: A list of hosting providers that are considered 'summerhosts', reckless and just outright something you should avoid. +template: splash +slug: /h/bad-rep-providers +--- diff --git a/folder/de/src/content/docs/hosting/hardware.mdx.mdx b/folder/de/src/content/docs/hosting/hardware.mdx.mdx new file mode 100644 index 0000000000..5481009452 --- /dev/null +++ b/folder/de/src/content/docs/hosting/hardware.mdx.mdx @@ -0,0 +1,52 @@ +--- +description: Picking the right hardware is the most important thing when it comes to hosting as it will determine how far you can push your ideas before you have to throttle back or risk destroying the user experience. +slug: h/hardware +title: Hardware +--- + +If you haven't identified the type of hosting you wish to go for it's highly recommended to read our [types of hosting](types) document first. + +:::note +The first point we want to stress is **do not go out and buy the latest flagship CPU for a single Minecraft server**. This is a complete waste of money and you will not be able to utilise the full CPU, you should however find a hosting provider that offers the desired CPU line up and use 'shared hosting'. +::: + +### CPU + +When it comes to finding a CPU (for Minecraft) the most important factor is the [IC](https://www.bbc.co.uk/bitesize/guides/z2342hv/revision/5), this consists of a fetch, decode, read and execute cycle all taking place to complete a single cycle. + +Depending on your workload, CPU Cache & Instruction Sets should also be considered as one CPU might be better at a particular set than another (it's important to complete your own research based on your needs). + +The myth of clock speed being the sole performance factor has been disproven many times over, Apple being the most famous example that often compared a lower clock speed PowerPC to the newer Pentium 3/4 line ups from IBM and similar. + +At its core Minecraft's main logic loop is a single thread this is a fundamental issue that dictates how it runs. Consequently, Minecraft is primarily concerned with single core performance. You still need at least two cores however, the second is to offload things like Garbage Collection and non core logic threads (networking, io) to so they don't steal time from the main loop. + +--- + +### RAM + +RAM is not nearly as important as people think, fast RAM is as important ([it's benefits only go as far as your chosen CPU](https://premiumbuilds.com/features/ryzen-ram-speed-benchmark-analysis/)) as the capacity and over capacity of RAM can hurt your performance (this is because the JVM garbage collector has more to collect and therefore this intensive CPU task takes longer causing lag spikes). + +The general consensus as of late 2022 is to start with using 4GB / 6GB but use no more than 12GB per individual server. + +Memory allocation and Java Flags go hand in hand with one another and some flags (specifically Aikar's) have some values that change based on the total RAM allocation to your server. + +If you're running in Docker consider overhead for the JVM, this should be about 1/2GB that you will need to compensate for (sometimes the host will take care of this step for you). + +--- + +### Storage + +For your server's live application data it's the current consensus to at least be using some form of flash storage as the random read/write speeds can help massively when it comes to users spawning in chunks all over the map. + +For backups you are still more than welcome to use spinning disks as this data hopefully isn't used as often - it's also possible to configure archival s3 based storage (cold-site) which could end up cheaper than buying and protecting your own disks. + +--- + +### Recommended Specs + +If you're looking for specific specs we'd recommend using the below as a baseline. + +| SKU | CPU | RAM | DISK | +| ---------- | --------------------------------------------------- | ---------- | ------------------------------- | +| Budget | Intel 9th - 12th Gen / Ryzen 9 3000 - Ryzen 7 5800X | 4GB - 6GB | 30GB (NVMe) | +| Enthusiast | Intel 13th & 14th Gen / Ryzen 9 5900X & 7000 Series | 8GB - 12GB | 75GB+ (NVMe) | diff --git a/folder/de/src/content/docs/hosting/intro.mdx.mdx b/folder/de/src/content/docs/hosting/intro.mdx.mdx new file mode 100644 index 0000000000..acbee77d6a --- /dev/null +++ b/folder/de/src/content/docs/hosting/intro.mdx.mdx @@ -0,0 +1,22 @@ +--- +sidebar_position: 1 +description: The entry point for those looking to host a Minecraft server but don't know where to start. +slug: h +title: Where To Start +--- + +If you're looking to run a Minecraft server of your own there are multiple things you should consider. + +
    +
  • Where do you want to host it?
  • +
  • How do you want to host it?
  • +
  • Do you want the ability to be able to host more than Minecraft?
  • +
+ +Our goal is to cover all of this and offer our own recommendations on providers you can use for all possibilities, some key articles can be found below. + +| Topic | KB Article | Summary | +| ----------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| Service Offerings | [Types](types) | Identify what different types of hosting exist, what should be used and when. | +| Hardware | [Hardware](hardware) | The second most important decision is determining how powerful you need the hardware to be for the work you're wanting to push on it. | +| Providers | [CSPs](providers) | Non-biased recommendations for hosting providers based on previous experience and their industry position. | diff --git a/folder/de/src/content/docs/hosting/os.mdx.mdx b/folder/de/src/content/docs/hosting/os.mdx.mdx new file mode 100644 index 0000000000..f82b1b4301 --- /dev/null +++ b/folder/de/src/content/docs/hosting/os.mdx.mdx @@ -0,0 +1,30 @@ +--- +description: Let's discuss the major operating systems that you will come across when hosting a Minecraft server. +slug: h/os +title: Operating Systems +--- + +When running a Minecraft server on [bare metal](/h/types/#bare-metal--vds), or a [VPS](/h/types#virtual-private-servers) you'll need to install a base operating system before you can get started. Unless you're running an apple device your options are Windows / Windows Server or Linux and the abundance of distros that come along with it. + +This page will explain the common choices available. + +
    +
  • Windows (Desktop and Server)
  • +
  • Ubuntu LTS
  • +
+ +### Windows + +If you're looking to host a server for your friends then the easiest option for self-hosting is Windows, you're already using it and if you're going to use a cloud provider for a server they will include a monthly fee for Windows Server. At their core both OSes are 'the same' and for Minecraft running a personal server within Windows 10/11 from your home PC will be fine. + +Moving to Windows Server will give you a couple of advantages, primarily longer OS support - these tend to follow a N+10 policy when discussing depreciation which is normally a good few years more than standard desktop releases. + +Windows Server OS is lighter out of the box and includes nothing but the core files needed to get Windows functional which compared to the desktop OS could see a perf gain with less resource wastage and can slightly reduce your attack surface by ensuring there are no little to none un-patched applications installed / configured. + +--- + +### Ubuntu LTS + +Unofficially you can also throw the base 'Debian' into this argument too however with Ubuntu Pro now becoming a free feature (for up to 5 devices) it's a huge win for the home lab. Ubuntu Pro offers 10 years of LTS patches so now follows a Windows Server like support plan which will save a lot of hassle needing to move your Instance from one release to another. + +If you want to get into the more professional side of hosting, Linux is the way to go - it's further optimised and will let you get the absolute most performance out of the hardware as possible. Day-to-day you will be interfacing with this OS through a command line but unlike Windows Server if you go to a CSP you won't be charged for these, web-based game management portals do exist for those on Linux who don't want to manage everything via the CLI. diff --git a/folder/de/src/content/docs/hosting/panels.mdx.mdx b/folder/de/src/content/docs/hosting/panels.mdx.mdx new file mode 100644 index 0000000000..a818326256 --- /dev/null +++ b/folder/de/src/content/docs/hosting/panels.mdx.mdx @@ -0,0 +1,137 @@ +--- +description: You don't always want to be using the CLI to manage your server, consider a web panel and share the responsibility with your other administrators. +slug: h/ui +title: Panels +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you're running a Minecraft server the chances are you'll want an easier method of management, this is where panels come into play. Every [shared hosting](types#shared-hosting) provider will come with a control panel, this is how you'll interface with your server normally at a URL similar to https://panel.mydomain.com. Depending on how long the provider has been in business they'll either be using Multicraft or Pterodactyl (newer hosts using the latter). + +While Multicraft and Pterodactyl became the widely adopted platforms for Minecraft hosting this doesn't mean they're the only players in the game and with a VPS / Bare Metal you can install any one of a number of different solutions. We could write this article for the next six months documenting every single different panel and why it should be used but we're going to focus on a couple. + +The top 4 shortlisted panels this article will be covering are. + +
    +
  • AMP
  • +
  • Moonlight
  • +
  • Pterodactyl
  • +
  • PufferPanel
  • +
+ +### AMP Windows & Linux only + +AMP is a licensed panel produced by CubeCoders which supports both Windows and Linux including Ubuntu, Debian, Arch, Cent OS and more. CubeCrafters are by no means new to the hosting game, their previous product McMyAdmin launched all the way back in 2013. + +At this time there is **NO** Apple builds so for legacy McMyAdmin2 users this product may not be suitable for you unless you're running boot camp or run your servers on a different machine. + +#### Pros + +
    +
  • Community backed game contributions
  • +
  • Migration path for McMyAdmin2 users
  • +
  • One click/line installers
  • +
  • Proactive support
  • +
  • Support for many popular titles
  • +
+ +#### Cons + +
    +
  • Licensed
  • +
  • Multiple security requirements before installable (principle isn't a con but it's a pain)
  • +
  • Not open-source
  • +
+ + + + + + +--- + +### Moonlight Linux only + +Moonlight is an up and coming panel solution that is aimed towards those looking to replace Pterodactyl. The project is still in it's early phase and we've been pleased with the outcome so far in small scale testing and has therefore made our list as a one to watch. + +#### Pros + +
    +
  • Automatic plugin installer
  • +
  • Automatic SRV record creator
  • +
  • One click/line installers
  • +
  • Migration guide for Pterodactyl installs
  • +
  • Support for pterodactyl eggs (kind of)
  • +
  • Many more features constantly being added
  • +
+#### Cons +
    +
  • No billing support at this time
  • +
  • Lack of third party modifications
  • +
+ + + + + + +--- + +### Pterodactyl Linux only + +Multicraft had to die for Pterodactyl to breathe, an open source panel in active development and great support behind it. For those who like the sound of pterodactyl but not the self-hosting setup process you can look at the SaaS version [WISP](https://wisp.gg) which will cost you around $5 a month for the community plan. + +Pterodactyl boasts a two part setup, a web-server and a docker agent (wings) that only has official support for Linux. WSL has no official support same with Mac OS, you may find better luck utilising their 'panel-in-docker' and 'wings-in-docker' if you wish to attempt an install on either of these platforms. + +#### Pros + +
    +
  • ARM instruction set support
  • +
  • Billing integration for WHMCS / Blesta
  • +
  • Industry standard tool
  • +
  • Marketplaces for third party panel enhancements
  • +
+#### Cons +
    +
  • Complex multi-stage setup process
  • +
  • Setup support can be hit or miss (you're normally told to RTFM)
  • +
+ + + + + + + +--- + +### PufferPanel Linux only + +PufferPanel could have been the Pterodactyl industry standard tool today, a panel formerly developed by a Pterodactyl team member prior to a clashing of heads and a splitting of the product, however PufferPanel remains open source and in active development by the original founder and an long-time dev. + +The situation is the same for PufferPanel as it is for Pterodactyl, only has official support for Linux, however Windows builds are available (if unsupported). + +#### Pros + +
    +
  • One click/line installers via APT/YUM
  • +
  • ARM instruction set support
  • +
+ +#### Cons + +
    +
  • Lack of industry adoption / third party support
  • +
  • No billing modules
  • +
+ +:::note +PufferPanel (OSS Project) should not be confused with the proprietary puffer panel used by https://pufferfish.host, **these are two separate entities**. +::: + + + + + + diff --git a/folder/de/src/content/docs/hosting/providers.mdx.mdx b/folder/de/src/content/docs/hosting/providers.mdx.mdx new file mode 100644 index 0000000000..fbc621c431 --- /dev/null +++ b/folder/de/src/content/docs/hosting/providers.mdx.mdx @@ -0,0 +1,207 @@ +--- +description: This page should be used as a reference to hosting providers and is not a substitute for their trustpilot and / or other clients real world experiences. +slug: h/providers +title: Providers +--- + +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +With the game becoming as big as it has done over the last decade there have been hundreds of hosting providers of past and present that either deliver high-quality services or awful services that someone could pay you enough to use daily. The goal with this page is to highlight a few trustworthy names in the Industry that meet the following criteria. + +
    +
  • Deliver to audiences at scale
  • +
  • Developed an overall positive reputation
  • +
  • Modernises hardware when required
  • +
  • Respectable end product for the price paid
  • +
+ +It should be made clear that none of the references below are sponsored. + +:::tip +If you don't know what kind of hosting you need, it's recommended to checkout the following article here to understand the different available platforms. +::: + +### Bloom.host + +Unparalleled price to performance with dedicated resources on high-end AMD Ryzen hardware and a bespoke customised version of the Pterodactyl panel. Bloom is also now a provider in the VPS and managed server solutions space across multiple regions. + +
    +
  • Locations: Ashburn, Dallas, Los Angeles, Miami, Falkenstein, Singapore (Performance+ plans only)
  • +
+ +#### Pricing + +
    +
  • Essentials MC 4GB: $10/month
  • +
  • Performance MC 8GB: $18/month
  • +
  • Performance+ MC 8GB: $24/month
  • +
+ + + +--- + +### EnviroMC + +EnviroMC is a quality Minecraft service provider that focuses on both the budget and high-end requirements of their customers, as of Sept. 19th 2022 URHOST clients will be absorbed into EnviroMC as part of a takeover agreement. EnviroMC also provides a VPS solution across the US, Europe and Asia. + +
    +
  • Locations: Falkenstein, New York, Singapore, Warsaw (VPS Only)
  • +
+ +#### Pricing + +
    +
  • Budget: $1/GB/month
  • +
  • Premium: $2.50/GB/month
  • +
  • Dedicated: See website for pricing
  • +
+ + + +--- + +### Hetzner GMBH + +It would be impossible to create a provider list and not include Hetzner, they currently stand as the German kings when it comes to high-end hardware at an ultra affordable price point. If you're running a large enough solution and just looking for the bare metal to run it on they should be food for thought. + +
    +
  • Locations: Ashburn (VPS Only), Falkenstein, Helsinki, Nuremberg (VPS Only), Vint Hill (VPS Only)
  • +
+ +#### Pricing + +
    +
  • Cloud Starting: €3.79/month
  • +
  • Dedicated Starting: €37/month
  • +
+ + + +--- + +### OVHCloud + +OVH, much like Hetzner, is a compute only provider meaning they specialise in Cloud services and Metal (the platform we use for Labs) + +
    +
  • Locations: Beauharnois, Frankfurt, Gravelines, London, Roubaix, Singapore, Strasbourg, Sydney, Vint Hill, Warsaw
  • +
+ +#### Pricing + +
    +
  • Cloud Starting: $3.50/month
  • +
  • Dedicated Starting: $56/month
  • +
+ + + +--- + +### MCHO.ST + +MCHO.ST is a hosting provider with both a free tier and a premium product, the latter using the Ryzen 8700G CPUs offering great price to performance with a brand new panel. + +
    +
  • Location: Nuremberg
  • +
+ +#### Pricing + +
    +
  • Free Tier: Free
  • +
  • 8700G Premium: £6.25/month
  • +
+ + + +--- + +### Pebblehost + +A long standing hosting provider that has modernised with the times offering a great budget service tier as well as offering tiers with additional performance those that require it. + +
    +
  • Locations: Coventry, Gravelines, Hillsboro, Montreal, Roubaix, Sydney
  • +
+ +#### Pricing + +
    +
  • Budget: $1/GB/month
  • +
  • Premium: $2.25/GB/month
  • +
  • Extreme: $2/GB/month (Min Order 6GB / 3 Threads)
  • +
+ + + +--- + +### WitherHosting + +A budget hosting provider with a global reach and an entry price point of 1$/GB utilising a range of both Ryzen and Xeon grade processors. + +
    +
  • Locations: Chicago, Dallas, Frankfurt, London, Los Angeles, Miami, New York, Singapore, Sydney
  • +
+ +#### Pricing + +
    +
  • Budget: $1/GB/month
  • +
  • Premium: $2/GB/month
  • +
+ + + +--- + +### Other Providers + +Yes, there are other great providers that haven't made our list for one reason or another - if you do decide to venture out and search for other providers some things we'd recommend you looking out for are + +#### Avoid These Things + +
    +
  • Don't use a host that makes you pay with a 'per-player slot' model - This is awfully dated and you should focus on resource based pricing instead
  • +
  • Don't use Mojang (Microsoft) Realms - This is an Azure backed platform designed for bedrock but also has Java presence, in the long run you will not have an enjoyable experience
  • +
  • Don't use a host that appears on a 'drama site' / forum - Hosts that make these lists tend to be awfully run and you'll have a bad time with them
  • +
+ +#### Look For These Things + +
    +
  • Do your own research, check the companies TrustPilot reviews etc to get an understanding of how the customers feel
  • +
  • Look for hosts that advertise hardware components and don't make you dig through pages of docs to get the information
  • +
  • Check the providers status page for a better understanding of reliability
  • +
+We'd also recommend you ensure your chosen provider hasn't ended up on our list of 'Summerhosts' + +
+ If in doubt ASK! Measure twice and cut once. diff --git a/folder/de/src/content/docs/hosting/self.mdx.mdx b/folder/de/src/content/docs/hosting/self.mdx.mdx new file mode 100644 index 0000000000..961a9fca34 --- /dev/null +++ b/folder/de/src/content/docs/hosting/self.mdx.mdx @@ -0,0 +1,31 @@ +--- +description: So you want to host a Minecraft server yourself? Checkout your options and find the solution that suits your requirements. +slug: h/self +title: Self Hosting +--- + +When it comes to running everything yourself you have two options + +
    +
  • Rent hardware / compute in the 'cloud'
  • +
  • Provide your own hardware and run at a data centre / your house
  • +
+ +### Option 1 + +If you can afford it, this is your better option. While this is the most expensive option your monthly bill does include hardware, electricity, internet and in some cases ddos protection. A mid-range to high end service will cost you anywhere from 100$ per month in this regards so may not be suitable for those who don't already have an established community, we discuss this option a in a bit more depth [here](/h/types#bare-metal--vds). + +--- + +### Option 2 + +The cheapest option but is does require some additional thought however for one or two people this option may still make the most sense. + +
    +
  • Do you have a suitable internet connection? Firstly run a speed test, this will give you an idea of where your current connection sits. A 50mbps connection for both upload and download should be sufficient for your regular household activities **and** your Minecraft server, remember your connection is shared between all devices so downloading something on your internet e.g. steam games will reduce the available connection to Minecraft.
  • +
  • Do you have proper IPv4 addresses? Yes, Minecraft *can* support IPv6 but it requires all parties involved to also support V6 connectivity. You also need to consider if you have a [static IPv4 address](/ts/ip).
  • +
  • Have you considered the overhead to security, power utilisation, heat generated, noise produced and cost of hardware? Protecting the rest of your network can cost you either in man-hours or hardware if you need to purchase additional tools to get operational. This should all be considered before you commit to running things from home.
  • +
  • 24/7 Availability? If you're not prepared to run a server 24/7 from your home are you players happy with the fact a server will only be online for a few hours a day.
  • +
+ +If you do want to host things yourself we have documentation on how to do such things [here](/guides/self-host). diff --git a/folder/de/src/content/docs/hosting/summerhosts.mdx.mdx b/folder/de/src/content/docs/hosting/summerhosts.mdx.mdx new file mode 100644 index 0000000000..7e1d45292a --- /dev/null +++ b/folder/de/src/content/docs/hosting/summerhosts.mdx.mdx @@ -0,0 +1,70 @@ +--- +title: Summerhosts +description: Summerhost - A service provider that is poorly ran and/or operating illegally which should be avoided. +slug: h/summerhosts +--- + +The term "Summerhost" is used for service providers that are poorly ran and/or operating illegally which should be avoided, below is a list of characteristics that will end you up on our avoid list. + +:::note + +For hosting providers that meet the requirements below but are not already on the list you can [submit an issue on GitHub](https://smd.gg/summerhost-addition). Providers that no longer meet the criteria defined below can request removal using [this link](https://smd.gg/summerhost-removal) + +Disclaimer: Information was accurate at the time of publication and may not reflect any recent changes we've not been made aware of. The list of providers below should be used as a reference point. This page mostly relies on publicly available information published by listed providers (and information that is not public will be displayed on this page). +::: + +### Avoid providers that feature the following: + +
    +
  • Businesses that do not contain contact details (ex. email & phone)
  • +
  • Website with false or missing information
  • +
  • Improper billing (discord checkout etc)
  • +
  • No Terms of Service or Privacy Policy
  • +
  • No SLA ("Service Level Agreement")
  • +
  • Oversold servers
  • +
  • Deceptive sales
  • +
  • Rigged reviews (ex. review rewards)
  • +
  • Obstructive Terms of Service that disallows doing basic stuff within the server (ex. pregenning)
  • +
  • Lack of basic features such as databases and backups
  • +
  • Pirating software used on the provider (ex. "nulled" WHMCS and other software)
  • +
  • Violating other project's rights (ex. selling licensed software without authorization)
  • +
  • GSP (Game Server Providers) that sell preconfigured FiveM servers (excluding Zap Hosting)
  • +
+ +#### Sources & Useful Tools: + +
    +
  • FiveM Documentation: https://docs.fivem.net/docs/support/ban-faq/#unauthorized-game-server-provider-gsp
  • +
  • FiveM Terms of Service: https://fivem.net/terms (5.8. Authorized & Unauthorized Services)
  • +
  • WHMCS License Checker: https://www.whmcs.com/members/verifydomain.php/verifydomain.php
  • +
  • Blesta License Checker: https://account.blesta.com/client/plugin/license_verify
  • +
+ +### Here is a list of providers that you should avoid with reasoning: + +| Provider | Reason | +| -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [ThunderNodes](https://thundernodes.cloud) | Improper (discord) checkout | +| [Luxe Hosting](https://my.luxe-hosting.nl) | No publicly available Terms of Service, Privacy Policy and SLA, missing publicly available information (regarding hardware), unauthorized GSP selling FiveM servers | +| [Proxynode](https://proxynode.pro) | No publicly available SLA | +| [Vellias Hosting](https://velliashosting.online) | No publicly available SLA & Privacy Policy, unauthorized GSP selling FiveM servers | +| [Lunes Hosting](https://lunes.host) | No publicly available SLA, missing publicly available information (regarding hardware), Terms of Service is a template (termly.io) | +| [Foxomy](https://foxomy.com) | Terms of Service that requires you to `"Identify as Black, Indigenous, Latino, Hispanic, Asian, Pacific Islander, or a Person of Color."` | +| [Crystallized Hosting](https://crystallized.host) | Missing publicly available information (regarding hardware) | +| [The Minecraft Hosting](https://theminecrafthosting.com) | Missing publicly available information (regarding hardware), no publicly available Privacy Policy & SLA | +| [Evix Datacenter](https://evix-datacenter.online) | No publicly available Privacy Policy & SLA, official account threatening to DDoS people ([1](https://smd.gg/lkn5vtl), [2](https://smd.gg/54owa1o), [3](https://smd.gg/flsgxnu), [4](https://smd.gg/x0omgfm), [5](https://smd.gg/mdp5sul)), official discord account using slurs ([1](https://smd.gg/fenwcql), [2](https://smd.gg/7p9co2m)) | +| [Skytale Hosting](https://billing.skytalehosting.net) | No publicly available Terms of Service, Privacy Policy & SLA, unauthorized GSP selling FiveM servers | +| [BlackNode](https://blacknode.pro) | [Bulletproof](https://www.urbandictionary.com/define.php?term=Bulletproof%20hosting) provider that promotes themselves for spoofed & bulletproof servers and botnets & DDoS tools | +| [Boundless Hosting](https://boundlesshosting.xyz) | No publicly available Privacy Policy, unauthorized GSP selling FiveM servers | +| [SpaceNode Hosting](https://spacenodehosting.com) | No publicly available Terms of Service, Privacy Policy & SLA, missing publicly available information (regarding hardware), unauthorized GSP selling FiveM servers | +| [PSB Hosting](https://psb.hosting) | [Bulletproof](https://www.urbandictionary.com/define.php?term=Bulletproof%20hosting) provider that promotes themselves for DMCA ignorant & bulletproof servers | +| [Realms Hosting](https://realmshosting.com) | Unauthorized GSP selling FiveM servers | +| [RAPIDHost](https://rapidhosting.cloud) | Unauthorized GSP selling FiveM & RedM servers, hardware information is unspecific (different processors in the "Xeon E-series" can have noticeable performance difference) | +| [proxied.host](https://proxied.host) | No publicly available Privacy Policy & SLA | +| [Nyxiality Hosting](https://nyxialityhosting.com) | No publicly available Terms of Service, Privacy Policy & SLA, missing publicly available information (regarding hardware) | +| [EmpireNodes Hosting](https://www.empirenodes.com/) | [Rigged reviews](https://www.trustpilot.com/review/empirenodes.com), no Privacy Policy | +| [Cosmic Hosting](https://cosmichosting.xyz) | No publicly available Terms of Service, Privacy Policy & SLA, unauthorized GSP selling FiveM servers | +| [HostSpace](http://hostspace.co.il/) | Improper (discord) checkout, missing publicly available information (regarding hardware) | +| [Tegra Hosting](https://tegra.gg/) | Fallback company made by ZTX, the companies lost data several times had their nodes suspended. | +| [Springracks](https://springracks.com) | Obstructive Terms of Service that disallows `running any task that will completely cap out the CPU limit set on your service` (What if there's just high load on your Minecraft server? Who knows!) | +| [EmpireNodes](https://empirenodes.com) | No Privacy Policy, Terms of Service that disallows `"Saying we are using fake ram"`, `Beg for new nodes` | diff --git a/folder/de/src/content/docs/hosting/tls.mdx.mdx b/folder/de/src/content/docs/hosting/tls.mdx.mdx new file mode 100644 index 0000000000..5111d1254a --- /dev/null +++ b/folder/de/src/content/docs/hosting/tls.mdx.mdx @@ -0,0 +1,52 @@ +--- +sidebar_position: 2 +description: Identifiy the different tools available that can be used to help you deploy SSL certificates. +slug: h/ssl +title: TLS +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you're hosting more than just your Minecraft server, maybe you're using a Map service / forum / server store an SSL / TLS certificate is an absolute must. + +### Web Services + +If you're accessing the service via a web-browser then this part of the page will be for you, this will not cover successful deployment tutorials - we may decide to include this at a later time. + +#### Cloudflare + +This is the easiest solution to adding TLS capabilities to your website as Cloudflare can operate as a reverse proxy for the traffic allowing the SSL to terminate at their edge network and transit back to your origin server over HTTP (full SSL to origin is also supported). + + + +#### Caddy + +A self-hosted solution similar to Cloudflare but without the additional DDoS protection. Caddy supports automatic SSL deployment from any ACME provider on the market and is our provider of choice in conjunction with ZeroSSL. + + + +--- + +### Linux + +This is for tools suitable for generating certificates but perhaps might not be solely for web-servers. + +#### Certbot + +Certbot is a tool that can be deployed either as a Snap package or a Python module and is designed purely for generating valid Let's Encrypt certificates. The certificates generated from Certbot do not need to solely be used in a Web-Server and can be used system wide. + + diff --git a/folder/de/src/content/docs/hosting/types.mdx.mdx b/folder/de/src/content/docs/hosting/types.mdx.mdx new file mode 100644 index 0000000000..b5b659bff1 --- /dev/null +++ b/folder/de/src/content/docs/hosting/types.mdx.mdx @@ -0,0 +1,60 @@ +--- +description: Understand the different types of hosting services available and what may be the best fit for your project. +slug: h/types +title: Types of Hosting +--- + +When you start looking at hosting your server online you'll see many different answers of which none are wrong, but they're not always suited to your needs. This page has a goal of helping you identify when you may need each type of hosting. + +The three most common types you'll find in forum responses are: + +
    +
  • Shared Hosting
  • +
  • Virtual Private Servers (VPS)
  • +
  • Dedicated Servers (Bare Metal / VDS)
  • +
+ +### Shared Hosting + +The most common type you'll find is 'Shared Hosting', this is where a hosting provider will own a physical server and partition the resources out to clients and you will connect to / manage your server via a [web panel](/h/ui) and SFTP. If you select this style of hosting you should be careful and note that some providers will oversell the resources. Overselling allows for them to provide cheaper monthly plans but may come at a performance hit due to this over allocation. Others will provide a dedicated quota that is only allocated to yourself, this will be slightly more expensive but you will have the entire quota to your disposal whenever you need it (plus it will still be cheaper than a VPS / Bare Metal). + +Traditionally this space was dominated by the likes of Nitrado, MCProHosting, Shockbyte etc... but in recent years players like [Bloom](https://bloom.host), [DedicatedMC](https://dedicatedmc.io) & [EnviroMC](https://enviromc.host) have dominated in this space offering Ryzen based solutions instead of the old school Xeons used by the legacy giants. + +--- + +### Virtual Private Servers + +The other common response you'll see people mention is 'grab yourself a VPS from Digital Ocean or Linode'. While you certainly can, it won't be much better than using [oracle cloud](/guides/oracle-cloud) on ARM (which is free). + +VPS instances have some differences to shared hosting, the core differences are. + +
    +
  • Linux knowledge is required for setup
  • +
  • Patching becomes your responsibility
  • +
  • Shell access which allows you to run more than just Minecraft servers
  • +
  • Slower but higher core count CPUs
  • +
  • You get a Dedicated IP address rather than a Shared one
  • +
  • You can install a custom panel such as [Pterodactyl](/h/ui#pterodactyl)
  • +
+There are times when a VPS can make sense, a prime example is using a VPS provider that uses consumer 'Gaming Grade' CPUs (Intel Core i9 / AMD Ryzen 7 / 9). These would provide the same experience for Minecraft as using a regular 'shared hosting' provider and it would allow you to host say a web / database server, a discord bot or anything else you could imagine. + +--- + +### Bare Metal / VDS + +The final common type of hosting you'll see people mention is, "go all out and own your hardware". While yes, this has some advantages for a novice the prospect of having no one around for support can be unsettling. Bare metal gives you full, dedicated, system normally in 32 / 64 or 128 GB RAM configurations with 256 / 512 or multi-TB disk configs. Bare metal can either be built yourself and shipped to a data centre for a monthly fee or you can rent from providers such as Hetzner, OVH or ReliableSite for a monthly fee. This option can set you back multiple hundreds of dollars per month and would only be recommended for larger scale deployments. + +Bare metal has a few advantages over the other types of solutions such as. + +
    +
  • Complete ownership of the server data
  • +
  • Complete ownership of physical and networking resources
  • +
  • Some providers will offer a managed solution for an additional fee
  • +
+Bare metal also carries the same differences to shared hosting as a VPS. + +:::tip + +If you don't already know what level of hardware you should be looking at then please consider reading our [hardware guide](hardware) first, then once you know what hardware and solution you're looking for head on over to our [recommendation page](providers) for vendors that can deliver what you're looking for. + +::: diff --git a/folder/de/src/content/docs/index.mdx.mdx b/folder/de/src/content/docs/index.mdx.mdx new file mode 100644 index 0000000000..be7147a922 --- /dev/null +++ b/folder/de/src/content/docs/index.mdx.mdx @@ -0,0 +1,34 @@ +--- +title: Minecraft Admin Wiki +description: We're setup.md, the Minecraft administration wiki, written by enthusiasts and targeted to the novice. +template: splash +hero: + tagline: Your home of good information written by enthusiasts for the novice Minecraft server owner. + image: + file: ../../assets/houston.webp + actions: + - text: View the docs + link: /docs + icon: right-arrow + variant: primary + - text: Visit us on Github! + link: https://smd.gg/repo + icon: external +--- + +import { Card, CardGrid } from '@astrojs/starlight/components'; + + + + Behind the scenes our wiki has lost some weight as is built on the fastest framework to date! + + + Version 3 of the wiki launches with a focus on improving contribution requirements. + + + With V3 we now have the functionality to implement translations following the i18n standard. **SOON!** + + + We're still backed by the amazing members of the [Admincraft](https://smd.gg/acdiscord) community. + + diff --git a/folder/de/src/content/docs/information/discord.mdx.mdx b/folder/de/src/content/docs/information/discord.mdx.mdx new file mode 100644 index 0000000000..b9b210e8cc --- /dev/null +++ b/folder/de/src/content/docs/information/discord.mdx.mdx @@ -0,0 +1,36 @@ +--- +description: We have a Discord server, check out the basics here. +title: Discord Server +slug: discord +--- + +All project contributors are volunteers and will carry the `project contributor` role within our server. + +Those that carry the `project lead` role are the core representatives of the project and should be the ones who are consulted on any issues within. + +A permanent invite to our server can be found here. + +### Ground Rules + +As with any public server, there are some rules that need to be followed. + +
    +
  • Be kind to one another
  • +
  • Don't be an ass, no one is paid to deal with your poor behaviour
  • +
  • Don't post any NSFW content
  • +
  • Follow the Discord community guidelines
  • +
  • Follow the Discord terms of service
  • +
+ +--- + +### Server Roles + +A brief overview of important roles within our server and how they are obtained. + +| Roles | Description | +| :------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Project Lead | This is a role that is reserved for first-party members of the project. | +| Project Contributors | Anyone who has submitted work for the Github repository is eligible for this role, you should have your Github account linked to your Discord account and publicly visible. | +| Community Nerds | People who have shown significant knowledge in areas and support the community without being a wiki contributor. | +| Sponsors | This role is automatically assigned to anyone who sponsors the project. (This role is not currently obtainable) | diff --git a/folder/de/src/content/docs/information/eula.mdx.mdx b/folder/de/src/content/docs/information/eula.mdx.mdx new file mode 100644 index 0000000000..42484d52c5 --- /dev/null +++ b/folder/de/src/content/docs/information/eula.mdx.mdx @@ -0,0 +1,29 @@ +--- +description: Helping you navigate through the latest changes to Mojang's EULA. +slug: eula +title: Minecraft EULA +lastUpdated: 2023-08-02 +sidebar: + order: 4 + badge: + text: Important + variant: danger +--- + +If you're new to hosting a Minecraft server you should probably become familiar with what the EULA and CUG actually are. In short they're a scope of principles Mojang would like your server to adhere to at all times if you don't want it blacklisted at auth server level, these policies can change at any time and more often than not aren't published to Mojang's official channels e.g. Twitter. + +### Changes + +The following additional changes have been made which will affect the most amount of servers since the huge enforcements in 2014. + +
    +
  • All servers are now required to be suitable for all ages
  • +
  • All servers are now required to disclose their non-affiliation with Mojang and/or Microsoft
  • +
  • All servers are now required to implement their own ToS before a player is allowed to play
  • +
  • All players are now required to check back to the EULA on their own accord and players will not be updated of the change
  • +
  • Anything from non-commercial blogs, servers, community forums, fan sites, fan clubs, news groups, events, and gatherings are now deemed as commercial and must follow the CUG even if it will never make money
  • +
  • Mojang now has complete control over all forms of Minecraft content on online platforms
  • +
  • Mojang now has control over the term 'Minecraft' in creative content (YouTube, Twitch etc.) which may result in content removal
  • +
  • Mojang has the authority to grant or revoke permissions and consents at their discretion if they deem it appropriate or dislike what players are doing
  • +
  • Mojang has now outlawed the use of out-of-game mechanics to limit access to your Minecraft server e.g. queue based platforms in addition to gatekept content
  • +
diff --git a/folder/de/src/content/docs/information/releases.mdx.mdx b/folder/de/src/content/docs/information/releases.mdx.mdx new file mode 100644 index 0000000000..9bb709cfbc --- /dev/null +++ b/folder/de/src/content/docs/information/releases.mdx.mdx @@ -0,0 +1,26 @@ +--- +description: Every major Minecraft release, it's required Java version and noticable changes. +slug: release +title: Release Tracker +lastUpdated: 2023-12-10 +sidebar: + order: 3 +--- + +This page aims to cover the latest information for Java tracking the required Java builds and fork compatibility. + +| Major Release | Revision Version | Java Support | PaperMC Build | Purpur Build | +| ------------- | ---------------- | ---------------- | ------------- | ------------ | +| 1.21 | 0 | Java 21 | ✔ | ✔ | + +If you come back to this page at a later date in time and you cannot see a build for the newest release check one of the following links for updates: PaperMC Github or PurpurMC Github + +### Notable Changes + +
    +
  • Added new structures
  • +
  • Added new mobs
  • +
  • Added new weapon
  • +
+ +A full change log can be found here: https://www.minecraft.net/en-us/article/minecraft-java-edition-1-21 diff --git a/folder/de/src/content/docs/information/services.mdx.mdx b/folder/de/src/content/docs/information/services.mdx.mdx new file mode 100644 index 0000000000..0a50ac405d --- /dev/null +++ b/folder/de/src/content/docs/information/services.mdx.mdx @@ -0,0 +1,57 @@ +--- +description: Additional resources that are hosted by the setup.md team. +title: Additional Services +slug: services +lastUpdated: 2024-04-01 +sidebar: + order: 2 +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +As time has progressed we've continued to identify ways we can help server owners get up and running, setup.md has launched some additional services to help make your life easier. + +### Asset Hosting + +We launched a file sharing platform that can be used to share assets quickly with your communities, host resource packs for your server and even create 'link-in-bio' style pages to help bring your community together. + +#### Features + +
    +
  • 100MB file upload limit
  • +
  • Custom domain support premium
  • +
  • URL Shortener
  • +
+ + + + + + +--- + +### Server Jar API + +We took a cool idea produced by PenguiLoader on Github and we fixed some bugs then made it faster by distributing the workload to Cloudflare workers and running it on their amazing edge network. + +#### Quickstart + +The base domain is `https://jar.smd.gg` + +The subsequent URL that follows is syntaxed as below. + +`/download/{SOFTWARE}/{VERSION}/{BUILD}` + +To grab the latest paper .jar download. + +`GET https://jar.smd.gg/download/paper/latest/latest` + +To grab the latest vanilla server.jar download link. (no build parameter required) + +`GET https://jar.smd.gg/download/vanilla/latest` + + + + + diff --git a/folder/de/src/content/docs/jarapi.mdx.mdx b/folder/de/src/content/docs/jarapi.mdx.mdx new file mode 100644 index 0000000000..c82306823e --- /dev/null +++ b/folder/de/src/content/docs/jarapi.mdx.mdx @@ -0,0 +1,18 @@ +--- +title: JAR API +description: An API to easily grab popular Minecraft server software. +template: splash +slug: service/jar-api +hero: + tagline: An API to easily grab popular Minecraft server software. + image: + file: ../../assets/javaicon.png + actions: + - text: Source Code + link: https://smd.gg/api + icon: github + variant: primary +--- + +import MainStatusPill from '../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; diff --git a/folder/de/src/content/docs/mchost.mdx.mdx b/folder/de/src/content/docs/mchost.mdx.mdx new file mode 100644 index 0000000000..aa93e9225f --- /dev/null +++ b/folder/de/src/content/docs/mchost.mdx.mdx @@ -0,0 +1,21 @@ +--- +title: MCHO.ST +description: The free Minecraft hosting solution, sponsored (in-part) by the setup.md wiki. +template: splash +slug: service/mcho.st +hero: + tagline: The free Minecraft hosting solution, sponsored (in-part) by the setup.md wiki. + image: + file: ../../assets/mchost.webp + actions: + - text: Game Panel + link: https://my.mcho.st + icon: external + variant: primary + - text: Join our Discord! + link: https://mcho.st/discord + icon: discord +--- + +import MainStatusPill from '../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; diff --git a/folder/de/src/content/docs/tools/database.mdx.mdx b/folder/de/src/content/docs/tools/database.mdx.mdx new file mode 100644 index 0000000000..d3b23510f2 --- /dev/null +++ b/folder/de/src/content/docs/tools/database.mdx.mdx @@ -0,0 +1,41 @@ +--- +description: This page covers centralised plugin data storage using databases. +slug: t/database +title: Databases +--- + +Before you go and implement a database you should first understand what a database can help to achieve, this will ensure that you're not burning time unnecessarily deploying things you don't need. + +### Why use databases + +Databases are used for centralised storage with unrestricted limitations to read, write new data and modify existing data. Storing data in a database can also be efficient, decreases time for looking up data that you can export into another application / format without significant difficulty. + +--- + +### Common database types + +If you're hosting a server the most common types of databases you'll be interacting with are 'SQL' based. This will most likely be one of the following solutions: + +
    +
  • MySQL (Legacy project)
  • +
  • MariaDB (Modern MySQL fork)
  • +
  • MSSQL (The Microsoft edition of MySQL)
  • +
+From an end user perspective all database types will produce a `.sql` file when exported and can be maintained through a common interface like phpMyAdmin, Adminer or MySQL Workbench. + +:::tip + +You should also be able to move your databases between all three without any major difficulties but this may depend on implementation +::: + +--- + +### When to use a database + +In a Minecraft environment you're most likely going to come across databases in a 'Network' environment e.g. when you're using a tool such as ['Velocity'](/t/server-software#velocity), or ['Bungee'](/t/server-software#bungeecord), this will allow you to share information between your backend servers and have one consistent dataset e.g. economy balances, synced ranks and permissions etc just to name a few examples. + +If you're running a server with a hosting provider they too will most likely give you the ability to create databases for your plugin data, if you're limited on local disk space using SQL for plugin data may off-lift some local capacity constraints. + +:::note +If you're looking to deploy your own Private SQL instance, you can follow a tutorial such as the one on the [Digital Ocean community forums](https://www.digitalocean.com/community/tutorials/how-to-install-mysql-on-ubuntu-22-04) that covers installation, configuration and securing your instance. +::: diff --git a/folder/de/src/content/docs/tools/offline-mode.mdx.mdx b/folder/de/src/content/docs/tools/offline-mode.mdx.mdx new file mode 100644 index 0000000000..87deae162d --- /dev/null +++ b/folder/de/src/content/docs/tools/offline-mode.mdx.mdx @@ -0,0 +1,40 @@ +--- +slug: t/offline +description: What is offline mode and what are the implications? +title: Offline Mode +--- + +Offline mode is a legacy feature of Minecraft servers that disables the requirement for Mojang user authentication, allowing cracked Minecraft clients such as TLauncher et al. to join. +It can be set by either passing the `--singleplayer` flag to the server jar or setting `online-mode=false` in server.properties. However, there are several risks, legal and especially security, which will be covered on this page. + +### Reasons not to use offline mode + +#### Security Risks + +Due to the lack of authentication required on an offline mode server, anyone can use any username to log in - this especially comes into play when players join as certain names to either gain operator permissions or to relentlessly evade bans. + +AuthMe is a plugin for Bukkit servers that coats an insecure offline mode server with a thin veil of 'authentication', which partially mitigates these vulnerabilities at most - however, other plugins or mods still may provide operator access. +Such authentication plugins may prove an annoyance to players, an incentive to use weak passwords which then can be hacked into by malicious players - completely destroying the objective of these plugins. + +#### Software Issues + +Using offline mode on your server may also cause plugins that rely on UUID lookup to break - each 'account' has its own unique UUID, which can cause issues breaking many mods or plugins. + +When switching between modes, this becomes even more of an issue - plugins will have stored data in one format, and changing from online to offline or vice-versa will make them default to the respective format and effectively break all existing user data + +#### Legal Implications + +Offline mode (cracked) servers are commonly a breeding ground for piracy of Minecraft, which may constitute a violation of their EULA, specially their [One Major Rule](https://www.minecraft.net/eula#one-major-rule). +This may prove a problem for larger servers, as Mojang may blacklist clients from connecting to them for common EULA violations such as pay-to-win mechanics et al. + +--- + +### Valid Use Cases + +However, there are a few valid use cases in which offline mode can be used without such implications. They will be listed below: + +
    +
  • Proxies such as BungeeCord and Velocity which require backend servers to have online mode disabled - the proxy must have online mode enabled for this to count
  • +
  • Offline local-hosted environments which lack internet access, assuming everyone owns a Minecraft account otherwise
  • +
  • Local-hosted development servers for testing plugins and mods
  • +
diff --git a/folder/de/src/content/docs/tools/server-software.mdx.mdx b/folder/de/src/content/docs/tools/server-software.mdx.mdx new file mode 100644 index 0000000000..c5ca3c19db --- /dev/null +++ b/folder/de/src/content/docs/tools/server-software.mdx.mdx @@ -0,0 +1,189 @@ +--- +slug: t/server-software +description: This page covers a list of well known server.jars. +title: Server Software +lastUpdated: 2024-03-27 +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +When creating a server there are multiple different names you will come across. Each server software has its own uses. + +Server Software is very often referred to as "Server Jar(s)". + +:::note +A "Fork" is a modified version of server software. These often share the same codebase and will sometimes patch in their own changes on top of the previous projects' code. An example of "forks" is something such as "Bukkit > CraftBukkit > Spigot > Paper > Purpur". +::: + +### Backend Servers + +There are hundreds (if not thousands) of different forks. This document will only include the recommended, stable, widely-used ones. + +#### Vanilla No Plugin Support + +As the name suggests, it is a completely Vanilla server from Mojang itself without any modifications. Great for those who want to host a small server for a couple of friends without altering any mechanics, but definitely not good for large servers. + + + +#### Paper Recommended + +Paper is the most widely-used Server Jar nowadays. A fork of Spigot with its own API, numerous optimizations alongside tons of glitch/dupe fixes make Paper the main choice for most server owners. + + + +#### Purpur + +A fork of Paper which provides numerous gameplay-enhancing features without having to download/create plugins. These include being able to adjust gameplay behaviors not seen in Paper, mob health, and more. Only has a couple of optimization options, but it does allow you to toggle some dupes. + + + +#### Pufferfish + +A fork of Paper which greatly improves performance without causing any noticeable impact to gameplay. Includes hopper, entity, map rendering and many other optimizations. Highly recommended for most servers. + + + +#### Folia + +A fork of Paper which groups nearby loaded chunks to form an "independent region." Each independent region has its own tick loop, which is ticked at the regular Minecraft tickrate (20TPS). The tick loops are executed on a thread pool in parallel. There is no main thread anymore, as each region effectively has its own "main thread" that executes the entire tick loop. + +:::caution + +#### Yes, Folia is relatively usable. + +Do you need to use it? Highly unlikely. Can you use it? Probably. Will a good chunk of your plugins break? Definitely. It's currently only recommended for very large servers that are vanilla/semi-vanilla, have a beefy enough CPU and enough threads as well. If you do end up using it, make sure to test it thoroughly. If you can, consider implementing some patches from Pufferfish and other jars as well. + +**Every command and feature should be tested.** +::: + + + +#### Legacy 1.8 Jars + +It is highly recommended that you do not use 1.8 or any of its other releases. However, if it's a requirement for whatever reason these are the better jars to use. + + + + + + + + + +#### Forge + +Forge is a modding API and server jar. It is most commonly used for servers with large modpacks. However, it is not very optimized and can suffer from poor performance. + + + +#### NeoForge + +NeoForge is a fork of the Forge project with almost all of the original team [excluding LexManos](https://neoforged.net/news/theproject/), made to fix its community issues and to provide better support to modders and later versions of Minecraft. + + + +#### Fabric + +Fabric is another modding API and server jar. Fabric mods are able to change practically any mechanics of the game, is more lightweight compared to Forge, and generally performs better than vanilla thanks to the wide range of optimization mods avaliable such as Lithium, Starlight, ModernFix etc. Take a look at [this list](https://github.com/NordicGamerFE/usefulmods). + + + +--- + +### Proxies + +Proxies are used to connect multiple regular servers (such as Paper servers) together. These are what power "networks" and are used by servers which have multiple gamemodes separated in their own subservers. I.E. Survival, Minigames, Prison, etc. all in one "server". + +#### Velocity + +A more recent project, now run by the Paper developers. Velocity uses its own API, meaning it does not work with Bungeecord / Waterfall (Unless you use [SNAP!](https://forums.papermc.io/threads/snap-run-bungeecord-plugins-on-velocity.31/), which allows you to use Bungeecord plugins on Velocity. Not recommended, though.) + +Velocity is a superior solution compared to Bungeecord / Waterfall unless you're hosting older than 1.13 servers but many developers haven't added Velocity support to their plugins. + + + +#### Waterfall + +A fork of Bungeecord run by the Paper developers, Waterfall supports most if not all Bungeecord plugins. It also comes with a couple of networking optimizations. + + + +:::caution +The PaperMC team have announced that Waterfall has now reached end of life in favour of Velocity. You can read the full announcement here - https://smd.gg/waterfall-eol. We will remove this option from our wiki in the coming months. +::: + +--- + +### Geyser Standalone + +Functioning almost exactly like the Geyser plugin, Geyser Standalone allows you to take load off of your main proxy/backend instance. It also supports auto-updating on Pterodactyl (assuming that you're using the Geyser Standalone egg). Recommended for servers that have higher player counts. + +If you're using Pterodactyl, consider using the [Geyser Standalone Egg](https://github.com/GeyserMC/pterodactyl-stuff). After installation, simply set "remote" in the config.yml of Geyser Standalone to the IP of the proxy/backend server & add Floodgate-Spigot & Floodgate-Velocity/Bungeecord to the spigot and proxy instances respectively. + +Geyser Standalone also allows you to connect to servers that you do not own. However, this is not recommended as it will more than likely lead to a swift ban from the anti-cheat. + + + +--- + +### Interesting Projects + +There are sometimes cool spin-offs that we feel are worthy of mentioning their existance, please note they may no longer be in active development at the time you're viewing this article. + + + + + + +:::danger + +#### Avoid any Jar that combines Plugins & Mods + +Do not use any hybrid server software such as Magma or Mohist. These are generally unstable. [Mohist also replaces EssentialsX jars with modified jars](https://essentialsx.net/do-not-use-mohist.html), which might not be safe. + +::: diff --git a/folder/de/src/content/docs/tools/signed-chat.mdx.mdx b/folder/de/src/content/docs/tools/signed-chat.mdx.mdx new file mode 100644 index 0000000000..6374dafbd1 --- /dev/null +++ b/folder/de/src/content/docs/tools/signed-chat.mdx.mdx @@ -0,0 +1,147 @@ +--- +description: 1.19.1 overhauled the current reporting features and therefore caused a lot of panic, this page is written to cut through the misinformation and provide the facts. +title: Signed Chat +slug: t/signed-chat +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard } from '@astrojs/starlight/components'; + +First things first, it's important to set the story straight. Mojang had always had a reporting toolset for anyone who wished to use it however with the introduction of 1.19.1 changes were made to this system that a reasonable portion of the community didn't like. + +This patch specially introduces a couple of new features being: + +
    +
  • In-Game UI reporting
  • +
  • Cryptography and signing
  • +
+ +The purpose of this page serves as an advisory for those who wish to understand further what this means and what options are available to them. + +--- + +### How does it work + +This is accurate to the best of our abilities, if there is someone with a better understanding of cryptography that can help improve this page please submit a PR. + +#### Technical aspects + +These new keys are stored in .json format under the '%appdata%/.minecraft/profilekeys' folder on your PC. + +:::note +These keys are regenerated after 48 hours +::: + +The 'process' now works as follows: + +
    +
  • User opens up their Minecraft client
  • +
  • Check for keys / generation of new keys occurs if required
  • +
  • User launches Game
  • +
  • User joins their desired Minecraft server
  • +
      +
    • On join the client also makes it's public key available to the server
    • +
    +
  • User sends a message in chat
  • +
      +
    • Client signs the message using the private key providing a level of authenticity
    • +
    • Signed message is sent to the server
    • +
    • Server can validate the message came from your client using your public key
    • +
    • Server displays the chat messages
    • +
    +
+ +Every time a message is sent in chat the last 2 steps are repeated. +
+ + +#### User Reports + +When a user is reported via the new in-game screen ui the following process occurs: + +
    +
  • User selects the offending user and messages they wish to report
  • +
  • The message in question and surrounding message are also sent to Microsoft for review
  • +
+ +Once a report is sent, it is reviewed by Mojang's moderation team who will gauge an appropriate punishment for the offender(s). Any Microsoft punishment is in-line with it's current community guidelines and effect your entire account not just the single Minecraft server, these punishments can result in removal of your Multiplayer access. + +#### In-depth Review + +The best current source of data for the chat reporting is on Github created by KennyTV. A link to the document can be found [here](https://gist.github.com/kennytv/ed783dd244ca0321bbd882c347892874#file-readme-md) + +Below is a list of ways server owners and players can effectively disable the new chat reporting feature, by using one or more of these features you may limit either your own or your communities functionality. + +--- + +### Options + +#### Client Side + +Option one is disabling 'chat-signing' within your client, this will prevent you from joining any server where this setting is enforced. + +#### Server Side + +If you're running your own server there are a few options that can be used depending if you're running vanilla, modded or a plugin based server, these are as follows. + +##### Edit server.properties file Global + +You can edit the following switch to 'false' which will disable the requirement for users to use chat-signing. + +```yaml +... + +enforce-secure-profile = false + +... +``` + +##### No Chat Reports Modded Only + +No Chat Reports is a Minecraft mod created by Aizistral that works on both the client and server sides. It strips cryptographic signatures from player chat messages, effectively converting them to system messages, thus making them non-reportable. + +:::note +Joining a server with `enforce-secure-profile=true` on a client with No Chat Reports installed will display a prompt warning the user that chat will be signed if they agree to it. +::: + + + +##### FreedomChat Spigot / Paper & forks only + +FreedomChat effectively serves the same purpose as No Chat Reports would on a modded server, it converts player chat messages to system messages at the packet level, making them once again non-reportable by players. + + + +##### AntiPopup Spigot / Paper & forks only + +While this plugin works, manual setup is required - the command `/antipopup setup` must be ran in console unless `enforce-secure-profile` is set to `false` already. + + + +##### UnSignedVelocity Velocity only + +This plugin works by removing signed information from commands and messages sent by clients 1.19.1 or higher, allowing plugins that cancel proxy messages to work again. Requires VPacketEvents + + + +:::caution + +All of the above plugins could give you issues with the recent EULA changes as of Aug 2023, the above plugins are no-longer considered endorsed by setup.md. + +::: diff --git a/folder/de/src/content/docs/tools/startup.mdx.mdx b/folder/de/src/content/docs/tools/startup.mdx.mdx new file mode 100644 index 0000000000..e8b76f62f7 --- /dev/null +++ b/folder/de/src/content/docs/tools/startup.mdx.mdx @@ -0,0 +1,117 @@ +--- +description: Understand the startup file used when hosting a server. +slug: t/flags +title: Startup Scripts +--- + +### Basics + +This is how your most bare-bones startup script looks like. + +```bash +... + +java -XmxG -XmsG -jar .jar nogui + +... +``` + +`-Xmx` sets the maximum amount of memory the Java Virtual Machine is allowed to reserve. Don't set this over the amount of memory you have on your machine/given to you by the hosting provider. + +`-Xms` sets the minimum amount of memory the JVM is allowed to reserve. It should always be below or equal to the `-Xmx` value. + +The JVM only uses memory in its heap space - an area of memory that is reserved for the Java application (in our case, the server) - and the flags `-Xms` and `-Xmx` determine the possible bounds of this area. The heap size may be dynamically changed depending on how much memory the application actually needs, but it will always stay within those bounds. + +For example, `-Xmx3G -Xms1G` would set the maximum heap size to 3 gigabytes and the minimum to 1 gigabyte. You can also use the letters M and K - megabytes and kilobytes (though the latter is not usually used) to set the value more precisely, e.t `-Xmx512M`. + +Setting them both to be the same usually improves performance as no calculations need to be done regarding the heap size, but this may take away memory from other programs on your host machine (if any) in case the server does not always need to allocate the full `-Xmx`. + +You should set your RAM allocation according to your average server load - allocating more memory than your server needs is likely to cause GC lag spikes. For example, if you are a starting out server with 0-2 players most of the time, you'll be fine with 2 GB, but if you have 5-10 players online at once, you'll need 4-5 GB. + +`nogui` hides the Minecraft server GUI panel, only leaving the console visible. Remove the flag if you choose to use the panel. It has basic features like a player list, performance metrics and console output. + +`-jar .jar` points to the server .jar - see [Server Software](https://www.setup.md/t/server-software). + +--- + +### Java flags + +Java flags are used to improve server performance and client stuttering by tuning Java's Garbage Collection and adding other optimizations. + +JVM flags go **before** the `-jar` flag. + +#### Aikar flags + +Aikar's flags, while very well optimized for older Java versions, have not been updated since its creation and are severely out of date for modern Java versions. If you are running a 1.17+ Minecraft Java server (and use java 16+), it is recommended to use more up-to-date flags. + +#### Hilltty flags + +These flags are a more up to date version of Aikar's flags designed for modern versions of Java (16 and 17) which should perform better. You can check the startup scripts [here](https://github.com/hilltty/hilltty-flags/blob/main/english-lang.md). + +--- + +### Advanced JVM flags and optimizations + +The JVM can be further tweaked to optimize server and client stutters relating to Java. See [Minecraft Performance Flags](https://github.com/Mukul1127/Minecraft-Performance-Flags-Benchmarks), a up-to-date guide for Java flags, Garbage Collectors, Java runtimes (GraalVM), and other performance tips such as Large Pages and optimized Linux Distributions. + +--- + +### Minecraft server flags + +Minecraft also has quite a few startup options that directly affects the server in some way. Those go _after_ `-jar` in the startup script. +The following information is from [the wiki](https://minecraft.wiki/w/Tutorials/Setting_up_a_server#Minecraft_options). + +#### Minecraft options + +- `--bonusChest` + +If a bonus chest should be generated, when the world is first generated. + +- `--demo` + +If the server is in demo mode. (Shows the players a demo pop-up, and players cannot break or place blocks or eat if the demo time has expired) +Equivalent to playing minecraft without a account, you have about 5 in-game days before your trial ends. + +- `--eraseCache` + +Erases the lighting caches, etc. Same option as when optimizing single player worlds. + +- `--forceUpgrade` + +Forces upgrade on all the chunks, such that the data version of all chunks matches the current server version (same as with sp worlds). +This option significantly increases the time needed to start the server. + +- `--initSettings` + +Loads the settings from 'server.properties' and 'eula.txt', then quits. + +- `--jfrprofile` + +Initializes the Java Flight Recorder on the server. Only available on 1.18+. + +- `--port ` + +Which port to listen on, overrides the server.properties value. (default: -1, read from server.properties) + +See Server.properties for restrictions on this value. + +- `--safeMode` + +Loads level with vanilla datapack only. + +- `--serverId ` + +Gives an ID to the server. (??) +Seemingly no effect ?? + +- `--singleplayer` + +Runs the server in offline mode. + +- `--universe ` + +The folder in which to look for world folders. (default: .) + +- `--world ` + +The name of the world folder in which the level.dat resides. diff --git a/folder/de/src/content/docs/tools/textures.mdx.mdx b/folder/de/src/content/docs/tools/textures.mdx.mdx new file mode 100644 index 0000000000..0fbc5f6eca --- /dev/null +++ b/folder/de/src/content/docs/tools/textures.mdx.mdx @@ -0,0 +1,63 @@ +--- +description: Hosting texture packs for your server. +slug: t/textures +title: Resource Pack Hosting +--- + +If you're looking to host your texture pack for your Minecraft community you can use a third party file hosting service to deliver your pack to Minecraft clients. + +We (setup.md) have an official sharing site that can be used (for free) providing your packs are under 250MB in size. + +--- + +### Using our uploader + +Firstly, open a browser and navigate to https://smd.gg/upload. + +Sign in using one of our SSO options / create a 'traditional' account using a username and password. + + + +Select the 'Getting Started' free tier to finish setting up your account. + + + +You will now be brought to the dashboard page, on the left hand side select 'File link' + + + +By pressing the 'New Link' button in the top right hand side you will be shown a file uploader + + + +Select where your texture pack is on the system and upload the .zip file. + + + +Select 'create new file URL' and await for the upload to be completed + + + +You will then be presented with additional customisation options as well as the URL that needs to be added to your server.properties content. + + + +Go into your `server.properties` file and where it has resource-pack paste in the URL provided from the website like so. + + + +--- + +#### Compliance Reporting + +This service is operated out of the United Kingdom and is distributed globally via the Cloudflare CDN. + +--- + +### Reporting Content + +If you notice content that shouldn't be on our platform, please inform us via a Github issue and we will complete a take-down request. + +:::note + +Content reviewed by our admins and will be dealt with accordingly, we will not respond directly with a list of actions taken. As required by law any CSAM reports will be directed to local authorities and the NCMEC. diff --git a/folder/de/src/content/docs/tools/tunnels.mdx.mdx b/folder/de/src/content/docs/tools/tunnels.mdx.mdx new file mode 100644 index 0000000000..b4d12da944 --- /dev/null +++ b/folder/de/src/content/docs/tools/tunnels.mdx.mdx @@ -0,0 +1,183 @@ +--- +slug: t/tunnels +description: Using tunnels to host without port forwarding +title: Tunnels +--- + +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you want to host a Minecraft server that others can access but don't want to or cannot forward ports due to reasons such as security implications or restrictions imposed by your host or Internet service provider, look no further than using tunnels. + +Simply put, these are proxies that run on your host and connect your server to a public network without opening a port on your router/firewall. + +This page aims to look at a variety of software used to open tunnels, their pros and cons and a bottom line: + +--- + +### Ngrok + +A single-binary application that exposes local TCP ports to the internet through secure tunnelling: to set up ngrok on your server... + +
    +
  • Create an ngrok.com account
  • +
  • Download the ngrok binary for your system
  • +
  • Copy and paste your authtoken command into the terminal, typically
  • +
+```bash +... + +/path/to/ngrok config set-authtoken + +... + +```` +
    +
  • Run the ngrok agent to expose a port
  • +
+```bash +... + +/path/to/ngrok tcp 25565 # or the port you want to expose + +... +```` + +#### Pros + +
    +
  • Relatively quick to set up (single binary)
  • +
  • Open-source integrations
  • +
+ +#### Cons + +The free version of Ngrok is very limited: + +
    +
  • Server address changes every time the ngrok agent is restarted (static URLs are only available for HTTP sites)
  • +
  • Extremely limited bandwidth (1GB/month)
  • +
+ +Additionally, ngrok does not support UDP tunnelling and therefore Geyser cannot be tunnelled for Bedrock Edition players + +#### Bottom Line + +Ngrok is best suited to development servers that should be able to be accessed from anywhere, as well as smaller servers run by those who cannot forward ports on their network equipment. + + + +--- + +### Playit + +A global proxy that exposes your game server to the Internet, securely tunneled through Playit's servers. To set up Playit on your Minecraft server... (assuming you use Bukkit or a fork) + +
    +
  • Create an account on [playit.gg](https://playit.gg) and verify your email address
  • +
  • Download the Playit agent plugin from [here](https://playit.gg/download/plugins) to your server's plugins folder
  • +
  • Restart your server
  • +
  • Click on the URL that the plugin outputs to the console or chat and log in to Playit
  • +
  • Add the agent to your account and wait for the tunnel to be created
  • +
+Your tunnel should then be active! Share the address given by Playit with your players and you should be good to go! + +#### Pros + +
    +
  • Generous free plan (4 TCP and 4 UDP ports, 6 firewall rules to block IPs and ranges etc.)
  • +
  • Premium plan only $3 per month, offers good upgrades such as extra ports and firewall rules, up to 6 external domains and even 3 dedicated IPv6 addresses (provided your network uses IPv6)
  • +
  • Static domain name for servers
  • +
  • Server plugin allows integration with Playit without running the agent as a separate process
  • +
+#### Cons +
    +
  • Playit only allows for external domains to be used on its premium plan: the free plan assigns a randomly-generated subdomain in the format `name.ply.gg`
  • +
+ +#### Bottom Line + +Playit is the most common and recommended option when it comes to Minecraft server tunnelling, with a vast community on its forums and Discord server and knowledgebase for common guides and issues. + + + +--- + +### Connect + +Minekube's Connect is a plugin that links Minecraft servers to a global network in a similar practice to [Minehut](https://minehut.com) + +#### Pros + +
    +
  • Plug and play: just drop the plugin into your server's plugins directory and copy the generated address
  • +
  • Brandable with free custom domains / sub-domains
  • +
  • Passive advertising on the Connect network allows for extra player traffic
  • +
+ +#### Cons + +
    +
  • A paid plan is required to provide an ad-free experience
  • +
+ +#### Bottom Line + +Out of the options listed on this page, Connect has the easiest setup: just install the plugin and Connect will generate a domain for you! +This option is best suited for public server owners who want simple setup with organic growth from other players joining from the Connect global network. + +:::caution +Players joining your server through the Connect network will not be able to join if secure chat is enforced. To disable this: + +- On your backend server(s), make sure `enforce-secure-profile` is set to `false` in `server.properties` +- If using BungeeCord, set `enforce_secure_profile` to `false` in `config.yml` +- If using Velocity, set `force-key-authentication` to `false` in `velocity.toml` + +This can be a downside for those who want [signed chat](/t/signed-chat) to be enforced on their servers but want to advertise and grow their playerbase on the network. +::: + + + +--- + +### Cloudflared + +Cloudflared is a server-side daemon that allows the tunnelling of network traffic through Cloudflare's secure network + +Here are some resources on how to run and tunnel Minecraft servers using cloudflared: + + + + + + +#### Pros + +
    +
  • Traffic is proxied through Cloudflare's network, renowned for its terabit-capacity DDoS mitigation.
  • +
+ +#### Cons + +
    +
  • Setup is very complicated
  • +
  • Individual tunnels must be created using cloudflared for each port that you wish to be open
  • +
  • All players must have cloudflared installed and running on their computers to access the server
  • +
+ +#### Bottom Line + +This option is best for server owners and players who are willing to take on the more complicated setup and requirements, allowing for rock-solid security without the need for DDoS protected proxy + + diff --git a/folder/de/src/content/docs/troubleshooting/connectivity.mdx.mdx b/folder/de/src/content/docs/troubleshooting/connectivity.mdx.mdx new file mode 100644 index 0000000000..bb7a0c308f --- /dev/null +++ b/folder/de/src/content/docs/troubleshooting/connectivity.mdx.mdx @@ -0,0 +1,170 @@ +--- +description: A foundation for checking connectivity issues with your Minecraft server. +slug: ts/connection +title: Connectivity +lastUpdated: 2023-12-16 +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you're having trouble connecting to your Minecraft server there's a process you should follow in order to try and understand where the issue lies. If you're running on a third party hosting provider it's recommended to reach out to them directly or check their status page. + +### Server Binding to Port + +The first thing to check is that your server binds to the right port when you start it up, firstly you should see some errors in the console. This error will normally come from having two server processes running at the same time or you run an application on the same port as your Minecraft server. + +```bash +... + +**** FAILED TO BIND PORT! **** +The exception was: java.net.BindException: Address already in use +Perhaps a server is already running on that port? + +... +``` + +You can fix this by going to the `server.properties` file and look for the `server-port` variable and increase the number by 1. When you restart the server you should see the server start up without issues. + +If you don't see the above error message you can check using Powershell or Bash that your server is listening. + +#### Windows + +If you're running on windows please use the following command within a Powershell prompt. + +```powershell +... + +netstat -ano | find "{SERVER-PORT}" | find "LISTEN" + +... +``` + +#### Linux + +If you're running a linux distribution please use the following command within your active shell session. + +```bash +... + +netstat -anpe | grep "{SERVER-PORT}" |grep "LISTEN" + +... +``` + +Regardless of the operating system being used you should see one entry bound to 0.0.0.0, if you don't go back and ensure the `server-port` variable has been set properly. + +:::tip +If you're still having issues try deleting the server.properties file and then restart the server to recreate the file. One the file is deleted you can try again. +::: + +--- + +### OS Firewalls + +Now we know that the server is running on the right port you should check that the connection is allowed to break out past 'localhost' (the pc the server is running on). You can run the following command(s) depending on your OS to ensure the local firewall is configured. + +#### Windows + +If you're running on windows please use the following command within a Powershell prompt. + +```bash +... + +netsh advfirewall firewall add rule name= "Open Port 25565" dir=in action=allow protocol=TCP localport=25565 + +... +``` + +#### Linux + +If you're running a linux distribution please use the following command within your active shell session. + +```bash +... + +sudo iptables -I INPUT -p tcp -m tcp --dport 25565 -j ACCEPT + +... +``` + +To ensure things are all working locally within your network, attempt to connect from another device in your house to the internal LAN address. e.g. `192.168.1.58:25565` + +You can find your host devices internal LAN address by running `ipconfig` within command prompt or `ip addr` / `ifconfig` will work on Linux within the shell session. + +--- + +### External Port Forwarding + +Providing you can connect internally to your server, the issue most likely falls with either your router and port forwarding or your ISP and their use of CGNAT. + +The first thing we need to check is port forwarding is configured correctly. + +:::note +You will need to slightly adjust the below steps as the wording on every router model / firewall is different. +::: + +
    +
  • Login to the admin interface (normally on http(s)://192.168.1.254 or http(s)://192.168.1.1)
  • +
      +
    • Admin username and password is normally on the bottom but a Google search may also help
    • +
    +
  • Look for a 'Port Forwarding / NAT folder'
  • +
  • You may need to go into any 'Advanced Settings' tab first
  • +
  • You should ensure the rule has been configured as expected
  • +
      +
    • Service Name - 'Minecraft'
    • +
    • Protocol - 'TCP'
    • +
    • Internal IP - 'Internal LAN IP of Host Device'
    • +
    • Internal Port - 'Match server.properties file'
    • +
    • External Port - 'Match server.properties file'
    • +
    +
  • Save changes
  • +
+ +:::note +It might not be possible to reach your external IP from inside your own network so a tool like Can You See Me can check the port 25565 from an external source. +::: + +If all has been successful you should see OPEN but if you still see CLOSED it could be possible you're running behind CGNAT. + +You can find a great explanation on CGNAT below. + + + +--- + +### SRV Troubleshooting + +Since release 1.3 Minecraft supports a method of connectivity called 'SRV' Record, in principle they allow you to bind a hostname such as `play.mycoolserver.net` to an ip and a random port. The difference when using an SRV record over an A record is if you have a non standard port e.g. 25570 for your Minecraft server an A record would require you to type `play.mycoolserver.net:25570` into your client. + +In using an SRV record you bind the hostname and the service you're running (a Minecraft server) to the specific port so when you go to your client you would only have to type `play.mycoolserver.net` into your client and the SRV record would tell your client "hey use this port". + +:::note +Sometimes an end user may be using a DNS provider that doesn't support SRV records, any issues they have with connectivity can be resolved by changing their local DNS servers to a free public resolver such as one below. + +
    +
  • Quad9: 9.9.9.9
  • +
  • Cloudflare: 1.1.1.1
  • +
  • Google: 8.8.8.8
  • +
+::: + +When you create the record you should ensure it's configured as follows: + +`_minecraft._tcp. IN SRV 1 1 ` + +
    +
  • Host - this should be your current providers connection hostname
  • +
  • TTL - set this to auto if using Cloudflare DNS or 3600 in any other dns providers panel
  • +
  • Port - this should be the port you're currently using to connect to your server with
  • +
  • Subdomain - this should represent what you want your players to connect with
  • +
+ +An example of a functional SRV record has been provided below, this was created in Cloudflare's DNS manager so if Cloudflare is not your DNS solution then you may have a slightly different interface. + + diff --git a/folder/de/src/content/docs/troubleshooting/ip.mdx.mdx b/folder/de/src/content/docs/troubleshooting/ip.mdx.mdx new file mode 100644 index 0000000000..6829c4967a --- /dev/null +++ b/folder/de/src/content/docs/troubleshooting/ip.mdx.mdx @@ -0,0 +1,58 @@ +--- +description: One of the core fundamentals of networking, this page outlines the types of addresses you will come across and how you can work around them. +slug: ts/ip +title: IP Addresses +lastUpdated: 2023-12-16 +--- + +Every connected device has an IP address, similar to how every mobile phone also has a mobile number and we use this number to reference "hey, this is me... you can find me here". Similarly to phone numbers, when it comes to IP addresses we have two different types for internal (private networks) and external (public networks) usage. + +Within your house every laptop, desktop, phone etc has what we call an 'internal' IP, this will normally be represented as 192.168.0.(insert number here). If you run either `ipconfig /all`, `ip addr` or `ifconfig` command you will see your devices individual address. + +Private networks are great because we can reuse these address pools in every household without using any of our global quotas for addresses, when your local device makes a request this is sent to your device's `default gateway` address and requests information on how to proceed. + +If the request is for another local address it sends it where it needs to go and adds this address to it's "table of contents" however if you're trying to reach something outside of your network e.g. youtube.com or netflix.com your router makes a note of the original requesting device and uses it's `external address` to make that request on your behalf. + +We call this technology 'NAT', to understand why NAT exists you need to understand the challenges of IPv4 addresses. + +### Why NAT Exists + +With v4 addresses we have a limited supply of uniquely available addresses 4.3 billion to be precise. This number does sound huge until you realise that companies like Google, Microsoft, Facebook, US DoD and many, many more organisations hold tens of thousands IP addresses for business, cloud computing and just because they can which significantly shortens the pool that can be used by consumers. + +In order to combat this, NAT was introduced as a solution to provide a single entry and exit point for a network. This also allows us to bring additional connections online to the digital world which is rapidly becoming difficult to support. As the world becomes more connected and the IPv4 shortage gets worse more residential connections will move from 'Dynamic IPs to CG-NAT'. + +--- + +### Interim Technologies + +In order to stop the world falling apart, very smart individuals came up with the following solutions starting with the newest first. + +#### Dual Stack + +Dual Stack connections consist of providing both an IPv4 and IPv6 connection and helps encourage these large organisations to support the future technology (in principle, the more devices that support it the greater compatibility becomes). This is great middle-ground as it uses IPv6 first, then, if there is no IPv6 support implemented by a provider it can fall back to using a universal IPv4 address provided by your ISP (see CGNAT for more). + +Unfortunately progress towards a native IPv6 world is slow and DS will be around for a good few years to come before we can finally start to retire this dated address scheme. + +#### CG-NAT + +With CGNAT your ISP takes the concept of 'NAT' and applies it to their entire infrastructure. No longer do you have your own address provided for connecting out to the internet you instead utilise a unique private address pool to connect multiple routers to a central break out location (e.g. an internet exchange). With multiple people sharing the same public address this ultimately means no more residential port forwarding, an issue that that proves difficult for the home-hoster. + +#### Dynamic IPs + +Dynamic addresses allow your ISP to re-allocate your IP to another house waiting to get online in the event you turn off your router / lose power. It prevents idle connections claiming addresses when they're not being used so your ISP doesn't have to try and buy heavily overpriced IPs. + +For the average person this isn't the end of the world, you'll always be able to get online however if you decide to host services at home this can become a problem in the event your allocated IP changes. Anyone who connects to your service will need to be informed of the address changes and this can become a pain if you're on holiday but this can be mitigated with DDNS solutions such as [No-IP](https://noip.com). + +--- + +### The Future (IPv6) + +To every administrator's disappointment IPv6 is essential if we want to keep devices online. The address pool is significantly larger and there's enough of these IPs to allocate to every atom on the planet and we'd still have enough to repeat it 100 times over! Unfortunately with any new technology this won't become the norm overnight, IPv4 will be around for the next 30 years in one way shape or form. It is a huge learning curve for some and it will require many organisations to reconsider their current networking setups. + +The good news is adoption **IS** underway but there's still a lot of work to be done. A huge list of services that are not yet IPv6 native can be found [here](https://whynoipv6.com/), if you find a service you use on this list - give them a nudge and voice the need for change. + +### Cheat Sheets + +Avast have produces a nice summary cheat sheet which sums up everything listed above. + + diff --git a/folder/de/src/content/docs/troubleshooting/java.mdx.mdx b/folder/de/src/content/docs/troubleshooting/java.mdx.mdx new file mode 100644 index 0000000000..504825c30f --- /dev/null +++ b/folder/de/src/content/docs/troubleshooting/java.mdx.mdx @@ -0,0 +1,87 @@ +--- +description: Understand and troubleshoot some of the most common issues with Java when setting up your Minecraft server. +slug: ts/java +title: Java +--- + +Sometimes you can have issues at the first hurdle, getting your server to boot. Some of these issues are to do with your Java deployment and we will cover some quick fixes to get you up and running. + +### Missing PATH variable + +Depending on the OS you're running there are multiple ways to set the ENV / PATH location to call upon the java executable. + +#### Windows + +If you're on windows this can be done entirely via the UI however some steps maybe slightly different depending on your Windows release. Below are steps based on Windows 11. + +
    +
  • Navigate to `c:\program files\java` and identify the JDK version folder name e.g. `jdk-19`
  • +
  • Open the bin folder within the JDK folder and copy the full folder path from file explorer
  • +
  • Select the Windows icon open the start menu and go to 'Settings'
  • +
  • Select the 'System' tab on the left hand side and go to the 'About' menu
  • +
  • Open 'Advanced System Settings'
  • +
  • Select the 'Advanced' tab
  • +
  • Select 'Environment Variables'
  • +
  • Under 'System Variables' scroll down until you see 'Path'
  • +
  • Select 'Edit'
  • +
  • Now select 'New' and paste in the file explorer path you copied earlier
  • +
  • Press 'OK' to save changes
  • +
+ +You can verify the above steps have worked as expected by running the following command in a command prompt window. + +`java --version` or `javac` + +#### MacOS + +If you're running MacOS there's two different commands you could possibly run, the first (bash) is more for older devices and the latter (zsh) is for anything running Catalina or newer. + +##### Bash Command + +```bash +... + +echo export "JAVA_HOME=\$(/usr/libexec/java_home)" >> ~/.bash_profile +exec bash -l + +... +``` + +##### ZSH Command + +```bash +... + +echo export "JAVA_HOME=\$(/usr/libexec/java_home)" >> ~/.zshrc +exec zsh -l + +... +``` + +--- + +### Memory allocation + +--- + +### Wrong version of Java installed + +When it comes to the 'wrong version installed' there's a few factors to consider. + +
    +
  • Bit edition (x86 or x64 or ARM etc)
  • +
  • Major LTS revision
  • +
+ +You can identify if you're having issues due to the bit version by lowering the start-up args from a value greater than `4` for -Xms and -Xmx. If your server boots without issues to the `Done in X seconds` line you will need to uninstall your java release and download the 64 bit edition as this doesn't have the 4GB RAM memory limitation. + +If your server still doesn't boot after decreasing the RAM it's most likely that your machine has the wrong edition of Java installed, certain major releases of Java dropped legacy builds as time has gone on. + +The most commonly adopted Java releases are as follows: + +
    +
  • Java 8 (LTS)
  • +
  • Java 11 (LTS)
  • +
  • Java 17 (LTS)
  • +
  • Java 19 (LTS)
  • +
diff --git a/folder/de/src/content/docs/troubleshooting/latency.mdx.mdx b/folder/de/src/content/docs/troubleshooting/latency.mdx.mdx new file mode 100644 index 0000000000..1a882157f1 --- /dev/null +++ b/folder/de/src/content/docs/troubleshooting/latency.mdx.mdx @@ -0,0 +1,57 @@ +--- +description: Understand latency and how it can play a part in the user experience of your Minecraft server. +slug: ts/latency +title: Latency +lastUpdated: 2023-12-16 +--- + +If you've ever run a server, played on a server or you're Australian then the phrase "IT'S LAAAAAAAAAAAAAAAGING" probably sounds familiar. + + + +Unfortunately this isn't always something that's easily correctable, providing you've ensured the issue isn't related to your hardware the server runs on then you should consider the network and primarily latency. + +Latency related issues can normally be identified by one of these factors being true. + +
    +
  • Blocks don't automatically disappear after being mined
  • +
  • One bar of connectivity in the tab menu
  • +
  • You're located on the other side of the planet
  • +
+ +Technically speaking, the total duration of the request being sent from your machine, processed by the recipient and then sent back is measured in milliseconds 'ping' (latency). The longer it takes to process a request the more noticable and degraded your user experience becomes. + +:::note +If you've previously been able to join a Minecraft server without issues but you login the next day and it's unplayable then the latency should resolve with time. This is most likely due to maintenance in a datacentre somewhere on the planet that your requests utilise. + +
+Your ISP is unable to do anything about latency +::: + +### Tools to Help + +Unfortunately there is no single tool to fix your problem however if you're looking at hosting a Minecraft server for friends split across the globe we've got some advice and test locations you can use to estimate your ping. + +#### Testing Latency + +Before you purchase a server, you will want to test the location for it's ping. Vultr offer a wide range of locations that all support both IPv4 and IPv6 and respond to ICMP (ping), MTR and traceroute requests. + +We have selected 4 of their locations that represent the most common locations offered by service providers. You can use any of these locations to get an indication of what your ping would be like to any future server you buy, it could also be worth sending these links to your community memebers to ensure you find the best compromise for your entire playerbase. + +
    +
  • [https://lon-gb-ping.vultr.com](https://lon-gb-ping.vultr.com) - London, UK
  • +
  • [https://fra-de-ping.vultr.com](https://fra-de-ping.vultr.com) - Frankfurt, DE
  • +
  • [https://tor-ca-ping.vultr.com](https://tor-ca-ping.vultr.com) - Toronto, CA
  • +
  • [https://sgp-ping.vultr.com](https://sgp-ping.vultr.com) - Singapore, SG
  • +
+ +#### Ideal Ping + +Generally you can tollerate higher than normal ping within Minecraft compared to FPS titles due to the fact it's played at a slower pace. + +| Ping (MS) | Summary | +| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 0-10 | You're either hosting the server locally or the server is hosted within your city / country (providing you're an FTTP customer). | +| 11-50 | This is where most of your connections will reside, most often will also account for servers hosted in neighbouring countries / states. | +| 51-150 | This is where you _could_ start to see the occasional block break delay or quick movements might not work as expected. The avg Hypixel ping is roughly in this ball park. | +| 151 + | Most lag related complaints will occur from players in this category (mostly from Asia / Aus). If you have a large audience in this region it would be worth considering a second server here. | diff --git a/folder/es/src/content/docs/about.mdx.mdx b/folder/es/src/content/docs/about.mdx.mdx new file mode 100644 index 0000000000..02c898354a --- /dev/null +++ b/folder/es/src/content/docs/about.mdx.mdx @@ -0,0 +1,65 @@ +--- +title: About Us +description: We're an administration wiki for Minecraft server administrators who are looking to enhance their server experience. +template: splash +--- + +We're building the ultimate Minecraft documentation project and if you're interested in making things even better this is the page for you. + +This page will be split up into three sections to help you get about: + +
    +
  • New Ideas
  • +
  • New Content
  • +
  • Improving Content
  • +
+ +:::caution + +If you don't already have a Github account you will be required to make one before proceeding, you can create one at https://github.com/signup. + +::: + +### Submitting Ideas + +If you're an administrator looking for docs that we don't currently have information on then this is probably the section for you, it will explain how to raise a new Github issue with the information required for us to get the ball rolling with your request. + +
    +
  • Head on over to the [setup.md Github repository](https://smd.gg/repoissue)
  • +
  • In the menu bar at the top select 'Issues'
  • +
  • Select 'New Issue'
  • +
  • Select 'Feature Request'
  • +
  • Complete the required sections on the provided form
  • +
+ +Ensure you fill out the form with as much information as you can as this will help us build better documentation + +--- + +### Writing Content + +If you're interested in writing content / migrating your own doc environment over to our wiki a Github PR is your best option. Please also ensure you have followed our [styling guide](https://contribute.setup.md) to ensure your PR doesn't get rejected for lack of continuity. + +#### Single Articles + +If you're going to write a single article you can do so with the following steps, before you consider uploading a document please ensure you are using a template from our [sister github repository](https://github.com/setupmd/templates/tree/main/Docs). + +
    +
  • Head on over to the [setup.md Github repository](https://smd.gg/pr)
  • +
  • In the menu bar at the top select 'Pull Requests'
  • +
  • Select 'New Pull Request'
  • +
  • Select the branch of your forked repo that you wish to commit as a PR
  • +
  • Select 'View Pull Request'
  • +
+ +The setup.md contributors will then verify the PR is good and will approve your content. + +#### Migrating Wikis + +If you already use docusaurus for your own project, adding your content here is super easy and should be a drag and drop migration. You'll need to [submit a PR](https://smd.gg/pr) but it's recommended you reach out to us on [Discord](https://smd.gg/discord) so we can setup some indexing for your future content. + +--- + +### Improving Content + +As Minecraft continues to grow so will our project and we hope that if you spot inconsistancies in our project you'll hit the 'Edit Page' link at the bottom to submit a PR request with any corrections you wish to make. diff --git a/folder/es/src/content/docs/enhancements/Anti-X Tools/anticheat.mdx.mdx b/folder/es/src/content/docs/enhancements/Anti-X Tools/anticheat.mdx.mdx new file mode 100644 index 0000000000..aebeeaef0b --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Anti-X Tools/anticheat.mdx.mdx @@ -0,0 +1,282 @@ +--- +description: A brief introduction to Anti-Cheats and the community recommended solutions. +slug: e/anti-x/ac +title: Anti-Cheats +lastUpdated: 2024-02-25 +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +:::info +Throughout this guide 'Anti-Cheat(s)' may be referred to as 'AC' or 'ACs' +::: + +ACs are an integral part of any public server and help with catching hackers, since Minecraft's built-in anti-cheat is practically useless, it's better to turn it off than to endure the constant false positives it spews out. + +You should change the following settings within the `server.properties` file. + +```yml +... + +allow-flight=true + +... +``` + +Within the `spigot.yml` file you should also set the following values. + +```yml +... + + moved-wrongly-threshold: 100000.0 + moved-too-quickly-multiplier: 100000.0 + +... +``` + +For the recommended anti-xray settings [click here](https://www.setup.md/e/anti-x/ax). + +:::warning +We highly discourage the usage of auto-bans as no anti-cheat is perfect. If you want to auto-ban, consider having something like AntiCheatReplay so that you can undo false bans. +::: + +### Common Anti-Cheats + +This list consists common ACs and some pros and cons of each AC. + +#### NoCheatPlus Spigot / Paper & forks only + +##### Pros + +
    +
  • Free and open-source
  • +
  • Good movement checks
  • +
+ +##### Cons + +
    +
  • Default configuration will spam false movement positives all over the place, you should buy a good config (eg. [MarkElf's](https://www.mc-market.org/resources/475/)) OR make your own
  • +
  • Mediocre combat checks
  • +
+ + + +--- + +#### Grim Spigot / Paper & forks only + +##### Pros + +
    +
  • Open-source
  • +
  • Great movement checks
  • +
  • Predictive technology
  • +
+ +##### Cons + +
    +
  • Currently WIP, not ready for production servers
  • +
  • Mediocre combat checks
  • +
  • Quite unoptimized
  • +
+ + + +--- + +#### Vulcan Spigot / Paper & forks only + +##### Pros + +
    +
  • Great movement and combat checks
  • +
  • Good default config
  • +
+ +##### Cons + +
    +
  • USD 20.00
  • +
  • Suboptimal performance when scaled to high player counts (>3% of ticks at 420 players)
  • +
+ + + +--- + +#### Spartan Spigot / Paper & forks only + +##### Pros + +
    +
  • 14-day money-back guarantee
  • +
  • Good Bedrock Checks
  • +
  • Decent movement checks
  • +
+ +##### Cons + +
    +
  • EUR 22.49
  • +
  • Relatively poor combat checks
  • +
  • Crashes on start up at times
  • +
  • Sub-par performance
  • +
+ + + +--- + +#### Matrix Spigot / Paper & forks only + +##### Pros + +
    +
  • Decent movement and combat checks
  • +
+ +##### Cons + +
    +
  • Bad default config, but there are some [good ones](https://github.com/QuantumSuite/MatrixChecks) out there
  • +
  • USD 20.00 (With 95% Checks) and USD 129.00 (All Checks)
  • +
  • Dedicated Server Limit
  • +
  • Terrible performance; Ate up >5% of the ticks at 135 players
  • +
+ + + +--- + +#### Themis Spigot / Paper & forks only + +##### Pros + +
    +
  • Free
  • +
  • Proper Geyser-Floodgate (Bedrock Players) checks (Only reason to use this anti-cheat)
  • +
+ +##### Cons + +
    +
  • Bad Combat & Mediocre Movement checks (Bad Elytra, Timer, KillAura Checks)
  • +
  • Lack of checks in general
  • +
+ + +
+ +:::note +This anti-cheat is optimised for bedrock players. +::: + +--- + +#### SoaromaSAC (Config 6) Spigot / Paper & forks only + +##### Pros + +
    +
  • Free
  • +
+ +##### Cons + +
    +
  • Bad Checks
  • +
  • Infinite False Positives
  • +
  • Fake Open Source Link. Leads to a Rick Roll
  • +
+ + + +--- + +#### Negativity v1 & v2 All major Java platforms + +##### Pros + +
    +
  • Free & Open Source
  • +
  • Paid Version (v2) is Open Source
  • +
  • v2 supports a lot of platforms (Minestom, Sponge, Fabric & more)
  • +
+ +##### Cons + +
    +
  • Lacks some important checks (No Elytra Checks, NoSlow Checks etc)
  • +
  • Poor movement and combat checks
  • +
+ + + +--- + +#### Polar + +##### Pros + +
    +
  • Great movement and combat checks
  • +
  • Works out-of-the-box on most servers
  • +
  • Cloud-based detections, which helps reducing stress on server resources
  • +
+ +##### Cons + +
    +
  • Subscription plans starting at EUR 15/month
  • +
  • Limitations on player count, server instances and dedicated servers based on subscription plan
  • +
+ + + +### Recommendations + +Both Astro and Vulcan offer a great price to performance ratio. However, Astro will be significantly lighter on system resources. +Also, Vulcan will support Bedrock in the near future. Astro already supports it. + +:::tip +Remember, no anti-cheat is perfect. Players will be able to bypass anti-cheats, so we recommend having a moderator or two online to keep an eye out for any cheaters. +::: diff --git a/folder/es/src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx.mdx b/folder/es/src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx.mdx new file mode 100644 index 0000000000..1ee39234bd --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx.mdx @@ -0,0 +1,47 @@ +--- +description: A brief introduction to Anti-Exploits and the community recommended solutions. +slug: e/anti-x/ae +title: Anti-Exploit +lastUpdated: 2024-02-25 +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +Anti-Exploit plugins resolve issues such as crashes, dupes, abusive NBT etc. + +:::info +Some of these plugins might only be useful if you are not using the latest version of Paper. +::: + +#### Panilla + +Panilla prevents abusive NBT and packets. Average or lenient modes recommended. Recently was found to be messing with items contained within shulkers, so test the plugin before you install it on production. + + + + + + +--- + +#### LPX + +Avoids NettyCrashers, slightly prevents Anti-Anti-Xrays, logs packets and limits them. + + + +--- + +#### BookExploitFix + +Improve the security of your Minecraft server by filtering illegal content from player created books. Although personally I would completely disable books because I don't trust them at all, you may use this plugin instead. + + + + + diff --git a/folder/es/src/content/docs/enhancements/Anti-X Tools/antilag.mdx.mdx b/folder/es/src/content/docs/enhancements/Anti-X Tools/antilag.mdx.mdx new file mode 100644 index 0000000000..511bac4815 --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Anti-X Tools/antilag.mdx.mdx @@ -0,0 +1,85 @@ +--- +description: A brief introduction to Anti-Lag and alternative performance management tools. +slug: e/anti-x/al +title: Anti-Lag +lastUpdated: 2024-02-25 +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +Below is a list of tools and optimisations you can use to identify and mitigate TPS (server) lag. + +:::caution +**Anti-lag plugins such as ClearLagg "don't work".** + +These plugins periodically clear dropped items at a set interval - this makes a negligible difference to lag and most anti-lag plugins have poor detection that can result in more lag. Aside from the fact any "gains" seen by such tools are just hiding performance issues under a thin veil rather than actually fixing them. +::: + +#### Guides to Optimisation + +We have published a couple of proven guides on optimisations below that should be reviewed first. + + + +--- + +#### Spark + +A modern performance profiler for 1.8+ servers on any platform - Forge, Spigot, Fabric, almost anything that isn't the vanilla server! This isn't an anti-lag plugin per se but it can help you find what's _causing_ lag on your server. + +It now comes built-in with the Purpur performance JAR and its forks. + + + + + + + +--- + +#### FarmControl + +This plugin allows you to manage certain properties of farms on your server. Among other things, the plugin acts as a farm limiter, can remove the ability of mobs in farms to collide and perform random movements, or can completely disable the AI of mobs in farms. These actions can be performed either passively or in response to the server's performance degrading. + + + + + + +--- + +#### EntityDetection + +This plugin lets you quickly find chunks with large quantities of mobs/animals & tile entities. Not an anti-lag plugin, but can be incredibly useful + + + + + + +--- + +#### CAProtect-Lite + +Prevents players from lagging the server with minecarts and boats. If you have FarmLimiter, consider configuring that plugin to do what CAProtect does instead, as CAProtect is a bit more intensive. Otherwise, consider using AjMac's fork. + + + + + + +--- + +#### RedstoneLimiter + +RedstoneLimiter is a plugin that limits how many times individual redstone contraptions can be activated in a customizable amount of time to fix lag machines. + + + + + diff --git a/folder/es/src/content/docs/enhancements/Anti-X Tools/antixray.mdx.mdx b/folder/es/src/content/docs/enhancements/Anti-X Tools/antixray.mdx.mdx new file mode 100644 index 0000000000..d18466f8b8 --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Anti-X Tools/antixray.mdx.mdx @@ -0,0 +1,50 @@ +--- +description: A brief introduction to Anti-Xray and the community recommended solutions. +slug: e/anti-x/ax +title: Anti-Xray +lastUpdated: 2024-02-25 +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +As the name suggests, Anti-Xray will prevent players from finding ores using Xray clients/resource packs. This is done by sending packets to the player where all of the ores are replaced by stone. The ores only appear if the player establishes direct visual contact with them/updates them. Two of the most common Anti-Xray plugins are shown below: + +#### PaperMC + +PaperMC (A fork of Spigot) comes with a built-in Anti-Xray. This Anti-Xray usually does the trick just fine. It is simple to setup and causes no lag for both the server and the client (unless you hide caves (air), which will be much laggier for the client). A great guide is shown [here](https://docs.papermc.io/paper/anti-xray). Again, make sure that you do NOT add `air` to `hidden-blocks`. + + + +--- + +#### Orebfuscator + +If you're stuck using Spigot for whatever reason, you should probably use Orebfuscator. It may also work well in junction with Paper's Anti-Xray, as it can also +hide containers better. + + +
+:::note +Orebfuscator does have a tendency to turn chests into dirt when server is laggy, this is a visual thing and doesn't delete the contents of said chests +::: + +--- + +### RayTraceAntiXray + +Paper plugin for server-side async multithreaded ray tracing to hide ores that are exposed to air using Paper Anti-Xray engine-mode 1. Might be worth using instead of engine-mode 2 as that can cause lag on slow devices. Only recommended if you have extra threads and don't mind using ProtocolLib. + + diff --git a/folder/es/src/content/docs/enhancements/Anti-X Tools/intro.mdx.mdx b/folder/es/src/content/docs/enhancements/Anti-X Tools/intro.mdx.mdx new file mode 100644 index 0000000000..5237647b53 --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Anti-X Tools/intro.mdx.mdx @@ -0,0 +1,22 @@ +--- +sidebar_position: 1 +slug: e/anti-x +description: Understand the types of 'preventative' tools that exist for Minecraft servers. +title: Introduction +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +Minecraft is an open game by nature and as great as that is, it doesn't always work in every servers favour and sometimes they need to make changes in order to restrict certain aspects of gameplay for any number of multiple reasons. + +The most common types of plugins you'll see in this category are: + + + + + + + + +We will attempt to cover multiple examples of each where possible. diff --git a/folder/es/src/content/docs/enhancements/Economy/chest.mdx.mdx b/folder/es/src/content/docs/enhancements/Economy/chest.mdx.mdx new file mode 100644 index 0000000000..59dccbe225 --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Economy/chest.mdx.mdx @@ -0,0 +1,17 @@ +--- +description: A focus on traditional chest based plugins for your servers economy. +slug: e/eco/chest +title: Chest Based +--- + +A chest shop is a Minecraft resource buying - selling enhancement that is fully craftable in game using normally a standard chest and a wooden sign. These solutions normally bring a more player-to-player style interraction with players chosing to rent space in an admin market / build their own market. + +### Examples + +We have collated a small list of plugins you can use to get you started with on your Minecraft server below. + +
    +
  • [QuickShop](/e/pl/quickshop)
  • +
  • [ChestShop](/e/pl/chestshop)
  • +
  • [DukesMart](/e/pl/dukesmart)
  • +
diff --git a/folder/es/src/content/docs/enhancements/Economy/gui.mdx.mdx b/folder/es/src/content/docs/enhancements/Economy/gui.mdx.mdx new file mode 100644 index 0000000000..7844735528 --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Economy/gui.mdx.mdx @@ -0,0 +1,19 @@ +--- +description: A focus on GUI based plugins for your servers economy. +slug: e/eco/gui +title: GUI Based +lastUpdated: 2024-01-01 +--- + +A GUI based shop plugin allows users to buy and sell using an interface, normally that of chests and can sometimes be more accessible for your players. + +### Examples + +We have collated a small list of plugins you can use to get you started with on your Minecraft server below. + +
    +
  • [AuctionHouse](/e/pl/auctionhouse)
  • +
  • [PlayerAuctions](/e/pl/playerauctions)
  • +
  • [PlayerShops (BPS)](/e/pl/playershops)
  • +
  • [zAuctionHouse](/e/pl/zauctionhouse)
  • +
diff --git a/folder/es/src/content/docs/enhancements/Economy/intro.mdx.mdx b/folder/es/src/content/docs/enhancements/Economy/intro.mdx.mdx new file mode 100644 index 0000000000..0319535ab4 --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Economy/intro.mdx.mdx @@ -0,0 +1,26 @@ +--- +description: Recommended plugins to kick start your Minecraft server's economy. +slug: e/eco +title: What is an economy? +sidebar: + order: 1 +--- + +An economy is essential to your Minecraft server, it allows for players to buy and sell between one another or between your players and the server for in-game ranks / items etc. + +Economies within Minecraft, much like the real world, can dictate supply and demand with availabilities of resources to your players. For example if you were running admin shops it would be possible to run a discount on certain items and random points within the year or if you want to make a product more valuable then this can be achieved too. + +The goal with this section is to highlight some viable options for your server along with some example plugins that will allow you to build the framework for your own server's economy to take place. + +### Requirements + +Most, if not all plugins require your server to have an Economy API (such as [Vault](/e/pl/vault)) and an Economy Handler installed. + +Some example economy handlers are below: + +
    +
  • [EssentialsX](/e/pl/essentialsx)
  • +
  • [TheNewEconomy](/e/pl/theneweconomy) (Optional Vault Support)
  • +
  • [iConomy](/e/pl/iconomy)
  • +
  • [Gringott's Economy](/e/pl/gringottseco)
  • +
diff --git a/folder/es/src/content/docs/enhancements/Economy/shop.mdx.mdx b/folder/es/src/content/docs/enhancements/Economy/shop.mdx.mdx new file mode 100644 index 0000000000..9fd5bcd954 --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Economy/shop.mdx.mdx @@ -0,0 +1,44 @@ +--- +description: A focus on /shop based plugins for your servers economy. +slug: e/eco/shop +title: Command Based +--- + +### /shop Plugins + +/shop Plugins are server-sided shops, meaning that all items are bought and sold from and to the the server instead of a player. + +#### ShopGUI+ + +ShopGUI+ is probably the most well known /shop plugin out there. Kitted out with basically every feature you might need (other than a dynamically evolving economy), it is a pretty solid choice for most servers. +Too bad that it's 18 USD and performs poorly when scaled to higher player counts. Only worth buying if you want support for other plugins. + +
+Spigot +
+ +#### BossShopPro + +Solid /shop plugin with a lot of good features. I highly recommend that you find a fork to download instead of using the old SpigotMC version. + +
+Spigot +
+ +#### EconomyShopGUI + +Free, simple /shop plugin that just does the job. It also has a premium version for 12 USD. Free version is extremely limiting. + +
+Spigot +
+ +#### DeluxeMenus + +Now hear me out.. I know that DeluxeMenus isn't exactly a server-shop plugin, but it is nearly perfect for the job since it is EXTREMELY flexible. cj89898 has made a wonderful DeluxeMenus shop [here](https://github.com/cj89898/DeluxeMenus-DeluxeShop). + +You may also use a setup.md provided version [here](https://github.com/setupmd/templates/raw/main/Plugin%20Configurations/deluxemenusshop.zip). + +
+Spigot +
diff --git a/folder/es/src/content/docs/enhancements/Permissions/breakdown.mdx.mdx b/folder/es/src/content/docs/enhancements/Permissions/breakdown.mdx.mdx new file mode 100644 index 0000000000..467527519f --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Permissions/breakdown.mdx.mdx @@ -0,0 +1,28 @@ +--- +sidebar_position: 1 +slug: e/perms +title: How They Work +lastUpdated: 2024-01-01 +sidebar: + order: 4 + badge: + text: Important + variant: danger +--- + +When you're setting up a new server, a very important part of the process is managing permissions and **configuring them as you go**. + +Permissions are little pieces of text that indicate an action. When you grant a certain group of players this permission, the plugin will know that they are allowed to perform this action. They are usually laid out like `pluginname.permission`. + +An example is the `essentials.afk` permission. If you give this permission to a player, they will be able to perform the `/afk` command. + +:::note +You can use the wildcard (`*`) operator to indicate everything when supplying a permission. +Ex: `essentials.*` will give you every permission that starts with `essentials.`. +::: + +:::danger +It is a very bad idea to give someone (even yourself!) either the `*` or `*.*` permission(s). +::: + +So how does one grant permissions to their players? For this exact purpose people have created permission plugins. They allow you to create groups, usually associated with the term Rank. You can then give certain permissions to these groups, and assign players to these groups. diff --git a/folder/es/src/content/docs/enhancements/Permissions/plugins.mdx.mdx b/folder/es/src/content/docs/enhancements/Permissions/plugins.mdx.mdx new file mode 100644 index 0000000000..a8e5b6111d --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Permissions/plugins.mdx.mdx @@ -0,0 +1,17 @@ +--- +description: A focus on permission manager plugins for your server. +slug: e/perms/plugins +title: Plugins +lastUpdated: 2024-01-01 +--- + +Permission manager plugins allow you to define groups (ranks), and permission levels for all of your players on your server. + +### Examples + +We have collated a small list of plugins you can use to get you started with on your Minecraft server below. + +
    +
  • [LuckPerms](/e/pl/luckperms)
  • +
  • [PowerRanks](/e/pl/powerranks)
  • +
diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/AntiCrasher.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/AntiCrasher.mdx.mdx new file mode 100644 index 0000000000..83e03f9edb --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/AntiCrasher.mdx.mdx @@ -0,0 +1,12 @@ +--- +description: AntiCrasher fixes a crash exploit that affects every version, only fixed in very recent builds of paper/pufferfish/purpur for 1.20.2 and a backport for pufferfish 1.20.1 +slug: e/pl/anticrasher +title: AntiCrasher +--- + +Fixes a very popular and very used crash exploit that affects most versions of Minecraft + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/MiniMOTD.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/MiniMOTD.mdx.mdx new file mode 100644 index 0000000000..01da7628be --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/MiniMOTD.mdx.mdx @@ -0,0 +1,33 @@ +--- +description: MiniMOTD has the functionality to add an MOTD (Message Of The Day) to your server, which shows on the Multiplayer page of Minecraft before a player logs into your server. +slug: e/pl/minimotd +title: MiniMOTD +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Bungeecord, Waterfall & Velocity Spigot / Paper & forks only +
+MiniMOTD is a plugin of which allows you to **fully** customize your server's MOTD by: + +
    +
  • Adding multiple MOTD messages that can alternate between one another
  • +
  • Adding RGB gradients
  • +
  • Adding Placeholders
  • +
  • and much more...
  • +
+ +#### Note + +Whilst MiniMOTD can run on your backend server, if you are running a network via a proxy such as Bungeecord or Velocity, MiniMOTD will be ran on your proxy. Therefore, you should download MiniMOTD to your proxy rather than your individual servers. If you are just running one singular server, MiniMOTD will run directly on that server. + + + + + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/auctionhouse.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/auctionhouse.mdx.mdx new file mode 100644 index 0000000000..93b2115d67 --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/auctionhouse.mdx.mdx @@ -0,0 +1,24 @@ +--- +description: A GUI based player shop plugin to enhance your economy. +slug: e/pl/auctionhouse +title: AuctionHouse +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+A decent /ah plugin. Unfortunately, it does have it's fair share of issues. For example, it is one of the most laggiest plugins in every server and also has caused dupes here and there (rare but still possible). + +There are better options out there with far more customizability. + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/chestshop.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/chestshop.mdx.mdx new file mode 100644 index 0000000000..3befbc50a7 --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/chestshop.mdx.mdx @@ -0,0 +1,22 @@ +--- +description: A chest based player shop plugin to enhance your economy. +slug: e/pl/chestshop +title: ChestShop +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+A simple bare bones chest shop plugin, think 'QuickShop' without all the fancy bells and whistles. ChestShop makes a great plugin for anyone who just wants to get some simple buying and selling going in their server. + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/discordsrv.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/discordsrv.mdx.mdx new file mode 100644 index 0000000000..74e97937bb --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/discordsrv.mdx.mdx @@ -0,0 +1,22 @@ +--- +description: DiscordSRV acts as a bridge between a Discord server and your Minecraft server, allowing them to communicate. +slug: e/pl/discordsrv +title: DiscordSRV +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+DiscordSRV is a very commonly used plugin that acts as a bridge between your Minecraft and Discord servers, allowing them to communicate and for actions to be called via interactions in Discord and vice-versa. DiscordSRV also supports livechat functionality between your Minecraft and Discord server so players that aren't logged in can still chat. Moreover, DiscordSRV allows for linking a users Discord account to their Minecraft account on a per-instance basis. That said, the setup of DiscordSRV relies on the creation of an application and Bot on Discord's Developer Portal. + + + + + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/dukesmart.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/dukesmart.mdx.mdx new file mode 100644 index 0000000000..89c3e66970 --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/dukesmart.mdx.mdx @@ -0,0 +1,22 @@ +--- +description: A chest based player shop plugin to enhance your economy. +slug: e/pl/dukesmart +title: DukesMart +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+A plugin to watch as the light weight chest shop plugin was rumoured to be getting one final breath of life with a fork. + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/essentialsx.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/essentialsx.mdx.mdx new file mode 100644 index 0000000000..66130c749e --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/essentialsx.mdx.mdx @@ -0,0 +1,28 @@ +--- +description: EssentalsX introduces over 130 commands for servers of all sizes which will enhance the gameplay with QoL features for all. +slug: e/pl/essentialsx +title: EssentialsX +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +EssentialsX, formerly just Essentials is the core backbone to any Minecraft server, it introduces a wide range of utility commands (all of which are permission toggle controllable) that can be used to enhance the base gameplay over the vanilla commands. + + + + + + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/luckperms.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/luckperms.mdx.mdx new file mode 100644 index 0000000000..895140d4ef --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/luckperms.mdx.mdx @@ -0,0 +1,25 @@ +--- +description: Learn about the PowerRanks plugin and how to get a basic configuration up and running. +slug: e/pl/powerranks +title: PowerRanks +lastUpdated: 2024-01-01 +sidebar: + badge: + text: New + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+PowerRanks is an alternative to Luckperms, it's a Bukkit plugin that support Spigot and it's forks. PowerRanks does have support for NukkitX but has not been updated since Dec 2023. + + + + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/playerauctions.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/playerauctions.mdx.mdx new file mode 100644 index 0000000000..605c04b36d --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/playerauctions.mdx.mdx @@ -0,0 +1,24 @@ +--- +description: A GUI based player shop plugin to enhance your economy. +slug: e/pl/playerauctions +title: PlayerAuctions +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+It has great levels of customizability and flexibility, to the point where you can edit pretty much every aspect of every single menu. It also has compatibility with lots of other plugins and also an author who is always there to provide support. + +The plugin does however lack in the open source department. + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/playershops.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/playershops.mdx.mdx new file mode 100644 index 0000000000..15ce1dedb3 --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/playershops.mdx.mdx @@ -0,0 +1,23 @@ +--- +description: A GUI based player shop plugin to enhance your economy. +slug: e/pl/playershops +title: PlayerShops (BSP) +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +It allows every player to create their own shop GUI, similarly to BossShopPro. Players may sell their items in said shop. Might replacement for ChestShops. this plugin hasn't been updated in a while, though. + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/powerranks.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/powerranks.mdx.mdx new file mode 100644 index 0000000000..60165c89ee --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/powerranks.mdx.mdx @@ -0,0 +1,25 @@ +--- +description: Learn about the Luckperms plugin and how to get a basic configuration up and running. +slug: e/pl/luckperms +title: Luckperms +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Bungeecord, Waterfall & Velocity All major Java & Bedrock platforms +
+LuckPerms is probably the most feature-rich permissions plugin in existence currently. It supports many different kinds of servers, like Bukkit/Spigot or Sponge, but also all the major proxies like Velocity and Bungeecord. + + + + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/quickshop.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/quickshop.mdx.mdx new file mode 100644 index 0000000000..9380421371 --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/quickshop.mdx.mdx @@ -0,0 +1,33 @@ +--- +description: A chest based player shop plugin to enhance your economy. +slug: e/pl/quickshop +title: Quick Shop Remake +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+QuickShop Remake is a forked and maintained version of the long standing '[QuickShop](https://dev.bukkit.org/projects/quickshop)' plugin of the earlier Minecraft days. It allows players to buy and sell between one another and the 'admin store' using chests. + +### Features + +
    +
  • Full sign support
  • +
  • Full support for multi-currency
  • +
  • Supports Taxes
  • +
  • WorldGuard, Towny, PlotSquared and Factions support
  • +
+ +And so much more, the important links for this plugin can be found below. + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/ultimatetimber.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/ultimatetimber.mdx.mdx new file mode 100644 index 0000000000..96a97d627e --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/ultimatetimber.mdx.mdx @@ -0,0 +1,31 @@ +--- +description: A free plugin that freshens up the most basic task in Minecraft - cutting down a tree. +slug: e/pl/ultimatetimber +title: Ultimate Timber +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+Give your players a new and exciting way to cut down trees in Minecraft. + +### Features + +
    +
  • Auto pickup
  • +
  • Auto replant
  • +
  • Custom animations (inc block falling)
  • +
  • Custom item drops
  • +
  • Custom sounds
  • +
+ + + + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/vault.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/vault.mdx.mdx new file mode 100644 index 0000000000..1d8fc72841 --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/vault.mdx.mdx @@ -0,0 +1,29 @@ +--- +description: Vault API is a core framework for most economy, permission and chat plugins and has become a key dependency for many plugins. +slug: e/pl/vault +title: Vault API +lastUpdated: 2023-12-16 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +The Vault API is the longest standing, most reliable permissions, chat and economy API backbone for Minecraft. It's been around for about a decade at this point in time and with every update that passes reliability has always remained. + +Vault is a plugin that once added will rarely need updating and with a lot of plugins requiring it, you should make sure it's first on your download list! + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/worldedit.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/worldedit.mdx.mdx new file mode 100644 index 0000000000..038aa582bc --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/worldedit.mdx.mdx @@ -0,0 +1,28 @@ +--- +description: WorldEdit is a plugin that's been around for over a decade and can be used to help speed up large builds / world changes. +slug: e/pl/worldedit +title: WorldEdit +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+Worldedit is a no-brainer, this is a plugin that's been around for the entire lifespan of Minecraft multiplayer as we know it and it's not going anywhere fast. If you need to move large buildings in your world, export or import schematics this is the tool for you and your build team. Consider using WETS (WorldEdit Tick Spreader) OR AsyncWorldEdit OR FastAsyncWorldEdit, as they can perform tasks faster & prevent crashes. + +Ironically, FAWE performs far worse than WE at higher player counts while it is idle due to it unnecessarily listening to player interactions. If you want to squeeze every last drop of performance out of your server and are not actively using FAWE in any way, we recommend switching back to WE. AWE's idle performance is untested. + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/worldguard.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/worldguard.mdx.mdx new file mode 100644 index 0000000000..4cf011e9e5 --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/worldguard.mdx.mdx @@ -0,0 +1,26 @@ +--- +description: WorldGuard is one of the oldest forms of 'admin land claim' systems and has been a core plugin for many servers over the last decade or so. +slug: e/pl/worldguard +title: WorldGuard +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+If you're using WorldEdit then you've most likely already heard of WorldGuard but for those who haven't WorldGuard allows you to create 'admin land claims' which will prevent certain regions from being griefable. This is a perfect solution for building playershops, central landmarks in your server such as spawns and admin shops and more. Some plugins can even hook into the WorldGuard plugin and enhance it's capability offering a better overall experience to your players. + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Free/znpc.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Free/znpc.mdx.mdx new file mode 100644 index 0000000000..3c4475eaf0 --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Free/znpc.mdx.mdx @@ -0,0 +1,37 @@ +--- +description: An NPC plugin for your Minecraft server. +slug: e/pl/znpc +title: ZPNCs +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +### ZNPCs + +ZNPCs is another popular NPC plugin. Although it is better than Citizens from a performance perspective, it is quite janky and unpleasant to setup. + + + +--- + +### ZNPCsPlus + +ZNPCsPlus delivers great performance while also being easy to setup & edit. Recommended as long as you don't mind the lack of support in other plugins for it, V2 can be compiled from the Github page. + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Premium/citizens.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Premium/citizens.mdx.mdx new file mode 100644 index 0000000000..99924efc1c --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Premium/citizens.mdx.mdx @@ -0,0 +1,23 @@ +--- +description: An NPC plugin for your Minecraft server. +slug: e/pl/citizens +title: Citizens +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +Citizens is the most popular and widely supported NPC plugin in the market. It is purchasable on Spigot and open source as well. Free downloads can be found on it's Jenkins server. Not recommended for servers with high player counts as it can eat a lot of ticks. + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Premium/litebans.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Premium/litebans.mdx.mdx new file mode 100644 index 0000000000..8d226e9d8d --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Premium/litebans.mdx.mdx @@ -0,0 +1,37 @@ +--- +description: Litebans is a premium plugin that centralises ban management for 'networked' servers. +slug: e/pl/litebans +title: Litebans +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Recommended + variant: tip +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Bungeecord, Waterfall & Velocity Spigot / Paper & forks only +
+If you're looking for a method of syncing Minecraft bans between multiple Minecraft proxies, servers (or both) or perhaps you're looking for a way to give your end users some transparency over the punishments that are handed out within your community. If this sounds of interest then Litebans is the tool for you. + +This plugin allows for central management of all punishments via a database and provides you the ability to host a public punishment website for people to view additional details. + +### Features + +
    +
  • UUID based punishments (no username change ban evasions)
  • +
  • UI is fully customisable
  • +
  • Punishment templates
  • +
  • Punishment scope support (multi-server specific)
  • +
  • Web-UI included for free
  • +
+ + + + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/Premium/zauctionhouse.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/Premium/zauctionhouse.mdx.mdx new file mode 100644 index 0000000000..5e790f5a3e --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/Premium/zauctionhouse.mdx.mdx @@ -0,0 +1,25 @@ +--- +description: A GUI based player shop plugin to enhance your economy. +slug: e/pl/zauctionhouse +title: zAuctionHouse +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +A premium version of Player Auctions. You may find greater performance in addition to a few extra features, notably the Shulker viewer and a Sell inventory but that's about it. + +Player Auctions listed in the comparison page says that several features, such as multi-currency support & custom inventories, are not in PA. This is not true as PA does have said features. + + diff --git a/folder/es/src/content/docs/enhancements/Plugins/intro.mdx.mdx b/folder/es/src/content/docs/enhancements/Plugins/intro.mdx.mdx new file mode 100644 index 0000000000..7b20e4764f --- /dev/null +++ b/folder/es/src/content/docs/enhancements/Plugins/intro.mdx.mdx @@ -0,0 +1,16 @@ +--- +sidebar_position: 1 +slug: e/pl +title: Why Plugins +--- + +Our goal is to highlight some must have plugins for Minecraft, in order for them to make the list they have to meet the below criteria. + +
    +
  • Publish to reputable marketplaces
  • +
  • Premium plugins should be on Spigot marketplace
  • +
  • Provide a benefit to either server owners or it's players
  • +
  • Reputable development team
  • +
+ +This is not a definitive list and may change as we add more plugins diff --git a/folder/es/src/content/docs/guides/Minecraft/Optimisation/advanced.mdx.mdx b/folder/es/src/content/docs/guides/Minecraft/Optimisation/advanced.mdx.mdx new file mode 100644 index 0000000000..3c1d364a04 --- /dev/null +++ b/folder/es/src/content/docs/guides/Minecraft/Optimisation/advanced.mdx.mdx @@ -0,0 +1,107 @@ +--- +slug: guides/optimisation/advanced +title: Advanced Checklist +description: A more focused approach on squeezing out every last drop of performance at scale. +sidebar: + order: 3 +--- + +This section covers plugins that you can modify/replace to improve performance. Only recommended at higher player counts. + +#### TAB + +The plugin author's optimisation guide is linked below.. The `anti-override` options are especially important as TAB's overriding is quite intensive. An additional config worth changing to false is `unlimited-nametag-mode`. + +Regarding anti-override, first make sure that none of your plugins mess with the tablist or scoreboard other than TAB itself. Some common culprits might be BetterTeams, eGlow, Paper's collision rules and CMI. + +You will have to remove eGlow in order to take full advantage of this optimisation. Once you're done modifying/removing such plugins, make sure `enable-player-collisions` in Paper's configuration is true. After you do that, you can disable player collisions in TAB's config by changing `scoreboard-teams.enable-collisions`. + +Finally, switch `anti-override` from true to false. If your tablist does not have proper order, an external plugin is probably still modifying the tablist. + +
+Guide +
+ +--- + +#### ProtocolLib & it's Dependants + +ProtocolLib is not very well optimised. Lots of plugins also abuse ProtocolLib a lot, causing even worse performance. Examples are DeluxeCombat (If ProtocolLib hook is enabled) and InteractiveChat. Removal has resulted in significantly better performance in all large servers. + +Consider finding alternatives to plugins that use ProtocolLib, or fork them to use PacketEvents. + +--- + +#### Citizens + +Citizens often eats up >5% of ticks on larger servers. It is recommended that you use ZNPCsPlus instead if you don't mind a smaller catalogue of supported plugins. Overall, ZNPCsPlus was using 0.03% of the ticks at 330 players according to a spark report. + +
+GitHub +
+ +--- + +#### ajLeaderboards + +Although ajLeaderboards has seen great optimization patches in recent times, it is still a tad laggier than it really should be. We recommend LeaderHeadsRevamped instead. Yes, LHR still works perfectly even though it hasn't seen an update in ages. + +If you insist on using ajLeaderboards, make sure `register-lp-contexts` is set to false. + +
+Spigot +
+ +--- + +#### AntiCheat + +Vulcan as an anti-cheat does not scale well at higher player counts, where every bit of performance matters. >1.6% ticks eaten at 350+ players is supoptimal. AstroAC on the other hand only eats 0.03% of ticks at 330 players while having checks that are almost as good as Vulcan's. + +Polar might also be worth it but we have yet to check it's performance at higher player counts + +Spartan (Both Java and Bedrock) is an absolute no-go for even medium-sized servers. Performance is extremely poor and checks are subpar. + +
+Astro +
+ +--- + +#### FastAsyncWorldEdit + +Although FAWE performs far better than WE when it's actually being used for building, it's performance is, rather ironically, significantly worse than standard WorldEdit's at idle due to FAWE listening to player interaction events. + +If you nor any of your plugins are actively using FAWE, consider switching to standard WorldEdit. + +--- + +#### Vanish Plugins + +It is recommended to use AdvancedVanish instead of plugins like SuperVanish and PremiumVanish as their performance is rather poor in comparison. + +
+Spigot +
+ +--- + +#### Geyser + +To offload Geyser's performance impact on your Spigot/Proxy server, you can use Geyser Standalone. Worth it for servers that have a lot of bedrock players. + +#### DiscordSRV + +If you are fine with losing a few features, consider replacing DiscordSRV with Essentials Discord as it isn't as bloated. + +#### Auction House Plugins + +zAuctionHouse is recommended as it runs the smoothest while also having the most features. PlayerAuctions is an alright alternative if you want a free plugin, but it's performance is marginally inferior. Consider enabling zAuctionHouse's cacheItems setting as well. + +#### Stacking Plugins + +Stacking plugins can be very detrimental to server performance depending on their implementations and configurations. RoseStacker is the best we've used thus far, but might end up lagging the server a bit more than if you didn't have it installed. + +#### WorldGuard + +WorldGuard allows you to prevent it from listening to certain events in it's configuration file. Could prove useful for very specific servers, but not something the average server should tinker with. diff --git a/folder/es/src/content/docs/guides/Minecraft/Optimisation/intro.mdx.mdx b/folder/es/src/content/docs/guides/Minecraft/Optimisation/intro.mdx.mdx new file mode 100644 index 0000000000..e5952e9a46 --- /dev/null +++ b/folder/es/src/content/docs/guides/Minecraft/Optimisation/intro.mdx.mdx @@ -0,0 +1,29 @@ +--- +description: This section of setup.md goes in-depth for server optimisation +slug: guides/optimisation +title: Introduction +sidebar: + order: 1 +--- + +A section for optimising Minecraft servers. Optimising your server means to improve the performance of the server by implementing tweaks without heavily modifying desired mechanics. Advanced optimisation is only recommended for large servers suffering from poor performance. + +### Spark Profiler + +You should use the Spark Profiler for monitoring server performance e.g. vanilla mechanics, plugins, GC pauses and cycles, memory usage etc. + + + +### Server JAR + + is currently the fastest, most stable free Paper fork available. Another alternative would be [Purpur](https://purpurmc.org/downloads), which provides additional mechanics for players at the expense of rather negligible performance loss against Pufferfish. +As for proxies, [Velocity](https://papermc.io/software/velocity) is easily the best option. Although it doesn't have as many plugins as Bungeecord, it is far more stable and secure by default. Most popular plugins have already added support for Velocity. + +You may also want to take a look at [UniverseSpigot](https://polymart.org/resource/universespigot-1-20-1.4805). Highly recommended for servers with player counts exceeding 200 (and experiencing lag, of course). It's $70 price tag is certainly worth it. Do be careful with what settings you change as they can drastically affect gameplay. + +| Topic | Summary | +| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Basic Optimisation | Tweaks that will likely suffice for small to medium-sized servers (\< 100 Players) assuming that they have sufficient CPU & memory resources. | +| Advanced Optimisation | Tweaks made for larger servers with at least 150 players. | diff --git a/folder/es/src/content/docs/guides/Minecraft/Plugins/luckperms.mdx.mdx b/folder/es/src/content/docs/guides/Minecraft/Plugins/luckperms.mdx.mdx new file mode 100644 index 0000000000..eb154cf5c6 --- /dev/null +++ b/folder/es/src/content/docs/guides/Minecraft/Plugins/luckperms.mdx.mdx @@ -0,0 +1,98 @@ +--- +description: Learn about the Luckperms plugin and how to get a basic configuration up and running. +slug: guides/luckperms +title: Luckperms +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Advanced + variant: note +--- + +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +### The Basics + +LuckPerms embraces many concepts like "Inheritance" or " Contexts" that might be confusing for a beginner. Consider this section a breakdown of those. + +:::info +For a more in depth explanation of the plugin, one might use the [official wiki](https://luckperms.net/wiki). + +#### Permissions + +A permission is simply put just a piece of text that plugins use to determine what a player can do. They are usually split by periods (like `minecraft.command.kick` for the vanilla /kick command). A permission can have 3 states: + +- `true`: the player can then use the feature which is associated to the permission +- `false` the player is explicitly revoked access to this command or feature. +- undefined: this permission has not been set for this group and defaults to either `true` or `false`, depending how the plugin which uses the permission has determined. + +#### Groups + +A group (or a "rank" as some prefer to call it) is a collection of permissions and other kinds of data which can be given to a player. This simplifies management of, lets say, the staff team as you can simply create a group `admin` and grant it `*` (this permission automatically allows access to everything) which can then be given to your admins and they will all have the same permissions. In this example it might seem counter intuitive, but for ranks with 100s of different permissions, it will become useful. +::: + +One Group always exists: `default`. As its name implies, everybody is in this group, and it is used to give out permissions which every player should have. + +#### Inheritance + +Inheritance is very useful to minimise repeated work. Let us consider the following example: +You have a group `VIP` and a group `MVP`. The group `VIP` is only used to **add** features on top of the `MVP` group. Yet by setting the users group to `MVP`, they would have the permissions from `VIP` revoked. This is where inheritance comes into play. You can make `MVP` inherit `VIP`, so every permission that is granted to `VIP` is automatically reflected in the permissions of `MVP`. + +#### Contexts + +Contexts define the circumstances under which a permission or other data is applied. Still confused? + +Lets take the `gamemode` context as an example. Giving a permission to a player with the context `gamemode=creative` means that they player shall only have that permission if they are in game-mode creative. Quite simple, isn't it? Many plugins add their own contexts, such as EssentialsX' `vanished` pr `god`. + +--- + +### First Steps with LuckPerms + +#### Storage + +Your first step with LuckPerms will be choosing a storage solution. This is a very extensive topic, as each of the storage types come with their own advantages and disadvantages. +A good write up on this would be the [official article](https://luckperms.net/wiki/Storage-types) in the LuckPerms wiki. Essentially there are 3 types of storage: + +- Flat file (In-memory-databases, they work out-of-box) +- Text file (Slower than flat-file, but editable and readable in plain text) +- Database (fastest, readable, but requires an external Database Server) + +In case you run a multi-server setup (e.g. BungeeCord) your only option is a Database! + +#### Your First Commands! + +Once you have LuckPerms installed, you will notice that you do not have access to its primary command `/lp`. You could set it all up through your console, but for the sake of simplicity the command `lp user permission set * ` will give your player full access to every command to simplify the setup. + +Now that that's out of the way let's get started! + +Let's say we want the following architecture: + +![Ranks Example](https://smd.gg/d0bgqaa) + +This structure would allow us to use LuckPerms "promote" feature to, well, promote people. But for that to work, you have to setup "tracks" which the command should follow. Let's say for example you promote a `default` player. They should become a `VIP` and not an `Admin`! + +First we have to create all those groups. Which is simple enough. It's just `/lp creategroup `! + +LuckPerms has many features to edit in its groups and it might overwhelm you at the beginning. But really the only parts you need to know right now are `permission`, `parent`, `meta` and `setweight`. The rest are rather advanced or generally not needed. You already know how to add permissions, so go ahead, give out all the permissions you want your groups to have! In case you screw up somewhere, there always is `unset` to revoke it. +In order to setup the inheritance/promote feature, you simply have to use the `parent` subcommand like this: `/lp group admin parent add mod` or generically `/lp group parent add `. + +That's the entire magic! Your setup is now working! + +#### Prefixes and Rank Tags + +LuckPerms does include the ability to set prefixes and suffixes in its `meta` submenu. But it does not apply them on its own! For that you need other plugins. A general plugin you will need is [Vault](https://dev.bukkit.org/projects/vault). For now don't worry about what Vault on its own does, just know that it's important! + + This intro will be split into 2 parts: Chat and Nametags (Tablist or above the playerhead). + +##### Chat + +There is no end to the list of chat formatting plugins. Most of them offer support to customize your chat format, and as such your prefixes too. It really depends on the specific plugin, but most ones will have a placeholder which you can include in the chat format. + +#### Tablist and Nametag + +The entire story is a different one when we move to the Tablist part of this guide. There are only really 2 options: + + + + + diff --git a/folder/es/src/content/docs/guides/Minecraft/Plugins/terra.mdx.mdx b/folder/es/src/content/docs/guides/Minecraft/Plugins/terra.mdx.mdx new file mode 100644 index 0000000000..e20903f78d --- /dev/null +++ b/folder/es/src/content/docs/guides/Minecraft/Plugins/terra.mdx.mdx @@ -0,0 +1,85 @@ +--- +description: Configure a Terra world gen world for use in both Single and Multiplayer environments. +slug: guides/terra +title: Terra World Generation +lastUpdated: 2024-03-04 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +The setup.md wiki provides Terra worlds available for download monthly, the principle of this guide can be used in situations with / without our pre-provided files if you wish to generate things for yourself. + +Before continuing with configuring Terra we are assuming the following: + +
    +
  • You are using one of our provided world files
  • +
  • You are running atleast version 1.20.4
  • +
+ +Make sure you download one of our maps via our 'Additional Services' page. + + + +You will then need to scroll down to one of the following topic headers to complete setup. + +
    +
  • Paper & Forks
  • +
  • Fabric & Forge
  • +
+ +### Paper & Forks + +Download the latest `.jar` file from the Modrinth page using the link below and add it directly to your `/plugins/` folder inside the server directory. + + + +You will also need to append the following changes to the end of your `bukkit.yml` file **BEFORE** launching your server, this will ensure your server uses the Terra world gen plugin. + +``` +... + +worlds: + world: + generator: Terra:OVERWORLD + +... +``` + +Once this has been complete you can upload and unzip the World.XXXXXXX.zip folder into your server directory. This will automatically extract into a `world` folder and you should be ready to start your server. + +console logs + +Once the server is powered on, check for the three lines highlighted above. If these are displayed that means Terra is responsible for your world and chunk management / generation going forward. + +--- + +### Fabric & Forge + +Download the latest `.jar` file from the Modrinth page using the link below and add it directly to your `/mods/` folder inside the server directory. + + + +Add the following key to your `server.properties` file **BEFORE** launching your server, this will ensure your server uses the Terra world gen plugin. + +``` +... + +level-type=terra:overworld/overworld + +... +``` + +Once this has been complete you can upload and unzip the World.XXXXXXX.zip folder into your server directory. This will automatically extract into a `world` folder and you should be ready to start your server. diff --git a/folder/es/src/content/docs/guides/Minecraft/Self-Host/Standalone (Java)/linux.mdx.mdx b/folder/es/src/content/docs/guides/Minecraft/Self-Host/Standalone (Java)/linux.mdx.mdx new file mode 100644 index 0000000000..8e56d7ccf9 --- /dev/null +++ b/folder/es/src/content/docs/guides/Minecraft/Self-Host/Standalone (Java)/linux.mdx.mdx @@ -0,0 +1,230 @@ +--- +description: If you're just looking to setup a Minecraft server within Linux on your own personal machine then this is the tutorial for you. +slug: guides/self-host/linux +title: Linux +--- + +If you're in the position where you want to host a Minecraft server but you don't want to learn or interface with the command line too frequently then Windows will most likely be your OS of choice either on your own PC or a spare machine you have around the house. + +This guide will not cover the basics of deploying Windows, securing your OS and patch automation as we have already covered those within our [lab](https://setup.md/guides/lab) series. + +### Installing Java + +The first thing you need to do is ensure you have installed the relevant Java JDK version for your desired Minecraft version. The latest release of Minecraft (1.20.1) currently uses Java 17 so that is the version we will be installing in this tutorial. + +Ubuntu uses the `APT` package manager, it's generally considered a good idea to run the following commands before trying to install an application for the first time. + +```bash +... + +sudo apt update +sudo apt upgrade -y + +... +``` + +Once you've ensured the package list has been updated and installed packaged upgraded you can proceed with installing java depending on which Minecraft version you're looking to install you may need to change this command slightly. + +To identify which versions of JRE are installable you can run the following command. + +```bash +... + +apt search "jre-headless" + +... +``` + +This should result in the following output. + +```bash +... + +Sorting... Done +Full Text Search... Done + +default-jre-headless/stable,stable 2:1.11-72 amd64 + Standard Java or Java compatible Runtime (headless) + +openjdk-11-jre-headless/stable,stable-security,stable,stable-security 11.0.14+9-1~deb11u1 amd64 + OpenJDK Java runtime, using Hotspot JIT (headless) + +openjdk-17-jre-headless/stable,stable-security,stable,stable-security 17.0.2+8-1~deb11u1 amd64 + OpenJDK Java runtime, using Hotspot JIT (headless) + +... +``` + +:::info +Java 16 was not an LTS release and therefore isn't present in the list. + +You can now run the following command changing the `version-number` to determine if you would like to install Java 8, Java 11 or Java 17. + +::: + +```bash +... + +sudo apt install "openjdk-17-jre-headless" -y + +... +``` + +The above command will install Java 17 and will allow for us to create a server using the latest builds. You can confirm this has installed successfully by running the following command. + +```java +... + +java --version + +... +``` + +The above command should print out the latest build number for the Java 17 release we have just installed. If you have any errors you can checkout the following guide [troubleshooting java](/ts/java). + +### Creating the Minecraft server + +We are nearing the end of this guide, only a few more things to do! + +Before we download anything, we should make a directory to put our server in. You can do this by typing the following commands. + +```bash +... + +mkdir minecraft-server-folder +cd minecraft-server-folder + +... +``` + +Now we can deploy the server jar we're wanting to use, this tutorial will reference [purpur](https://purpurmc.org) but there are plenty of other server platforms and [this page](/t/server-software) explains the pros and cons of the major ones. + +```bash +... + +wget https://jar.smd.gg/download/purpur/latest/latest --content-disposition + +... +``` + +By adding the `--content-disposition` we're preventing the downloaded file being an extension-less file called `download`. + +To confirm the file has downloaded correctly you can use the `ls -al` command to display the contents of the `minecraft-server-folder`. + +```bash +... + +-rw-r--r-- 1 root root 42329978 Jul 9 08:07 purpur-1.20.1-2058.jar + +... +``` + +In order to start our server we need to create a file that accepts the EULA for Mojang. This can be done with the following command. + +```bash +... + +bash -c 'echo "eula=true" > eula.txt' + +... +``` + +We can now run the following command from the console in order to start our server, this will start the server and create all of the files it needs to run as expected. + +```bash +... + +java -Xmx4G -Xms4G -jar purpur-1.20.1-2058.jar nogui + +... +``` + +Once you see the line `Done in (seconds)` you can press `shift + c` to end the session or type `stop` like a normal server. + +So now technically everything is setup and ready - If your newly created VPS was sitting in your house you would be able to play right now... but it's not - so we need to open the 25565 port to the internet. + +#### Making it accessible over the internet (Port Forwarding) + +While we're still connected via SSH it will save time later for us to configure the servers local firewall now. + +:::info +This tutorial uses Ubuntu and UFW. If you chose another another distro at the start of this guide you will most likely have a different wrapper, if this is the case you will need to consult the docs for how best to open ports 25565 for TCP and UDP traffic. +::: + +To open TCP and UDP traffic within Ubuntu we need to use the following commands. + +```bash +... + +sudo ufw allow 22/tcp #this will allow us to continue SSH access +sudo ufw allow 25565/tcp #this will open the tcp port 25565 (minecraft game) +sudo ufw allow 25565/udp #this will open the udp port 25565 (minecraft query) +sudo ufw enable + +... +``` + +You can check UFW has successfully deployed and enabled by typing the following command. + +```bash +... + +sudo ufw status + +... +``` + +Switching back to the server, you should now be able to start the server again using the same command we used previously. + +```bash +... + +java -Xmx4G -Xms4G -jar purpur-1.20.1-2058.jar nogui + +... +``` + +You are now technically complete, you should be able to join your newly created server using the IPv4 address of the Linux box you're hosting on... There's a couple of things to note in the below 'Optional Configuration' settings which will help you down the line. + +#### Optional Configuration + +The above steps will get you up and running with the basics, but some settings can be adjusted further to make life easier for yourself as an admin. + +##### Adjusting RAM Allocation + +We go over adjusting the RAM allocation in more depth [here](/t/flags). + +##### Installing 'Screen' + +Screen is an application that allows for you to run your server in the background even after you close your SSH session. + +To install screen run the following command. + +```bash +... + +sudo apt install screen -y + +... +``` + +Now screen has been installed you can run the following commands to launch your server within screen. + +```bash +... + +screen +java -Xmx4G -Xms4G -jar purpur-1.20.1-2058.jar nogui + +... +``` + +To exit the screen session you should press `CTRL + A + D`. You should now be able to close the command prompt window without the server crashing. If you need to return to your screen windows you can use the command `screen -r`. + +##### Installing Plugins + +We go over installing plugins in more depth [here](/e/pl). + +##### JVM Flags (Aikar) + +We go over adjusting the start-up flags in more depth [here](/t/flags). diff --git a/folder/es/src/content/docs/guides/Minecraft/sftp.mdx.mdx b/folder/es/src/content/docs/guides/Minecraft/sftp.mdx.mdx new file mode 100644 index 0000000000..636a76aeff --- /dev/null +++ b/folder/es/src/content/docs/guides/Minecraft/sftp.mdx.mdx @@ -0,0 +1,84 @@ +--- +description: Learn how to upload files to Pterodactyl panels using SFTP. +slug: guides/using-sftp +title: Using SFTP +lastUpdated: 2024-08-10 +sidebar: + badge: + text: New + variant: success +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you're new to hosting a Minecraft server and you are looking to bring across a world file of your own or upload some plugins / mods to make your experience a little bit better, +this guide will focus on using SFTP in order to get around the 100MB file upload limit of the web-based file manager. + +### Requirements + +Depending on your computers operating system you will need to download one of the following SFTP tools, our tutorials will use FileZilla because this is cross platform. + +#### Windows + +The following clients are free for Windows users, there are alternatives however these are the most common and best supported solutions. + + + + + + +#### MacOS + +The Mac has a whole suite of paid SFTP products on the App Store however FileZilla is also Mac native and is the solution we recommend for this platform. + + + + + + +#### Linux (Deb) + +For simplicity we're also recommending FileZilla for Debian based distros. + + + +--- + +### Identifying your Credentials + +Once you have installed FileZilla the next step is for you to get connected to your Minecraft server. You can find the information within your provider panel, most providers are now using Pterodactyl so you need to find the following block of information below\*. + + +*Depending on your provider your panel will look different but they will all display this set of information +
+Copy the information from the `SFTP Address` and `Username` fields we will need this information within our FileZilla client. + +:::note + +Your SFTP password will be the same password you use to login to the panel, you can also configure SSH keys to use with SFTP but that is out of scope for this tutorial. +::: + +--- + +### Configuring FileZilla + +Once you have the information we're going to 'create a site' so we don't need to input this data everytime we want to file transfer, to do this select the site manager in the top left corner. + + + +Select 'New Site' and you can now fill in the section on the right hand side, you should change Protocol from FTP to SFTP else you will run into issues while connecting. + + + +Once you have copied this information over you should press 'Connect' and you will be presented with one final confirmation window, select 'Always trust this host' and then press 'Ok'. + + + +You will now be connected to your server via SFTP, you can upload/download, edit or delete files from the highlighted window below. + + diff --git a/folder/es/src/content/docs/guides/OVH/Optional/Configuration/hardening.mdx.mdx b/folder/es/src/content/docs/guides/OVH/Optional/Configuration/hardening.mdx.mdx new file mode 100644 index 0000000000..346dda5c95 --- /dev/null +++ b/folder/es/src/content/docs/guides/OVH/Optional/Configuration/hardening.mdx.mdx @@ -0,0 +1,249 @@ +--- +description: Device hardening guide and and explantion of the tools used to complete such activities. +slug: guides/lab/hardening +title: Hardening +sidebar: + badge: + text: Recommended + variant: tip +--- + +This document is designed specifcally for those who want to tighten up windows and add some preventative measures to lock down their machine, it should be made known that the more you lock down a machine the less functionality it will have. + +You should find a balance for your own environment that works best for you by either disabling or enhancing the provided policies, this page breaks down the NCSC guidelines for systems hosting '[OFFICAL](https://smd.gg/jx9p7xw)' data. + +### Windows Home + +As home based editions of Windows cannot use Group Policy below are some things you should look into securing and enabling. + +#### Permissions + +When setting up a new environment it's easy to give anything and everything full admin credentials in order to get something up and running but STOP and take the time to do things right. You should consider implementing a [principle of least privilege](https://www.f5.com/labs/articles/education/what-is-the-principle-of-least-privilege-and-why-is-it-important) from the get-go as it: + +- Enables greater control over who can manage / change a system +- Reduces the level of damage compromised accounts can cause +- Reduces the attack surface (entry points) +- Reduces risk through error / negligence / internal malicious attacks + +While Home users can't use Group Policy for file permissions it can all be easily controlled via the Windows UI, as part of the least privilege principle this will assist in ensuring data access is only performed on a 'need to know' / 'required for function', you can find a good explanation for this [here](https://youtu.be/S-tTcRC5Q2A?t=123) + +#### Patching + +Patch Tuesday, the second Tuesday of every month is the most important Tuesday in the calendar for your computer. It's the day that Microsoft delivers important updates that will address potentially dangerous exploits that can give an attacker full complete access to your machine, unless the machine will never be connected to the internet again after being deployed you should enable 'Automatically check for Windows Updates' (in Windows 10/11 you shouldn't be able to disable this via the settings UI). + +#### Applications + +Firstly, every application on your system is a potential entry point for an attacker, if you're never going to use it then uninstall it! This includes Windows features too, it's recommended that you atleast uninstall the following Windows features: + +- Internet Explorer +- SMB 1.0 + +This can be done by going to 'Control Panel' > 'Uninstall a program' > 'Turn Windows features on or off' and removing the tickbox next to the above entries. + +:::tip +A reboot will be required after completing this step +::: + +#### Windows (Defender) Security + +The following settings are configured within 'Windows Security' application and _should_ be enabled by default but regardless it's important to check. + +- Reputation based scanning is configured under the 'App and Browser control' setting +- Core Isolation is configured under the 'Device security' setting + - Memory Integrity is also a feature enabled within this section but you will need to 'View details' before you can toggle this on +- Exploit protection is configured under the 'Device security' setting along side the below nested items for this category + - Control Flow Guard + - Data Execution Protection + - Mandatory ASLR + +#### Windows OS + +There are a couple of things that are recommended if you're not actively using these features, firstly disable bluetooth if you're not using it and secondly turn off auto play as it has previously been used to exploit systems. + +- Autoplay settings can be found under 'Settings' > 'Devices' > 'Autoplay' + +--- + +### Windows Pro / Enterprise + +You can download the Group Policy template files from [here](https://github.com/ukncsc/Device-Security-Guidance-Configuration-Packs/raw/main/Microsoft/Windows/GPO/NCSC_Windows_GPO.zip). + +#### App Guard Policies + +The Windows App Guard policy will make the following changes to your PC. + +- General hardening of Defender App Guard policies. + +#### App Locker Policies + +The Windows App Locker policy will make the following changes to your PC. + +- Allows only execution of Microsoft signed applications, dlls, installers, scripts and appx + +:::tip +Development machines should be excluded from this policy otherwise they may end up not being able to run the required tools. +::: + +#### Bitlocker Policies + +The Windows bitlocker policy will make the following changes to your PC. + +- Disables standby mode when sleeping +- Encrypts the drive with XTS-AES 128 +- Disables devices such as thunderbolt that have direct memory access while a device is sleeping +- TPM bitlocker settings are configured +- Deny write access to removable media for devices configured to work with another organisation + +#### Computer Policies + +The Windows computer policy will make the following changes to your PC. + +- Prevents login with personal Microsoft accounts +- Disables user trusted root CAs +- Disables the ability for users to trust certificates +- Defines trusted root CAs for the device to use +- Prevents lock screen camera +- Requires a domain admin to change network location +- Defines proxy values +- Prevents installation of devices that match X hardware IDs +- Prevents installation of devices that use drivers matching X setup classes +- Disables Windows 'PC-Phone' link +- Disables sign-in with picture login +- Disables clipboard history +- Disables clipboard sync across devices +- Disables upload and publishing of user activities +- Disables activity feed +- Blocks universal windows apps from launching with Windows runtime API +- Removes the display password button on login forms +- Disables telemetry gathering +- Disables diagnostic data viewer +- Disables windows-to-go +- Disables cortana +- Disables search the web in windows start menu +- Disables all store applications within the MS Store +- Disables the MS Store +- Disables syncronisation of windows settings +- Ensures defender is enabled +- Disables windows error reporting +- Ensures Windows Hello is enabled for TPM 2.0 and disables lower +- Removes access to 'pause windows updates' +- Disables preview builds of windows +- Ensures a semi-annual release channel is configured using Windows update for business +- Disables Edge data collection +- Disables further telemetry +- Removes local password reset questions +- Edge pre-loading tabs disabled +- Edge extension sideloading disabled +- Blocks non-admins from enterting the device into safe-mode + +#### Device Guard + +The Windows device guard policy will make the following changes to your PC. + +- Enables virtualisation based securty +- Ensures code integrity +- Ensures credential guard is configured +- Ensures secure boot and direct memory access protection is configured + +:::tip +When enabling this policy you will need to ensure the VMs are created with Nested support otherwise Credential guard will fail to deploy. Option B would be to disable the 'Turn on Virtualisation Based Security' policy located in 'Computer Configuration' > 'Policies' > 'Administrative Templates' > 'System' > 'Device Guard' +::: + +#### Device Health + +This policy can be considered optional unless the device is enrolled into SCCM or another MDM platform. + +- Enables Device Health monitoring and reporting services + +#### Firewall Settings + +You should add further rules here if additional services are required for the network otherwise additional device / group based policies should be created using the 'Duplicate' feature and adding additional policies. + +- Enables Windows firewall +- Blocks inbound connections (unless explicitly stated) +- Allows outbound connections +- For both 'Private' and 'Personal' network settings outbound connections are blocked +- Configures outbound rules for the following services + - DHCP + - DNS + - Kerbose + - LDAP + - NCSI Probe + +#### OneDrive Settings + +This policy is entirely optional for home / lab environments where Office 365 business / dev subscriptions are not present. + +- Prevents personal OneDrive accounts syncing + +#### User Settings + +This policy is entirely optional but recommended for laptops / busy environments. + +- Ensures screen lockout time is set to 600 seconds + +#### Windows Defender + +The Windows defender policy will make the following changes to your PC. + +- Enables block on first sight +- Enrolls device to Microsoft MAPs (requirement for 'block on first sight' to work) +- Send sample file analysis +- Ensures real-time protection is enabled +- Prevents app installation from sources outside of the Microsoft Store +- Ensures smart screen is configured for Windows +- Ensures smart screen is configured for Edge +- Prevents you from being able to bypass the smartscreen prompt + +#### Installation Guide + +For Active Directory deployments you should use `Group Policy Management Editor` to import the policies. + +For single machine deployments you should consider `Powershell` to import the policies, the below command may help. + +```powershell + +... + +import-gpo -BackupId {folder-name} -TargetName {gpo} -path {c:\full\path\to\folder} -CreateIfNeeded + +... +``` + +#### Closing Thoughts + +From using these settings within our own environment you will want to make some changes, most specifically in the following areas. + +- Windows Firewall (opening RDP will prevent you needing to use proxmox viewer) +- App Guard (you will want to add any core non-ms apps you use in this policy e.g. chrome, firefox, vscode... anything that isn't published by Microsoft Corporation) + +--- + +### Ubuntu Script + +You can download the post-deployment bash script from [here](https://github.com/ukncsc/Device-Security-Guidance-Configuration-Packs/tree/main/Linux/UbuntuLTS) and manually run it on the server. + +Ubuntu, unlike Microsoft, does not require a certain edition for the script to work, at the time of writing this script worked on the latest LTS build of Ubuntu. + +#### Script break down + +- Firstly the script must be run as 'sudo' +- Secondly it will fetch the admin user +- You will then need to select the administrator account that you created during installation +- You will confirm the app repositories +- The system will complete an update, upgrade and install app armour +- Grub password is configured +- Automatic updates are configured +- Prevents standard users executing as `super user` +- Protects home directories +- Modified shell access for other users on the machine except admin account specified +- Configures pw complexity +- Enables app armour +- Enables system audting +- Disables error reporting service +- Option to disable Bluetooth +- Configures 600s lock screen timer +- Modifies lockscreen behaviour +- Optional settings for location services, privacy and usb restrictions +- Fixes folder permissions +- Sets up UFW without any rules diff --git a/folder/es/src/content/docs/guides/Services/domainpark.mdx.mdx b/folder/es/src/content/docs/guides/Services/domainpark.mdx.mdx new file mode 100644 index 0000000000..bdc6eb1ca1 --- /dev/null +++ b/folder/es/src/content/docs/guides/Services/domainpark.mdx.mdx @@ -0,0 +1,85 @@ +--- +description: Run a self hosted instance of domain-park.org for those extra domains you own but don't know what to do with. +slug: guides/domain-parking +title: Domain Parking +--- + +If you own multiple domains it may be worth looking into a service such as `domain-park` to ensure these domains remain secure while you're not using them. Thankfully domain-park is an open source project and implements the following features. + +- Best practices for SPF, DKIM, DMARC and MX compliance for parked domains +- Easy to deploy with no server configuration per domain +- Ability to configure DMARC reports + +If you do decide to run an instance (or two) of domain park you should aim for the following setup. + +- A domain you use for everything e.g. `servers.fun` +- A domain you want to park e.g. `urho.st` +- A VPS (or two) that have static (and public) IP addresses we can assign hostnames to +- A DNS management panel such as `Cloudflare DNS` + +:::danger +Cloudflare registry doesn't support using external name servers, if your domain you wish to park is registered with Cloudflare you will need to use an alternative solution. +::: + +--- + +### Creating a VPS + +If you're looking for a solid VPS provider, checkout Hetzner. You can use our affiliate link https://smd.gg/joinhetzner for €20 free credit and in return we'll also get a little bit back from Hetzner. + +If you're using Hetzner you should be able to get away with deploying x2 `CPX11 instances` with the latest LTS build of Ubuntu (Debian works too) which should set you back €9/mo. It's also recommended that you add an SSH key and avoid using password based authentication. + +--- + +### Setting up DNS (Active) + +So the first thing we will do is configure the DNS, this is because these _can_ take the longest to update in the background. + +- Login to your DNS provider and head to your DNS record section. +- Select 'Add' and create an `A Record` enter `one.ns` and point it to one of your VPS IPs + - **Optional**: If you have an IPv6 also add a `AAA Record` for the same hostname +- Repeat this but replace `one.ns` with `two.ns` + +:::tip + +If you're using Cloudflare for your "Active Domain" you should ensure the orange cloud is disabled. + +::: + +Once you have configured these addresses your DNS panel should look something like this. + +![IMG](https://uk.thot.cc/api/shares/U3NTk4N/files/7bb07f91-af5d-4741-bd3f-7cb20421e586?download=false) + +After a short while your records will have propagated and you should be able to check the A and AAA records for your hostname using a tool such as MXToolbox or the `dig` linux package. + +#### Dig Commands + +```bash +... + +dig one.ns.servers.fun A +dig one.ns.servers.fun AAA # Not configured in example + +dig two.ns.servers.fun A +dig two.ns.servers.fun AAA # Not configured in example + +... +``` + +Providing you replace `servers.fun` with your own domain you should see a response with the IP addresses you entered into your panel above. + +--- + +### Setting up DNS (Parked) + +On the domain you wish to park using your newly setup service you'll need to change your nameservers. You can do this within your domain's control panel (probably in a similar location to the DNS modification page). + +You should ensure you fill out the nameservers as per the screenshot below. Once these have been added correctly, save changes and await up-to 48 hours for this to complete. + +![IMG](https://uk.thot.cc/api/shares/Y2NjM0O/files/471bcb1d-42bf-4e52-a9b2-be56323eb3c5?download=false) + +When using these nameservers you will not be able to host **ANY** content via the domain as domain-park does not allow for it. We have configured our nameservers to redirect to this page when accessing any of our IPs / Hostnames directly. + +--- + +### Deploying Domain-Park diff --git a/folder/es/src/content/docs/guides/Services/oracle.mdx.mdx b/folder/es/src/content/docs/guides/Services/oracle.mdx.mdx new file mode 100644 index 0000000000..ad26338841 --- /dev/null +++ b/folder/es/src/content/docs/guides/Services/oracle.mdx.mdx @@ -0,0 +1,330 @@ +--- +description: A modified version of the guide produced by u/Belaboy1095969 on the Admincraft reddit using Ubuntu LTS. +title: Oracle Cloud +slug: guides/oracle-cloud +--- + +:::note + +Due to the increased popularity of the Oracle free tier, services may not be available in your desired region at the time of creating your account. You can either use another region close to your playerbase, wait until free capacity becomes available within your desired region or migrate to a paid account. + +::: + +This guide originally comes from the Admincraft subreddit user [u/Belaboy1095969](https://www.reddit.com/r/admincraft/comments/qo78be/creating_a_minecraft_server_with_oracle_cloud/), with full prior permission we have re-uploaded this tutorial into our central repository. + +If you're looking to host a basic server that is kept online (for free, 24/7) that you and your friends can play on then this is the guide for you. This guide comes with the following expectations, further expansion on some of these points can be requested within the setup.md [discord server](https://discord.gg/pXaQgzneed) if required. + +### You Will Need + +- A ~~Java Minecraft Account~~ Minecraft license, as of 07 June 2022 these games are now [bundled together](https://www.minecraft.net/en-us/article/java---bedrock-edition-pc-out-june-7). +- A credit / debit card for oracle account verification (anti-bot process) + +--- + +### Getting Started + +This guide will assume you have already gone through the sign-up process for the [OCI console](https://signup.cloud.oracle.com/?sourceType=_ref_coc-asset-opcSignIn&language=en_US). Once this step has been completed you can follow the rest of this guide. + +#### Creating a Virtual Machine instance. + +Don't Panic! This part isn't as complicated as it sounds. Once you have finished setting up your account, click the "Create a VM instance" panel. + +![img1](https://preview.redd.it/lb6qbe1fd0y71.png?width=912&format=png&auto=webp&s=eb13c09a39b8c9b4d8e8d6a7de588d96a4847afe) + +Give your VM instance a name. Anything will work, but make it easily identifiable. You can leave the default (Root) compartment selected. + +![img2](https://preview.redd.it/z0fcocxpd0y71.png?width=792&format=png&auto=webp&s=99637b502a83ff60f5189a73a77cfb5a88304e7f) + +Now, Scroll down to the "Image and Shape" section. Make sure "Ubuntu LTS 22.04 (Or just the latest build)" Is selected. Then click "Change shape". Under "Shape series", Select "Ampere". Now set the amount of Ram and CPU Cores you would like. + +:::tip +You should allocate no less than 2 CPU Cores and 8GB of ram to the VPS. After you have finished selecting the shape, make sure the "Always free eligible" Tag is showing. + +![img3](https://preview.redd.it/32bkfk8te0y71.png?width=757&format=png&auto=webp&s=d7f50ceae622064c9590c9ef41f82afdce809fed) + +::: + +Next, we need to create a VCN (Or Virtual Cloud Network). If you already have a VCN, use that. If not, select "Create a Virtual Cloud Network" Copy the settings in the picture below! + +![img4](https://preview.redd.it/xtozv7u9f0y71.png?width=766&format=png&auto=webp&s=6d1c1643aa182fc52b418854d95763bc19996c90) + +We'll need an SSH Key pair to access the server remotely. To generate a keypair, tick the box that says "Generate a new keypair" and then download both the public and private keys. Don't lose these, or else you won't be able to connect to your server remotely! + +![img5](https://preview.redd.it/rzk6yq65g0y71.png?width=791&format=png&auto=webp&s=1fcc085a62f2235d9fd179bb9bff1625ed95055b) + +Leave the boot volume settings alone and hit "Create"! + +Once you hit "Create", you will be redirected to your VM details and your VM will be in a "Provisioning" state. Wait for it to be in a running state, which should take 30-60 seconds. Under the "Instance access", you should see an IP Address. Copy it. + +#### Connecting to your VM with SSH. + +There are multiple SSH clients out there from classics such as PuTTY and newer clients such as Termius. For simplicity and universal sake we will use a command prompt / terminal window. + +Open a command prompt / terminal window and type in the following command : + +```bash +... + +ssh root@ -i "path-to-ssh-private.key" + +... +``` + +As this is your first time connecting you'll need to 'accept' either by pressing `Y` or typing `Yes` in the confirmation box. You should then see a screen similar to the below. + +![img6](https://preview.redd.it/ix7ilvzyl0y71.png?width=970&format=png&auto=webp&s=580fa11dcbce68b0dc12bb9e2ddd8e3d832830fc) + +Our VM is now deployed and ready to configure with Java and our server. + +#### Installing Java + +Ubuntu uses the `APT` package manager, it's generally considered a good idea to run the following commands before trying to install an application for the first time. + +```bash +... + +sudo apt update +sudo apt upgrade -y + +... +``` + +Once you've ensured the package list has been updated and installed packaged upgraded you can proceed with installing java depending on which Minecraft version you're looking to install you may need to change this command slightly. + +To identify which versions of JRE are installable you can run the following command. + +```bash +... + +apt search "jre-headless" + +... +``` + +This should result in the following output. + +```bash +... + +Sorting... Done +Full Text Search... Done + +default-jre-headless/stable,stable 2:1.11-72 amd64 + Standard Java or Java compatible Runtime (headless) + +openjdk-11-jre-headless/stable,stable-security,stable,stable-security 11.0.14+9-1~deb11u1 amd64 + OpenJDK Java runtime, using Hotspot JIT (headless) + +openjdk-17-jre-headless/stable,stable-security,stable,stable-security 17.0.2+8-1~deb11u1 amd64 + OpenJDK Java runtime, using Hotspot JIT (headless) + +... +``` + +:::info +Java 16 was not an LTS release and therefore isn't present in the list. + +You can now run the following command changing the `version-number` to determine if you would like to install Java 8, Java 11 or Java 17. + +::: + +```bash +... + +sudo apt install "openjdk-17-jre-headless" -y + +... +``` + +The above command will install Java 17 and will allow for us to create a server using the latest builds. You can confirm this has installed successfully by running the following command. + +```bash +... + +java --version + +... +``` + +The above command should print out the latest build number for the Java 17 release we have just installed. If you have any errors you can checkout the following guide [troubleshooting java](/ts/java). + +### Creating the Minecraft server + +We are nearing the end of this guide, only a few more things to do! + +Before we download anything, we should make a directory to put our server in. You can do this by typing the following commands. + +```bash +... + +mkdir minecraft-server-folder +cd minecraft-server-folder + +... +``` + +Now we can deploy the server jar we're wanting to use, this tutorial will reference [purpur](https://purpurmc.org) but there are plenty of other server platforms and [this page](/t/server-software) explains the pros and cons of the major ones. + +```bash +... + +wget https://jar.smd.gg/download/purpur/latest/latest --content-disposition +# You can replace 'purpur' for 'paper' if you prefer. +wget https://jar.smd.gg/download/purpur/latest/latest --content-disposition + +... +``` + +By adding the `--content-disposition` we're preventing the downloaded file being an extension-less file called `download`. + +To confirm the file has downloaded correctly you can use the `ls -al` command to display the contents of the `minecraft-server-folder`. + +```bash +... + +root@vps:~/minecraft-server-folder# ls -al +total 41348 +drwxr-xr-x 2 root root 4096 Jul 9 16:59 . +drwx------ 7 root root 4096 Jul 9 16:59 .. +-rw-r--r-- 1 root root 42329978 Jul 9 08:07 purpur-1.19-1708.jar + +... +``` + +In order to start our server we need to create a file that accepts the EULA for Mojang. This can be done with the following command. + +```bash +... + +bash -c 'echo "eula=true" > eula.txt' + +... +``` + +We can now run the following command from the console in order to start our server, this will start the server and create all of the files it needs to run as expected. + +```bash +... + +java -Xmx6G -Xms6G -jar purpur-1.19-1708.jar nogui + +... +``` + +Once you see the line `Done in (seconds)` you can press `shift + c` to end the session or type `stop` like a normal server. + +So now technically everything is setup and ready - If your newly created VPS was sitting in your house you would be able to play right now... but it's not - so we need to open the 25565 port to the internet. + +#### Making it accessible over the internet (Port Forwarding) + +While we're still connected via SSH it will save time later for us to configure the servers local firewall now. + +:::info +This tutorial uses Ubuntu and UFW. If you chose another another distro at the start of this guide you will most likely have a different wrapper, if this is the case you will need to consult the docs for how best to open ports 25565 for TCP and UDP traffic. +::: + +To open TCP and UDP traffic within Ubuntu we need to use the following commands. + +```bash +... + +sudo ufw allow 22/tcp #this will allow us to continue SSH access +sudo ufw allow 25565/tcp #this will open the tcp port 25565 (minecraft game) +sudo ufw allow 25565/udp #this will open the udp port 25565 (minecraft query) +sudo ufw enable + +... +``` + +You can check UFW has successfully deployed and enabled by typing the following command. + +```bash +... + +sudo ufw status + +... +``` + +The next steps are to do the same things within the Oracle Cloud interface. You will need to look for the category "Primary VNIC". Click the "Public Subnet" link. + +![img7](https://preview.redd.it/puhdgco6s0y71.png?width=724&format=png&auto=webp&s=62c56c8262c55129000a90726e05aa4de4039d19) + +Then click the "Default Security list" link. + +![img8](https://preview.redd.it/2poaepmcs0y71.png?width=537&format=png&auto=webp&s=3fa87f551aa084e5fb23699c670dab2a4d6c4d8a) + +And Add an "Ingress Rule". Copy the configuration shown here ,Then create another ingress rule with the same configuration, but change the "IP Protocol" to TCP, as shown below. + +![img9](https://preview.redd.it/23cjw70hs0y71.png?width=756&format=png&auto=webp&s=e33b04dab55c625d3fc68fd15c1d6adc7871c78c) + +Switching back to the server, you should now be able to start the server again using the same command we used previously. + +```bash +... + +java -Xmx6G -Xms6G -jar purpur-1.19-1708.jar nogui + +... +``` + +You are now technically complete, you should be able to join your newly created server and share the IP with your friends... There's a couple of things to note in the below 'Optional Configuration' settings which will help you down the line. + +#### Optional Configuration + +The above steps will get you up and running with the basics, but some settings can be adjusted further to make life easier for yourself as an admin. + +##### Adjusting RAM Allocation + +We go over adjusting the RAM allocation in more depth [here](/t/flags). + +##### Installing 'Screen' + +Screen is an application that allows for you to run your server in the background even after you close your SSH session. + +To install screen run the following command. + +```bash +... + +sudo apt install screen -y + +... +``` + +Now screen has been installed you can run the following commands to launch your server within screen. + +```bash +... + +screen +java -Xmx6G -Xms6G -jar purpur-1.19-1708.jar nogui + +... +``` + +To exit the screen session you should press `CTRL + A + D`. You should now be able to close the command prompt window without the server crashing. If you need to return to your screen windows you can use the command `screen -r`. + +##### Installing Plugins + +We go over installing plugins in more depth [here](/e/pl). + +##### JVM Flags (Aikar) + +We go over adjusting the start-up flags in more depth [here](/t/flags). + +--- + +### **Disclaimer** + +This guide has been modified slightly to cater for the needs of this project, setup.md has adjusted the following from the original article. + +- Moved from Oracle Linux to Ubuntu LTS +- Moved some Optional Configuration topics to either their own pages within our KB / hyperlinked to existing documents (this prevents topic duplication). +- Ordering / Combining of steps in relation to EULA and port forwarding. + +--- + +### Additional Note + +While Oracle cloud is great, ARM CPUs will fall short in high-demand workloads when it comes to Minecraft servers. If you find yourself outgrowing the Oracle instance you can check out the following [hosting guide](/h/types). diff --git a/folder/es/src/content/docs/hosting/bad-rep-providers.mdx.mdx b/folder/es/src/content/docs/hosting/bad-rep-providers.mdx.mdx new file mode 100644 index 0000000000..353bc7ff76 --- /dev/null +++ b/folder/es/src/content/docs/hosting/bad-rep-providers.mdx.mdx @@ -0,0 +1,6 @@ +--- +title: Bad Rep Hosts +description: A list of hosting providers that are considered 'summerhosts', reckless and just outright something you should avoid. +template: splash +slug: /h/bad-rep-providers +--- diff --git a/folder/es/src/content/docs/hosting/hardware.mdx.mdx b/folder/es/src/content/docs/hosting/hardware.mdx.mdx new file mode 100644 index 0000000000..5481009452 --- /dev/null +++ b/folder/es/src/content/docs/hosting/hardware.mdx.mdx @@ -0,0 +1,52 @@ +--- +description: Picking the right hardware is the most important thing when it comes to hosting as it will determine how far you can push your ideas before you have to throttle back or risk destroying the user experience. +slug: h/hardware +title: Hardware +--- + +If you haven't identified the type of hosting you wish to go for it's highly recommended to read our [types of hosting](types) document first. + +:::note +The first point we want to stress is **do not go out and buy the latest flagship CPU for a single Minecraft server**. This is a complete waste of money and you will not be able to utilise the full CPU, you should however find a hosting provider that offers the desired CPU line up and use 'shared hosting'. +::: + +### CPU + +When it comes to finding a CPU (for Minecraft) the most important factor is the [IC](https://www.bbc.co.uk/bitesize/guides/z2342hv/revision/5), this consists of a fetch, decode, read and execute cycle all taking place to complete a single cycle. + +Depending on your workload, CPU Cache & Instruction Sets should also be considered as one CPU might be better at a particular set than another (it's important to complete your own research based on your needs). + +The myth of clock speed being the sole performance factor has been disproven many times over, Apple being the most famous example that often compared a lower clock speed PowerPC to the newer Pentium 3/4 line ups from IBM and similar. + +At its core Minecraft's main logic loop is a single thread this is a fundamental issue that dictates how it runs. Consequently, Minecraft is primarily concerned with single core performance. You still need at least two cores however, the second is to offload things like Garbage Collection and non core logic threads (networking, io) to so they don't steal time from the main loop. + +--- + +### RAM + +RAM is not nearly as important as people think, fast RAM is as important ([it's benefits only go as far as your chosen CPU](https://premiumbuilds.com/features/ryzen-ram-speed-benchmark-analysis/)) as the capacity and over capacity of RAM can hurt your performance (this is because the JVM garbage collector has more to collect and therefore this intensive CPU task takes longer causing lag spikes). + +The general consensus as of late 2022 is to start with using 4GB / 6GB but use no more than 12GB per individual server. + +Memory allocation and Java Flags go hand in hand with one another and some flags (specifically Aikar's) have some values that change based on the total RAM allocation to your server. + +If you're running in Docker consider overhead for the JVM, this should be about 1/2GB that you will need to compensate for (sometimes the host will take care of this step for you). + +--- + +### Storage + +For your server's live application data it's the current consensus to at least be using some form of flash storage as the random read/write speeds can help massively when it comes to users spawning in chunks all over the map. + +For backups you are still more than welcome to use spinning disks as this data hopefully isn't used as often - it's also possible to configure archival s3 based storage (cold-site) which could end up cheaper than buying and protecting your own disks. + +--- + +### Recommended Specs + +If you're looking for specific specs we'd recommend using the below as a baseline. + +| SKU | CPU | RAM | DISK | +| ---------- | --------------------------------------------------- | ---------- | ------------------------------- | +| Budget | Intel 9th - 12th Gen / Ryzen 9 3000 - Ryzen 7 5800X | 4GB - 6GB | 30GB (NVMe) | +| Enthusiast | Intel 13th & 14th Gen / Ryzen 9 5900X & 7000 Series | 8GB - 12GB | 75GB+ (NVMe) | diff --git a/folder/es/src/content/docs/hosting/intro.mdx.mdx b/folder/es/src/content/docs/hosting/intro.mdx.mdx new file mode 100644 index 0000000000..acbee77d6a --- /dev/null +++ b/folder/es/src/content/docs/hosting/intro.mdx.mdx @@ -0,0 +1,22 @@ +--- +sidebar_position: 1 +description: The entry point for those looking to host a Minecraft server but don't know where to start. +slug: h +title: Where To Start +--- + +If you're looking to run a Minecraft server of your own there are multiple things you should consider. + +
    +
  • Where do you want to host it?
  • +
  • How do you want to host it?
  • +
  • Do you want the ability to be able to host more than Minecraft?
  • +
+ +Our goal is to cover all of this and offer our own recommendations on providers you can use for all possibilities, some key articles can be found below. + +| Topic | KB Article | Summary | +| ----------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| Service Offerings | [Types](types) | Identify what different types of hosting exist, what should be used and when. | +| Hardware | [Hardware](hardware) | The second most important decision is determining how powerful you need the hardware to be for the work you're wanting to push on it. | +| Providers | [CSPs](providers) | Non-biased recommendations for hosting providers based on previous experience and their industry position. | diff --git a/folder/es/src/content/docs/hosting/os.mdx.mdx b/folder/es/src/content/docs/hosting/os.mdx.mdx new file mode 100644 index 0000000000..f82b1b4301 --- /dev/null +++ b/folder/es/src/content/docs/hosting/os.mdx.mdx @@ -0,0 +1,30 @@ +--- +description: Let's discuss the major operating systems that you will come across when hosting a Minecraft server. +slug: h/os +title: Operating Systems +--- + +When running a Minecraft server on [bare metal](/h/types/#bare-metal--vds), or a [VPS](/h/types#virtual-private-servers) you'll need to install a base operating system before you can get started. Unless you're running an apple device your options are Windows / Windows Server or Linux and the abundance of distros that come along with it. + +This page will explain the common choices available. + +
    +
  • Windows (Desktop and Server)
  • +
  • Ubuntu LTS
  • +
+ +### Windows + +If you're looking to host a server for your friends then the easiest option for self-hosting is Windows, you're already using it and if you're going to use a cloud provider for a server they will include a monthly fee for Windows Server. At their core both OSes are 'the same' and for Minecraft running a personal server within Windows 10/11 from your home PC will be fine. + +Moving to Windows Server will give you a couple of advantages, primarily longer OS support - these tend to follow a N+10 policy when discussing depreciation which is normally a good few years more than standard desktop releases. + +Windows Server OS is lighter out of the box and includes nothing but the core files needed to get Windows functional which compared to the desktop OS could see a perf gain with less resource wastage and can slightly reduce your attack surface by ensuring there are no little to none un-patched applications installed / configured. + +--- + +### Ubuntu LTS + +Unofficially you can also throw the base 'Debian' into this argument too however with Ubuntu Pro now becoming a free feature (for up to 5 devices) it's a huge win for the home lab. Ubuntu Pro offers 10 years of LTS patches so now follows a Windows Server like support plan which will save a lot of hassle needing to move your Instance from one release to another. + +If you want to get into the more professional side of hosting, Linux is the way to go - it's further optimised and will let you get the absolute most performance out of the hardware as possible. Day-to-day you will be interfacing with this OS through a command line but unlike Windows Server if you go to a CSP you won't be charged for these, web-based game management portals do exist for those on Linux who don't want to manage everything via the CLI. diff --git a/folder/es/src/content/docs/hosting/panels.mdx.mdx b/folder/es/src/content/docs/hosting/panels.mdx.mdx new file mode 100644 index 0000000000..a818326256 --- /dev/null +++ b/folder/es/src/content/docs/hosting/panels.mdx.mdx @@ -0,0 +1,137 @@ +--- +description: You don't always want to be using the CLI to manage your server, consider a web panel and share the responsibility with your other administrators. +slug: h/ui +title: Panels +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you're running a Minecraft server the chances are you'll want an easier method of management, this is where panels come into play. Every [shared hosting](types#shared-hosting) provider will come with a control panel, this is how you'll interface with your server normally at a URL similar to https://panel.mydomain.com. Depending on how long the provider has been in business they'll either be using Multicraft or Pterodactyl (newer hosts using the latter). + +While Multicraft and Pterodactyl became the widely adopted platforms for Minecraft hosting this doesn't mean they're the only players in the game and with a VPS / Bare Metal you can install any one of a number of different solutions. We could write this article for the next six months documenting every single different panel and why it should be used but we're going to focus on a couple. + +The top 4 shortlisted panels this article will be covering are. + +
    +
  • AMP
  • +
  • Moonlight
  • +
  • Pterodactyl
  • +
  • PufferPanel
  • +
+ +### AMP Windows & Linux only + +AMP is a licensed panel produced by CubeCoders which supports both Windows and Linux including Ubuntu, Debian, Arch, Cent OS and more. CubeCrafters are by no means new to the hosting game, their previous product McMyAdmin launched all the way back in 2013. + +At this time there is **NO** Apple builds so for legacy McMyAdmin2 users this product may not be suitable for you unless you're running boot camp or run your servers on a different machine. + +#### Pros + +
    +
  • Community backed game contributions
  • +
  • Migration path for McMyAdmin2 users
  • +
  • One click/line installers
  • +
  • Proactive support
  • +
  • Support for many popular titles
  • +
+ +#### Cons + +
    +
  • Licensed
  • +
  • Multiple security requirements before installable (principle isn't a con but it's a pain)
  • +
  • Not open-source
  • +
+ + + + + + +--- + +### Moonlight Linux only + +Moonlight is an up and coming panel solution that is aimed towards those looking to replace Pterodactyl. The project is still in it's early phase and we've been pleased with the outcome so far in small scale testing and has therefore made our list as a one to watch. + +#### Pros + +
    +
  • Automatic plugin installer
  • +
  • Automatic SRV record creator
  • +
  • One click/line installers
  • +
  • Migration guide for Pterodactyl installs
  • +
  • Support for pterodactyl eggs (kind of)
  • +
  • Many more features constantly being added
  • +
+#### Cons +
    +
  • No billing support at this time
  • +
  • Lack of third party modifications
  • +
+ + + + + + +--- + +### Pterodactyl Linux only + +Multicraft had to die for Pterodactyl to breathe, an open source panel in active development and great support behind it. For those who like the sound of pterodactyl but not the self-hosting setup process you can look at the SaaS version [WISP](https://wisp.gg) which will cost you around $5 a month for the community plan. + +Pterodactyl boasts a two part setup, a web-server and a docker agent (wings) that only has official support for Linux. WSL has no official support same with Mac OS, you may find better luck utilising their 'panel-in-docker' and 'wings-in-docker' if you wish to attempt an install on either of these platforms. + +#### Pros + +
    +
  • ARM instruction set support
  • +
  • Billing integration for WHMCS / Blesta
  • +
  • Industry standard tool
  • +
  • Marketplaces for third party panel enhancements
  • +
+#### Cons +
    +
  • Complex multi-stage setup process
  • +
  • Setup support can be hit or miss (you're normally told to RTFM)
  • +
+ + + + + + + +--- + +### PufferPanel Linux only + +PufferPanel could have been the Pterodactyl industry standard tool today, a panel formerly developed by a Pterodactyl team member prior to a clashing of heads and a splitting of the product, however PufferPanel remains open source and in active development by the original founder and an long-time dev. + +The situation is the same for PufferPanel as it is for Pterodactyl, only has official support for Linux, however Windows builds are available (if unsupported). + +#### Pros + +
    +
  • One click/line installers via APT/YUM
  • +
  • ARM instruction set support
  • +
+ +#### Cons + +
    +
  • Lack of industry adoption / third party support
  • +
  • No billing modules
  • +
+ +:::note +PufferPanel (OSS Project) should not be confused with the proprietary puffer panel used by https://pufferfish.host, **these are two separate entities**. +::: + + + + + + diff --git a/folder/es/src/content/docs/hosting/providers.mdx.mdx b/folder/es/src/content/docs/hosting/providers.mdx.mdx new file mode 100644 index 0000000000..fbc621c431 --- /dev/null +++ b/folder/es/src/content/docs/hosting/providers.mdx.mdx @@ -0,0 +1,207 @@ +--- +description: This page should be used as a reference to hosting providers and is not a substitute for their trustpilot and / or other clients real world experiences. +slug: h/providers +title: Providers +--- + +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +With the game becoming as big as it has done over the last decade there have been hundreds of hosting providers of past and present that either deliver high-quality services or awful services that someone could pay you enough to use daily. The goal with this page is to highlight a few trustworthy names in the Industry that meet the following criteria. + +
    +
  • Deliver to audiences at scale
  • +
  • Developed an overall positive reputation
  • +
  • Modernises hardware when required
  • +
  • Respectable end product for the price paid
  • +
+ +It should be made clear that none of the references below are sponsored. + +:::tip +If you don't know what kind of hosting you need, it's recommended to checkout the following article here to understand the different available platforms. +::: + +### Bloom.host + +Unparalleled price to performance with dedicated resources on high-end AMD Ryzen hardware and a bespoke customised version of the Pterodactyl panel. Bloom is also now a provider in the VPS and managed server solutions space across multiple regions. + +
    +
  • Locations: Ashburn, Dallas, Los Angeles, Miami, Falkenstein, Singapore (Performance+ plans only)
  • +
+ +#### Pricing + +
    +
  • Essentials MC 4GB: $10/month
  • +
  • Performance MC 8GB: $18/month
  • +
  • Performance+ MC 8GB: $24/month
  • +
+ + + +--- + +### EnviroMC + +EnviroMC is a quality Minecraft service provider that focuses on both the budget and high-end requirements of their customers, as of Sept. 19th 2022 URHOST clients will be absorbed into EnviroMC as part of a takeover agreement. EnviroMC also provides a VPS solution across the US, Europe and Asia. + +
    +
  • Locations: Falkenstein, New York, Singapore, Warsaw (VPS Only)
  • +
+ +#### Pricing + +
    +
  • Budget: $1/GB/month
  • +
  • Premium: $2.50/GB/month
  • +
  • Dedicated: See website for pricing
  • +
+ + + +--- + +### Hetzner GMBH + +It would be impossible to create a provider list and not include Hetzner, they currently stand as the German kings when it comes to high-end hardware at an ultra affordable price point. If you're running a large enough solution and just looking for the bare metal to run it on they should be food for thought. + +
    +
  • Locations: Ashburn (VPS Only), Falkenstein, Helsinki, Nuremberg (VPS Only), Vint Hill (VPS Only)
  • +
+ +#### Pricing + +
    +
  • Cloud Starting: €3.79/month
  • +
  • Dedicated Starting: €37/month
  • +
+ + + +--- + +### OVHCloud + +OVH, much like Hetzner, is a compute only provider meaning they specialise in Cloud services and Metal (the platform we use for Labs) + +
    +
  • Locations: Beauharnois, Frankfurt, Gravelines, London, Roubaix, Singapore, Strasbourg, Sydney, Vint Hill, Warsaw
  • +
+ +#### Pricing + +
    +
  • Cloud Starting: $3.50/month
  • +
  • Dedicated Starting: $56/month
  • +
+ + + +--- + +### MCHO.ST + +MCHO.ST is a hosting provider with both a free tier and a premium product, the latter using the Ryzen 8700G CPUs offering great price to performance with a brand new panel. + +
    +
  • Location: Nuremberg
  • +
+ +#### Pricing + +
    +
  • Free Tier: Free
  • +
  • 8700G Premium: £6.25/month
  • +
+ + + +--- + +### Pebblehost + +A long standing hosting provider that has modernised with the times offering a great budget service tier as well as offering tiers with additional performance those that require it. + +
    +
  • Locations: Coventry, Gravelines, Hillsboro, Montreal, Roubaix, Sydney
  • +
+ +#### Pricing + +
    +
  • Budget: $1/GB/month
  • +
  • Premium: $2.25/GB/month
  • +
  • Extreme: $2/GB/month (Min Order 6GB / 3 Threads)
  • +
+ + + +--- + +### WitherHosting + +A budget hosting provider with a global reach and an entry price point of 1$/GB utilising a range of both Ryzen and Xeon grade processors. + +
    +
  • Locations: Chicago, Dallas, Frankfurt, London, Los Angeles, Miami, New York, Singapore, Sydney
  • +
+ +#### Pricing + +
    +
  • Budget: $1/GB/month
  • +
  • Premium: $2/GB/month
  • +
+ + + +--- + +### Other Providers + +Yes, there are other great providers that haven't made our list for one reason or another - if you do decide to venture out and search for other providers some things we'd recommend you looking out for are + +#### Avoid These Things + +
    +
  • Don't use a host that makes you pay with a 'per-player slot' model - This is awfully dated and you should focus on resource based pricing instead
  • +
  • Don't use Mojang (Microsoft) Realms - This is an Azure backed platform designed for bedrock but also has Java presence, in the long run you will not have an enjoyable experience
  • +
  • Don't use a host that appears on a 'drama site' / forum - Hosts that make these lists tend to be awfully run and you'll have a bad time with them
  • +
+ +#### Look For These Things + +
    +
  • Do your own research, check the companies TrustPilot reviews etc to get an understanding of how the customers feel
  • +
  • Look for hosts that advertise hardware components and don't make you dig through pages of docs to get the information
  • +
  • Check the providers status page for a better understanding of reliability
  • +
+We'd also recommend you ensure your chosen provider hasn't ended up on our list of 'Summerhosts' + +
+ If in doubt ASK! Measure twice and cut once. diff --git a/folder/es/src/content/docs/hosting/self.mdx.mdx b/folder/es/src/content/docs/hosting/self.mdx.mdx new file mode 100644 index 0000000000..961a9fca34 --- /dev/null +++ b/folder/es/src/content/docs/hosting/self.mdx.mdx @@ -0,0 +1,31 @@ +--- +description: So you want to host a Minecraft server yourself? Checkout your options and find the solution that suits your requirements. +slug: h/self +title: Self Hosting +--- + +When it comes to running everything yourself you have two options + +
    +
  • Rent hardware / compute in the 'cloud'
  • +
  • Provide your own hardware and run at a data centre / your house
  • +
+ +### Option 1 + +If you can afford it, this is your better option. While this is the most expensive option your monthly bill does include hardware, electricity, internet and in some cases ddos protection. A mid-range to high end service will cost you anywhere from 100$ per month in this regards so may not be suitable for those who don't already have an established community, we discuss this option a in a bit more depth [here](/h/types#bare-metal--vds). + +--- + +### Option 2 + +The cheapest option but is does require some additional thought however for one or two people this option may still make the most sense. + +
    +
  • Do you have a suitable internet connection? Firstly run a speed test, this will give you an idea of where your current connection sits. A 50mbps connection for both upload and download should be sufficient for your regular household activities **and** your Minecraft server, remember your connection is shared between all devices so downloading something on your internet e.g. steam games will reduce the available connection to Minecraft.
  • +
  • Do you have proper IPv4 addresses? Yes, Minecraft *can* support IPv6 but it requires all parties involved to also support V6 connectivity. You also need to consider if you have a [static IPv4 address](/ts/ip).
  • +
  • Have you considered the overhead to security, power utilisation, heat generated, noise produced and cost of hardware? Protecting the rest of your network can cost you either in man-hours or hardware if you need to purchase additional tools to get operational. This should all be considered before you commit to running things from home.
  • +
  • 24/7 Availability? If you're not prepared to run a server 24/7 from your home are you players happy with the fact a server will only be online for a few hours a day.
  • +
+ +If you do want to host things yourself we have documentation on how to do such things [here](/guides/self-host). diff --git a/folder/es/src/content/docs/hosting/summerhosts.mdx.mdx b/folder/es/src/content/docs/hosting/summerhosts.mdx.mdx new file mode 100644 index 0000000000..7e1d45292a --- /dev/null +++ b/folder/es/src/content/docs/hosting/summerhosts.mdx.mdx @@ -0,0 +1,70 @@ +--- +title: Summerhosts +description: Summerhost - A service provider that is poorly ran and/or operating illegally which should be avoided. +slug: h/summerhosts +--- + +The term "Summerhost" is used for service providers that are poorly ran and/or operating illegally which should be avoided, below is a list of characteristics that will end you up on our avoid list. + +:::note + +For hosting providers that meet the requirements below but are not already on the list you can [submit an issue on GitHub](https://smd.gg/summerhost-addition). Providers that no longer meet the criteria defined below can request removal using [this link](https://smd.gg/summerhost-removal) + +Disclaimer: Information was accurate at the time of publication and may not reflect any recent changes we've not been made aware of. The list of providers below should be used as a reference point. This page mostly relies on publicly available information published by listed providers (and information that is not public will be displayed on this page). +::: + +### Avoid providers that feature the following: + +
    +
  • Businesses that do not contain contact details (ex. email & phone)
  • +
  • Website with false or missing information
  • +
  • Improper billing (discord checkout etc)
  • +
  • No Terms of Service or Privacy Policy
  • +
  • No SLA ("Service Level Agreement")
  • +
  • Oversold servers
  • +
  • Deceptive sales
  • +
  • Rigged reviews (ex. review rewards)
  • +
  • Obstructive Terms of Service that disallows doing basic stuff within the server (ex. pregenning)
  • +
  • Lack of basic features such as databases and backups
  • +
  • Pirating software used on the provider (ex. "nulled" WHMCS and other software)
  • +
  • Violating other project's rights (ex. selling licensed software without authorization)
  • +
  • GSP (Game Server Providers) that sell preconfigured FiveM servers (excluding Zap Hosting)
  • +
+ +#### Sources & Useful Tools: + +
    +
  • FiveM Documentation: https://docs.fivem.net/docs/support/ban-faq/#unauthorized-game-server-provider-gsp
  • +
  • FiveM Terms of Service: https://fivem.net/terms (5.8. Authorized & Unauthorized Services)
  • +
  • WHMCS License Checker: https://www.whmcs.com/members/verifydomain.php/verifydomain.php
  • +
  • Blesta License Checker: https://account.blesta.com/client/plugin/license_verify
  • +
+ +### Here is a list of providers that you should avoid with reasoning: + +| Provider | Reason | +| -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [ThunderNodes](https://thundernodes.cloud) | Improper (discord) checkout | +| [Luxe Hosting](https://my.luxe-hosting.nl) | No publicly available Terms of Service, Privacy Policy and SLA, missing publicly available information (regarding hardware), unauthorized GSP selling FiveM servers | +| [Proxynode](https://proxynode.pro) | No publicly available SLA | +| [Vellias Hosting](https://velliashosting.online) | No publicly available SLA & Privacy Policy, unauthorized GSP selling FiveM servers | +| [Lunes Hosting](https://lunes.host) | No publicly available SLA, missing publicly available information (regarding hardware), Terms of Service is a template (termly.io) | +| [Foxomy](https://foxomy.com) | Terms of Service that requires you to `"Identify as Black, Indigenous, Latino, Hispanic, Asian, Pacific Islander, or a Person of Color."` | +| [Crystallized Hosting](https://crystallized.host) | Missing publicly available information (regarding hardware) | +| [The Minecraft Hosting](https://theminecrafthosting.com) | Missing publicly available information (regarding hardware), no publicly available Privacy Policy & SLA | +| [Evix Datacenter](https://evix-datacenter.online) | No publicly available Privacy Policy & SLA, official account threatening to DDoS people ([1](https://smd.gg/lkn5vtl), [2](https://smd.gg/54owa1o), [3](https://smd.gg/flsgxnu), [4](https://smd.gg/x0omgfm), [5](https://smd.gg/mdp5sul)), official discord account using slurs ([1](https://smd.gg/fenwcql), [2](https://smd.gg/7p9co2m)) | +| [Skytale Hosting](https://billing.skytalehosting.net) | No publicly available Terms of Service, Privacy Policy & SLA, unauthorized GSP selling FiveM servers | +| [BlackNode](https://blacknode.pro) | [Bulletproof](https://www.urbandictionary.com/define.php?term=Bulletproof%20hosting) provider that promotes themselves for spoofed & bulletproof servers and botnets & DDoS tools | +| [Boundless Hosting](https://boundlesshosting.xyz) | No publicly available Privacy Policy, unauthorized GSP selling FiveM servers | +| [SpaceNode Hosting](https://spacenodehosting.com) | No publicly available Terms of Service, Privacy Policy & SLA, missing publicly available information (regarding hardware), unauthorized GSP selling FiveM servers | +| [PSB Hosting](https://psb.hosting) | [Bulletproof](https://www.urbandictionary.com/define.php?term=Bulletproof%20hosting) provider that promotes themselves for DMCA ignorant & bulletproof servers | +| [Realms Hosting](https://realmshosting.com) | Unauthorized GSP selling FiveM servers | +| [RAPIDHost](https://rapidhosting.cloud) | Unauthorized GSP selling FiveM & RedM servers, hardware information is unspecific (different processors in the "Xeon E-series" can have noticeable performance difference) | +| [proxied.host](https://proxied.host) | No publicly available Privacy Policy & SLA | +| [Nyxiality Hosting](https://nyxialityhosting.com) | No publicly available Terms of Service, Privacy Policy & SLA, missing publicly available information (regarding hardware) | +| [EmpireNodes Hosting](https://www.empirenodes.com/) | [Rigged reviews](https://www.trustpilot.com/review/empirenodes.com), no Privacy Policy | +| [Cosmic Hosting](https://cosmichosting.xyz) | No publicly available Terms of Service, Privacy Policy & SLA, unauthorized GSP selling FiveM servers | +| [HostSpace](http://hostspace.co.il/) | Improper (discord) checkout, missing publicly available information (regarding hardware) | +| [Tegra Hosting](https://tegra.gg/) | Fallback company made by ZTX, the companies lost data several times had their nodes suspended. | +| [Springracks](https://springracks.com) | Obstructive Terms of Service that disallows `running any task that will completely cap out the CPU limit set on your service` (What if there's just high load on your Minecraft server? Who knows!) | +| [EmpireNodes](https://empirenodes.com) | No Privacy Policy, Terms of Service that disallows `"Saying we are using fake ram"`, `Beg for new nodes` | diff --git a/folder/es/src/content/docs/hosting/tls.mdx.mdx b/folder/es/src/content/docs/hosting/tls.mdx.mdx new file mode 100644 index 0000000000..5111d1254a --- /dev/null +++ b/folder/es/src/content/docs/hosting/tls.mdx.mdx @@ -0,0 +1,52 @@ +--- +sidebar_position: 2 +description: Identifiy the different tools available that can be used to help you deploy SSL certificates. +slug: h/ssl +title: TLS +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you're hosting more than just your Minecraft server, maybe you're using a Map service / forum / server store an SSL / TLS certificate is an absolute must. + +### Web Services + +If you're accessing the service via a web-browser then this part of the page will be for you, this will not cover successful deployment tutorials - we may decide to include this at a later time. + +#### Cloudflare + +This is the easiest solution to adding TLS capabilities to your website as Cloudflare can operate as a reverse proxy for the traffic allowing the SSL to terminate at their edge network and transit back to your origin server over HTTP (full SSL to origin is also supported). + + + +#### Caddy + +A self-hosted solution similar to Cloudflare but without the additional DDoS protection. Caddy supports automatic SSL deployment from any ACME provider on the market and is our provider of choice in conjunction with ZeroSSL. + + + +--- + +### Linux + +This is for tools suitable for generating certificates but perhaps might not be solely for web-servers. + +#### Certbot + +Certbot is a tool that can be deployed either as a Snap package or a Python module and is designed purely for generating valid Let's Encrypt certificates. The certificates generated from Certbot do not need to solely be used in a Web-Server and can be used system wide. + + diff --git a/folder/es/src/content/docs/hosting/types.mdx.mdx b/folder/es/src/content/docs/hosting/types.mdx.mdx new file mode 100644 index 0000000000..b5b659bff1 --- /dev/null +++ b/folder/es/src/content/docs/hosting/types.mdx.mdx @@ -0,0 +1,60 @@ +--- +description: Understand the different types of hosting services available and what may be the best fit for your project. +slug: h/types +title: Types of Hosting +--- + +When you start looking at hosting your server online you'll see many different answers of which none are wrong, but they're not always suited to your needs. This page has a goal of helping you identify when you may need each type of hosting. + +The three most common types you'll find in forum responses are: + +
    +
  • Shared Hosting
  • +
  • Virtual Private Servers (VPS)
  • +
  • Dedicated Servers (Bare Metal / VDS)
  • +
+ +### Shared Hosting + +The most common type you'll find is 'Shared Hosting', this is where a hosting provider will own a physical server and partition the resources out to clients and you will connect to / manage your server via a [web panel](/h/ui) and SFTP. If you select this style of hosting you should be careful and note that some providers will oversell the resources. Overselling allows for them to provide cheaper monthly plans but may come at a performance hit due to this over allocation. Others will provide a dedicated quota that is only allocated to yourself, this will be slightly more expensive but you will have the entire quota to your disposal whenever you need it (plus it will still be cheaper than a VPS / Bare Metal). + +Traditionally this space was dominated by the likes of Nitrado, MCProHosting, Shockbyte etc... but in recent years players like [Bloom](https://bloom.host), [DedicatedMC](https://dedicatedmc.io) & [EnviroMC](https://enviromc.host) have dominated in this space offering Ryzen based solutions instead of the old school Xeons used by the legacy giants. + +--- + +### Virtual Private Servers + +The other common response you'll see people mention is 'grab yourself a VPS from Digital Ocean or Linode'. While you certainly can, it won't be much better than using [oracle cloud](/guides/oracle-cloud) on ARM (which is free). + +VPS instances have some differences to shared hosting, the core differences are. + +
    +
  • Linux knowledge is required for setup
  • +
  • Patching becomes your responsibility
  • +
  • Shell access which allows you to run more than just Minecraft servers
  • +
  • Slower but higher core count CPUs
  • +
  • You get a Dedicated IP address rather than a Shared one
  • +
  • You can install a custom panel such as [Pterodactyl](/h/ui#pterodactyl)
  • +
+There are times when a VPS can make sense, a prime example is using a VPS provider that uses consumer 'Gaming Grade' CPUs (Intel Core i9 / AMD Ryzen 7 / 9). These would provide the same experience for Minecraft as using a regular 'shared hosting' provider and it would allow you to host say a web / database server, a discord bot or anything else you could imagine. + +--- + +### Bare Metal / VDS + +The final common type of hosting you'll see people mention is, "go all out and own your hardware". While yes, this has some advantages for a novice the prospect of having no one around for support can be unsettling. Bare metal gives you full, dedicated, system normally in 32 / 64 or 128 GB RAM configurations with 256 / 512 or multi-TB disk configs. Bare metal can either be built yourself and shipped to a data centre for a monthly fee or you can rent from providers such as Hetzner, OVH or ReliableSite for a monthly fee. This option can set you back multiple hundreds of dollars per month and would only be recommended for larger scale deployments. + +Bare metal has a few advantages over the other types of solutions such as. + +
    +
  • Complete ownership of the server data
  • +
  • Complete ownership of physical and networking resources
  • +
  • Some providers will offer a managed solution for an additional fee
  • +
+Bare metal also carries the same differences to shared hosting as a VPS. + +:::tip + +If you don't already know what level of hardware you should be looking at then please consider reading our [hardware guide](hardware) first, then once you know what hardware and solution you're looking for head on over to our [recommendation page](providers) for vendors that can deliver what you're looking for. + +::: diff --git a/folder/es/src/content/docs/index.mdx.mdx b/folder/es/src/content/docs/index.mdx.mdx new file mode 100644 index 0000000000..be7147a922 --- /dev/null +++ b/folder/es/src/content/docs/index.mdx.mdx @@ -0,0 +1,34 @@ +--- +title: Minecraft Admin Wiki +description: We're setup.md, the Minecraft administration wiki, written by enthusiasts and targeted to the novice. +template: splash +hero: + tagline: Your home of good information written by enthusiasts for the novice Minecraft server owner. + image: + file: ../../assets/houston.webp + actions: + - text: View the docs + link: /docs + icon: right-arrow + variant: primary + - text: Visit us on Github! + link: https://smd.gg/repo + icon: external +--- + +import { Card, CardGrid } from '@astrojs/starlight/components'; + + + + Behind the scenes our wiki has lost some weight as is built on the fastest framework to date! + + + Version 3 of the wiki launches with a focus on improving contribution requirements. + + + With V3 we now have the functionality to implement translations following the i18n standard. **SOON!** + + + We're still backed by the amazing members of the [Admincraft](https://smd.gg/acdiscord) community. + + diff --git a/folder/es/src/content/docs/information/discord.mdx.mdx b/folder/es/src/content/docs/information/discord.mdx.mdx new file mode 100644 index 0000000000..b9b210e8cc --- /dev/null +++ b/folder/es/src/content/docs/information/discord.mdx.mdx @@ -0,0 +1,36 @@ +--- +description: We have a Discord server, check out the basics here. +title: Discord Server +slug: discord +--- + +All project contributors are volunteers and will carry the `project contributor` role within our server. + +Those that carry the `project lead` role are the core representatives of the project and should be the ones who are consulted on any issues within. + +A permanent invite to our server can be found here. + +### Ground Rules + +As with any public server, there are some rules that need to be followed. + +
    +
  • Be kind to one another
  • +
  • Don't be an ass, no one is paid to deal with your poor behaviour
  • +
  • Don't post any NSFW content
  • +
  • Follow the Discord community guidelines
  • +
  • Follow the Discord terms of service
  • +
+ +--- + +### Server Roles + +A brief overview of important roles within our server and how they are obtained. + +| Roles | Description | +| :------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Project Lead | This is a role that is reserved for first-party members of the project. | +| Project Contributors | Anyone who has submitted work for the Github repository is eligible for this role, you should have your Github account linked to your Discord account and publicly visible. | +| Community Nerds | People who have shown significant knowledge in areas and support the community without being a wiki contributor. | +| Sponsors | This role is automatically assigned to anyone who sponsors the project. (This role is not currently obtainable) | diff --git a/folder/es/src/content/docs/information/eula.mdx.mdx b/folder/es/src/content/docs/information/eula.mdx.mdx new file mode 100644 index 0000000000..42484d52c5 --- /dev/null +++ b/folder/es/src/content/docs/information/eula.mdx.mdx @@ -0,0 +1,29 @@ +--- +description: Helping you navigate through the latest changes to Mojang's EULA. +slug: eula +title: Minecraft EULA +lastUpdated: 2023-08-02 +sidebar: + order: 4 + badge: + text: Important + variant: danger +--- + +If you're new to hosting a Minecraft server you should probably become familiar with what the EULA and CUG actually are. In short they're a scope of principles Mojang would like your server to adhere to at all times if you don't want it blacklisted at auth server level, these policies can change at any time and more often than not aren't published to Mojang's official channels e.g. Twitter. + +### Changes + +The following additional changes have been made which will affect the most amount of servers since the huge enforcements in 2014. + +
    +
  • All servers are now required to be suitable for all ages
  • +
  • All servers are now required to disclose their non-affiliation with Mojang and/or Microsoft
  • +
  • All servers are now required to implement their own ToS before a player is allowed to play
  • +
  • All players are now required to check back to the EULA on their own accord and players will not be updated of the change
  • +
  • Anything from non-commercial blogs, servers, community forums, fan sites, fan clubs, news groups, events, and gatherings are now deemed as commercial and must follow the CUG even if it will never make money
  • +
  • Mojang now has complete control over all forms of Minecraft content on online platforms
  • +
  • Mojang now has control over the term 'Minecraft' in creative content (YouTube, Twitch etc.) which may result in content removal
  • +
  • Mojang has the authority to grant or revoke permissions and consents at their discretion if they deem it appropriate or dislike what players are doing
  • +
  • Mojang has now outlawed the use of out-of-game mechanics to limit access to your Minecraft server e.g. queue based platforms in addition to gatekept content
  • +
diff --git a/folder/es/src/content/docs/information/releases.mdx.mdx b/folder/es/src/content/docs/information/releases.mdx.mdx new file mode 100644 index 0000000000..9bb709cfbc --- /dev/null +++ b/folder/es/src/content/docs/information/releases.mdx.mdx @@ -0,0 +1,26 @@ +--- +description: Every major Minecraft release, it's required Java version and noticable changes. +slug: release +title: Release Tracker +lastUpdated: 2023-12-10 +sidebar: + order: 3 +--- + +This page aims to cover the latest information for Java tracking the required Java builds and fork compatibility. + +| Major Release | Revision Version | Java Support | PaperMC Build | Purpur Build | +| ------------- | ---------------- | ---------------- | ------------- | ------------ | +| 1.21 | 0 | Java 21 | ✔ | ✔ | + +If you come back to this page at a later date in time and you cannot see a build for the newest release check one of the following links for updates: PaperMC Github or PurpurMC Github + +### Notable Changes + +
    +
  • Added new structures
  • +
  • Added new mobs
  • +
  • Added new weapon
  • +
+ +A full change log can be found here: https://www.minecraft.net/en-us/article/minecraft-java-edition-1-21 diff --git a/folder/es/src/content/docs/information/services.mdx.mdx b/folder/es/src/content/docs/information/services.mdx.mdx new file mode 100644 index 0000000000..0a50ac405d --- /dev/null +++ b/folder/es/src/content/docs/information/services.mdx.mdx @@ -0,0 +1,57 @@ +--- +description: Additional resources that are hosted by the setup.md team. +title: Additional Services +slug: services +lastUpdated: 2024-04-01 +sidebar: + order: 2 +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +As time has progressed we've continued to identify ways we can help server owners get up and running, setup.md has launched some additional services to help make your life easier. + +### Asset Hosting + +We launched a file sharing platform that can be used to share assets quickly with your communities, host resource packs for your server and even create 'link-in-bio' style pages to help bring your community together. + +#### Features + +
    +
  • 100MB file upload limit
  • +
  • Custom domain support premium
  • +
  • URL Shortener
  • +
+ + + + + + +--- + +### Server Jar API + +We took a cool idea produced by PenguiLoader on Github and we fixed some bugs then made it faster by distributing the workload to Cloudflare workers and running it on their amazing edge network. + +#### Quickstart + +The base domain is `https://jar.smd.gg` + +The subsequent URL that follows is syntaxed as below. + +`/download/{SOFTWARE}/{VERSION}/{BUILD}` + +To grab the latest paper .jar download. + +`GET https://jar.smd.gg/download/paper/latest/latest` + +To grab the latest vanilla server.jar download link. (no build parameter required) + +`GET https://jar.smd.gg/download/vanilla/latest` + + + + + diff --git a/folder/es/src/content/docs/jarapi.mdx.mdx b/folder/es/src/content/docs/jarapi.mdx.mdx new file mode 100644 index 0000000000..c82306823e --- /dev/null +++ b/folder/es/src/content/docs/jarapi.mdx.mdx @@ -0,0 +1,18 @@ +--- +title: JAR API +description: An API to easily grab popular Minecraft server software. +template: splash +slug: service/jar-api +hero: + tagline: An API to easily grab popular Minecraft server software. + image: + file: ../../assets/javaicon.png + actions: + - text: Source Code + link: https://smd.gg/api + icon: github + variant: primary +--- + +import MainStatusPill from '../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; diff --git a/folder/es/src/content/docs/mchost.mdx.mdx b/folder/es/src/content/docs/mchost.mdx.mdx new file mode 100644 index 0000000000..aa93e9225f --- /dev/null +++ b/folder/es/src/content/docs/mchost.mdx.mdx @@ -0,0 +1,21 @@ +--- +title: MCHO.ST +description: The free Minecraft hosting solution, sponsored (in-part) by the setup.md wiki. +template: splash +slug: service/mcho.st +hero: + tagline: The free Minecraft hosting solution, sponsored (in-part) by the setup.md wiki. + image: + file: ../../assets/mchost.webp + actions: + - text: Game Panel + link: https://my.mcho.st + icon: external + variant: primary + - text: Join our Discord! + link: https://mcho.st/discord + icon: discord +--- + +import MainStatusPill from '../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; diff --git a/folder/es/src/content/docs/tools/database.mdx.mdx b/folder/es/src/content/docs/tools/database.mdx.mdx new file mode 100644 index 0000000000..d3b23510f2 --- /dev/null +++ b/folder/es/src/content/docs/tools/database.mdx.mdx @@ -0,0 +1,41 @@ +--- +description: This page covers centralised plugin data storage using databases. +slug: t/database +title: Databases +--- + +Before you go and implement a database you should first understand what a database can help to achieve, this will ensure that you're not burning time unnecessarily deploying things you don't need. + +### Why use databases + +Databases are used for centralised storage with unrestricted limitations to read, write new data and modify existing data. Storing data in a database can also be efficient, decreases time for looking up data that you can export into another application / format without significant difficulty. + +--- + +### Common database types + +If you're hosting a server the most common types of databases you'll be interacting with are 'SQL' based. This will most likely be one of the following solutions: + +
    +
  • MySQL (Legacy project)
  • +
  • MariaDB (Modern MySQL fork)
  • +
  • MSSQL (The Microsoft edition of MySQL)
  • +
+From an end user perspective all database types will produce a `.sql` file when exported and can be maintained through a common interface like phpMyAdmin, Adminer or MySQL Workbench. + +:::tip + +You should also be able to move your databases between all three without any major difficulties but this may depend on implementation +::: + +--- + +### When to use a database + +In a Minecraft environment you're most likely going to come across databases in a 'Network' environment e.g. when you're using a tool such as ['Velocity'](/t/server-software#velocity), or ['Bungee'](/t/server-software#bungeecord), this will allow you to share information between your backend servers and have one consistent dataset e.g. economy balances, synced ranks and permissions etc just to name a few examples. + +If you're running a server with a hosting provider they too will most likely give you the ability to create databases for your plugin data, if you're limited on local disk space using SQL for plugin data may off-lift some local capacity constraints. + +:::note +If you're looking to deploy your own Private SQL instance, you can follow a tutorial such as the one on the [Digital Ocean community forums](https://www.digitalocean.com/community/tutorials/how-to-install-mysql-on-ubuntu-22-04) that covers installation, configuration and securing your instance. +::: diff --git a/folder/es/src/content/docs/tools/offline-mode.mdx.mdx b/folder/es/src/content/docs/tools/offline-mode.mdx.mdx new file mode 100644 index 0000000000..87deae162d --- /dev/null +++ b/folder/es/src/content/docs/tools/offline-mode.mdx.mdx @@ -0,0 +1,40 @@ +--- +slug: t/offline +description: What is offline mode and what are the implications? +title: Offline Mode +--- + +Offline mode is a legacy feature of Minecraft servers that disables the requirement for Mojang user authentication, allowing cracked Minecraft clients such as TLauncher et al. to join. +It can be set by either passing the `--singleplayer` flag to the server jar or setting `online-mode=false` in server.properties. However, there are several risks, legal and especially security, which will be covered on this page. + +### Reasons not to use offline mode + +#### Security Risks + +Due to the lack of authentication required on an offline mode server, anyone can use any username to log in - this especially comes into play when players join as certain names to either gain operator permissions or to relentlessly evade bans. + +AuthMe is a plugin for Bukkit servers that coats an insecure offline mode server with a thin veil of 'authentication', which partially mitigates these vulnerabilities at most - however, other plugins or mods still may provide operator access. +Such authentication plugins may prove an annoyance to players, an incentive to use weak passwords which then can be hacked into by malicious players - completely destroying the objective of these plugins. + +#### Software Issues + +Using offline mode on your server may also cause plugins that rely on UUID lookup to break - each 'account' has its own unique UUID, which can cause issues breaking many mods or plugins. + +When switching between modes, this becomes even more of an issue - plugins will have stored data in one format, and changing from online to offline or vice-versa will make them default to the respective format and effectively break all existing user data + +#### Legal Implications + +Offline mode (cracked) servers are commonly a breeding ground for piracy of Minecraft, which may constitute a violation of their EULA, specially their [One Major Rule](https://www.minecraft.net/eula#one-major-rule). +This may prove a problem for larger servers, as Mojang may blacklist clients from connecting to them for common EULA violations such as pay-to-win mechanics et al. + +--- + +### Valid Use Cases + +However, there are a few valid use cases in which offline mode can be used without such implications. They will be listed below: + +
    +
  • Proxies such as BungeeCord and Velocity which require backend servers to have online mode disabled - the proxy must have online mode enabled for this to count
  • +
  • Offline local-hosted environments which lack internet access, assuming everyone owns a Minecraft account otherwise
  • +
  • Local-hosted development servers for testing plugins and mods
  • +
diff --git a/folder/es/src/content/docs/tools/server-software.mdx.mdx b/folder/es/src/content/docs/tools/server-software.mdx.mdx new file mode 100644 index 0000000000..c5ca3c19db --- /dev/null +++ b/folder/es/src/content/docs/tools/server-software.mdx.mdx @@ -0,0 +1,189 @@ +--- +slug: t/server-software +description: This page covers a list of well known server.jars. +title: Server Software +lastUpdated: 2024-03-27 +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +When creating a server there are multiple different names you will come across. Each server software has its own uses. + +Server Software is very often referred to as "Server Jar(s)". + +:::note +A "Fork" is a modified version of server software. These often share the same codebase and will sometimes patch in their own changes on top of the previous projects' code. An example of "forks" is something such as "Bukkit > CraftBukkit > Spigot > Paper > Purpur". +::: + +### Backend Servers + +There are hundreds (if not thousands) of different forks. This document will only include the recommended, stable, widely-used ones. + +#### Vanilla No Plugin Support + +As the name suggests, it is a completely Vanilla server from Mojang itself without any modifications. Great for those who want to host a small server for a couple of friends without altering any mechanics, but definitely not good for large servers. + + + +#### Paper Recommended + +Paper is the most widely-used Server Jar nowadays. A fork of Spigot with its own API, numerous optimizations alongside tons of glitch/dupe fixes make Paper the main choice for most server owners. + + + +#### Purpur + +A fork of Paper which provides numerous gameplay-enhancing features without having to download/create plugins. These include being able to adjust gameplay behaviors not seen in Paper, mob health, and more. Only has a couple of optimization options, but it does allow you to toggle some dupes. + + + +#### Pufferfish + +A fork of Paper which greatly improves performance without causing any noticeable impact to gameplay. Includes hopper, entity, map rendering and many other optimizations. Highly recommended for most servers. + + + +#### Folia + +A fork of Paper which groups nearby loaded chunks to form an "independent region." Each independent region has its own tick loop, which is ticked at the regular Minecraft tickrate (20TPS). The tick loops are executed on a thread pool in parallel. There is no main thread anymore, as each region effectively has its own "main thread" that executes the entire tick loop. + +:::caution + +#### Yes, Folia is relatively usable. + +Do you need to use it? Highly unlikely. Can you use it? Probably. Will a good chunk of your plugins break? Definitely. It's currently only recommended for very large servers that are vanilla/semi-vanilla, have a beefy enough CPU and enough threads as well. If you do end up using it, make sure to test it thoroughly. If you can, consider implementing some patches from Pufferfish and other jars as well. + +**Every command and feature should be tested.** +::: + + + +#### Legacy 1.8 Jars + +It is highly recommended that you do not use 1.8 or any of its other releases. However, if it's a requirement for whatever reason these are the better jars to use. + + + + + + + + + +#### Forge + +Forge is a modding API and server jar. It is most commonly used for servers with large modpacks. However, it is not very optimized and can suffer from poor performance. + + + +#### NeoForge + +NeoForge is a fork of the Forge project with almost all of the original team [excluding LexManos](https://neoforged.net/news/theproject/), made to fix its community issues and to provide better support to modders and later versions of Minecraft. + + + +#### Fabric + +Fabric is another modding API and server jar. Fabric mods are able to change practically any mechanics of the game, is more lightweight compared to Forge, and generally performs better than vanilla thanks to the wide range of optimization mods avaliable such as Lithium, Starlight, ModernFix etc. Take a look at [this list](https://github.com/NordicGamerFE/usefulmods). + + + +--- + +### Proxies + +Proxies are used to connect multiple regular servers (such as Paper servers) together. These are what power "networks" and are used by servers which have multiple gamemodes separated in their own subservers. I.E. Survival, Minigames, Prison, etc. all in one "server". + +#### Velocity + +A more recent project, now run by the Paper developers. Velocity uses its own API, meaning it does not work with Bungeecord / Waterfall (Unless you use [SNAP!](https://forums.papermc.io/threads/snap-run-bungeecord-plugins-on-velocity.31/), which allows you to use Bungeecord plugins on Velocity. Not recommended, though.) + +Velocity is a superior solution compared to Bungeecord / Waterfall unless you're hosting older than 1.13 servers but many developers haven't added Velocity support to their plugins. + + + +#### Waterfall + +A fork of Bungeecord run by the Paper developers, Waterfall supports most if not all Bungeecord plugins. It also comes with a couple of networking optimizations. + + + +:::caution +The PaperMC team have announced that Waterfall has now reached end of life in favour of Velocity. You can read the full announcement here - https://smd.gg/waterfall-eol. We will remove this option from our wiki in the coming months. +::: + +--- + +### Geyser Standalone + +Functioning almost exactly like the Geyser plugin, Geyser Standalone allows you to take load off of your main proxy/backend instance. It also supports auto-updating on Pterodactyl (assuming that you're using the Geyser Standalone egg). Recommended for servers that have higher player counts. + +If you're using Pterodactyl, consider using the [Geyser Standalone Egg](https://github.com/GeyserMC/pterodactyl-stuff). After installation, simply set "remote" in the config.yml of Geyser Standalone to the IP of the proxy/backend server & add Floodgate-Spigot & Floodgate-Velocity/Bungeecord to the spigot and proxy instances respectively. + +Geyser Standalone also allows you to connect to servers that you do not own. However, this is not recommended as it will more than likely lead to a swift ban from the anti-cheat. + + + +--- + +### Interesting Projects + +There are sometimes cool spin-offs that we feel are worthy of mentioning their existance, please note they may no longer be in active development at the time you're viewing this article. + + + + + + +:::danger + +#### Avoid any Jar that combines Plugins & Mods + +Do not use any hybrid server software such as Magma or Mohist. These are generally unstable. [Mohist also replaces EssentialsX jars with modified jars](https://essentialsx.net/do-not-use-mohist.html), which might not be safe. + +::: diff --git a/folder/es/src/content/docs/tools/signed-chat.mdx.mdx b/folder/es/src/content/docs/tools/signed-chat.mdx.mdx new file mode 100644 index 0000000000..6374dafbd1 --- /dev/null +++ b/folder/es/src/content/docs/tools/signed-chat.mdx.mdx @@ -0,0 +1,147 @@ +--- +description: 1.19.1 overhauled the current reporting features and therefore caused a lot of panic, this page is written to cut through the misinformation and provide the facts. +title: Signed Chat +slug: t/signed-chat +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard } from '@astrojs/starlight/components'; + +First things first, it's important to set the story straight. Mojang had always had a reporting toolset for anyone who wished to use it however with the introduction of 1.19.1 changes were made to this system that a reasonable portion of the community didn't like. + +This patch specially introduces a couple of new features being: + +
    +
  • In-Game UI reporting
  • +
  • Cryptography and signing
  • +
+ +The purpose of this page serves as an advisory for those who wish to understand further what this means and what options are available to them. + +--- + +### How does it work + +This is accurate to the best of our abilities, if there is someone with a better understanding of cryptography that can help improve this page please submit a PR. + +#### Technical aspects + +These new keys are stored in .json format under the '%appdata%/.minecraft/profilekeys' folder on your PC. + +:::note +These keys are regenerated after 48 hours +::: + +The 'process' now works as follows: + +
    +
  • User opens up their Minecraft client
  • +
  • Check for keys / generation of new keys occurs if required
  • +
  • User launches Game
  • +
  • User joins their desired Minecraft server
  • +
      +
    • On join the client also makes it's public key available to the server
    • +
    +
  • User sends a message in chat
  • +
      +
    • Client signs the message using the private key providing a level of authenticity
    • +
    • Signed message is sent to the server
    • +
    • Server can validate the message came from your client using your public key
    • +
    • Server displays the chat messages
    • +
    +
+ +Every time a message is sent in chat the last 2 steps are repeated. +
+ + +#### User Reports + +When a user is reported via the new in-game screen ui the following process occurs: + +
    +
  • User selects the offending user and messages they wish to report
  • +
  • The message in question and surrounding message are also sent to Microsoft for review
  • +
+ +Once a report is sent, it is reviewed by Mojang's moderation team who will gauge an appropriate punishment for the offender(s). Any Microsoft punishment is in-line with it's current community guidelines and effect your entire account not just the single Minecraft server, these punishments can result in removal of your Multiplayer access. + +#### In-depth Review + +The best current source of data for the chat reporting is on Github created by KennyTV. A link to the document can be found [here](https://gist.github.com/kennytv/ed783dd244ca0321bbd882c347892874#file-readme-md) + +Below is a list of ways server owners and players can effectively disable the new chat reporting feature, by using one or more of these features you may limit either your own or your communities functionality. + +--- + +### Options + +#### Client Side + +Option one is disabling 'chat-signing' within your client, this will prevent you from joining any server where this setting is enforced. + +#### Server Side + +If you're running your own server there are a few options that can be used depending if you're running vanilla, modded or a plugin based server, these are as follows. + +##### Edit server.properties file Global + +You can edit the following switch to 'false' which will disable the requirement for users to use chat-signing. + +```yaml +... + +enforce-secure-profile = false + +... +``` + +##### No Chat Reports Modded Only + +No Chat Reports is a Minecraft mod created by Aizistral that works on both the client and server sides. It strips cryptographic signatures from player chat messages, effectively converting them to system messages, thus making them non-reportable. + +:::note +Joining a server with `enforce-secure-profile=true` on a client with No Chat Reports installed will display a prompt warning the user that chat will be signed if they agree to it. +::: + + + +##### FreedomChat Spigot / Paper & forks only + +FreedomChat effectively serves the same purpose as No Chat Reports would on a modded server, it converts player chat messages to system messages at the packet level, making them once again non-reportable by players. + + + +##### AntiPopup Spigot / Paper & forks only + +While this plugin works, manual setup is required - the command `/antipopup setup` must be ran in console unless `enforce-secure-profile` is set to `false` already. + + + +##### UnSignedVelocity Velocity only + +This plugin works by removing signed information from commands and messages sent by clients 1.19.1 or higher, allowing plugins that cancel proxy messages to work again. Requires VPacketEvents + + + +:::caution + +All of the above plugins could give you issues with the recent EULA changes as of Aug 2023, the above plugins are no-longer considered endorsed by setup.md. + +::: diff --git a/folder/es/src/content/docs/tools/startup.mdx.mdx b/folder/es/src/content/docs/tools/startup.mdx.mdx new file mode 100644 index 0000000000..e8b76f62f7 --- /dev/null +++ b/folder/es/src/content/docs/tools/startup.mdx.mdx @@ -0,0 +1,117 @@ +--- +description: Understand the startup file used when hosting a server. +slug: t/flags +title: Startup Scripts +--- + +### Basics + +This is how your most bare-bones startup script looks like. + +```bash +... + +java -XmxG -XmsG -jar .jar nogui + +... +``` + +`-Xmx` sets the maximum amount of memory the Java Virtual Machine is allowed to reserve. Don't set this over the amount of memory you have on your machine/given to you by the hosting provider. + +`-Xms` sets the minimum amount of memory the JVM is allowed to reserve. It should always be below or equal to the `-Xmx` value. + +The JVM only uses memory in its heap space - an area of memory that is reserved for the Java application (in our case, the server) - and the flags `-Xms` and `-Xmx` determine the possible bounds of this area. The heap size may be dynamically changed depending on how much memory the application actually needs, but it will always stay within those bounds. + +For example, `-Xmx3G -Xms1G` would set the maximum heap size to 3 gigabytes and the minimum to 1 gigabyte. You can also use the letters M and K - megabytes and kilobytes (though the latter is not usually used) to set the value more precisely, e.t `-Xmx512M`. + +Setting them both to be the same usually improves performance as no calculations need to be done regarding the heap size, but this may take away memory from other programs on your host machine (if any) in case the server does not always need to allocate the full `-Xmx`. + +You should set your RAM allocation according to your average server load - allocating more memory than your server needs is likely to cause GC lag spikes. For example, if you are a starting out server with 0-2 players most of the time, you'll be fine with 2 GB, but if you have 5-10 players online at once, you'll need 4-5 GB. + +`nogui` hides the Minecraft server GUI panel, only leaving the console visible. Remove the flag if you choose to use the panel. It has basic features like a player list, performance metrics and console output. + +`-jar .jar` points to the server .jar - see [Server Software](https://www.setup.md/t/server-software). + +--- + +### Java flags + +Java flags are used to improve server performance and client stuttering by tuning Java's Garbage Collection and adding other optimizations. + +JVM flags go **before** the `-jar` flag. + +#### Aikar flags + +Aikar's flags, while very well optimized for older Java versions, have not been updated since its creation and are severely out of date for modern Java versions. If you are running a 1.17+ Minecraft Java server (and use java 16+), it is recommended to use more up-to-date flags. + +#### Hilltty flags + +These flags are a more up to date version of Aikar's flags designed for modern versions of Java (16 and 17) which should perform better. You can check the startup scripts [here](https://github.com/hilltty/hilltty-flags/blob/main/english-lang.md). + +--- + +### Advanced JVM flags and optimizations + +The JVM can be further tweaked to optimize server and client stutters relating to Java. See [Minecraft Performance Flags](https://github.com/Mukul1127/Minecraft-Performance-Flags-Benchmarks), a up-to-date guide for Java flags, Garbage Collectors, Java runtimes (GraalVM), and other performance tips such as Large Pages and optimized Linux Distributions. + +--- + +### Minecraft server flags + +Minecraft also has quite a few startup options that directly affects the server in some way. Those go _after_ `-jar` in the startup script. +The following information is from [the wiki](https://minecraft.wiki/w/Tutorials/Setting_up_a_server#Minecraft_options). + +#### Minecraft options + +- `--bonusChest` + +If a bonus chest should be generated, when the world is first generated. + +- `--demo` + +If the server is in demo mode. (Shows the players a demo pop-up, and players cannot break or place blocks or eat if the demo time has expired) +Equivalent to playing minecraft without a account, you have about 5 in-game days before your trial ends. + +- `--eraseCache` + +Erases the lighting caches, etc. Same option as when optimizing single player worlds. + +- `--forceUpgrade` + +Forces upgrade on all the chunks, such that the data version of all chunks matches the current server version (same as with sp worlds). +This option significantly increases the time needed to start the server. + +- `--initSettings` + +Loads the settings from 'server.properties' and 'eula.txt', then quits. + +- `--jfrprofile` + +Initializes the Java Flight Recorder on the server. Only available on 1.18+. + +- `--port ` + +Which port to listen on, overrides the server.properties value. (default: -1, read from server.properties) + +See Server.properties for restrictions on this value. + +- `--safeMode` + +Loads level with vanilla datapack only. + +- `--serverId ` + +Gives an ID to the server. (??) +Seemingly no effect ?? + +- `--singleplayer` + +Runs the server in offline mode. + +- `--universe ` + +The folder in which to look for world folders. (default: .) + +- `--world ` + +The name of the world folder in which the level.dat resides. diff --git a/folder/es/src/content/docs/tools/textures.mdx.mdx b/folder/es/src/content/docs/tools/textures.mdx.mdx new file mode 100644 index 0000000000..0fbc5f6eca --- /dev/null +++ b/folder/es/src/content/docs/tools/textures.mdx.mdx @@ -0,0 +1,63 @@ +--- +description: Hosting texture packs for your server. +slug: t/textures +title: Resource Pack Hosting +--- + +If you're looking to host your texture pack for your Minecraft community you can use a third party file hosting service to deliver your pack to Minecraft clients. + +We (setup.md) have an official sharing site that can be used (for free) providing your packs are under 250MB in size. + +--- + +### Using our uploader + +Firstly, open a browser and navigate to https://smd.gg/upload. + +Sign in using one of our SSO options / create a 'traditional' account using a username and password. + + + +Select the 'Getting Started' free tier to finish setting up your account. + + + +You will now be brought to the dashboard page, on the left hand side select 'File link' + + + +By pressing the 'New Link' button in the top right hand side you will be shown a file uploader + + + +Select where your texture pack is on the system and upload the .zip file. + + + +Select 'create new file URL' and await for the upload to be completed + + + +You will then be presented with additional customisation options as well as the URL that needs to be added to your server.properties content. + + + +Go into your `server.properties` file and where it has resource-pack paste in the URL provided from the website like so. + + + +--- + +#### Compliance Reporting + +This service is operated out of the United Kingdom and is distributed globally via the Cloudflare CDN. + +--- + +### Reporting Content + +If you notice content that shouldn't be on our platform, please inform us via a Github issue and we will complete a take-down request. + +:::note + +Content reviewed by our admins and will be dealt with accordingly, we will not respond directly with a list of actions taken. As required by law any CSAM reports will be directed to local authorities and the NCMEC. diff --git a/folder/es/src/content/docs/tools/tunnels.mdx.mdx b/folder/es/src/content/docs/tools/tunnels.mdx.mdx new file mode 100644 index 0000000000..b4d12da944 --- /dev/null +++ b/folder/es/src/content/docs/tools/tunnels.mdx.mdx @@ -0,0 +1,183 @@ +--- +slug: t/tunnels +description: Using tunnels to host without port forwarding +title: Tunnels +--- + +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you want to host a Minecraft server that others can access but don't want to or cannot forward ports due to reasons such as security implications or restrictions imposed by your host or Internet service provider, look no further than using tunnels. + +Simply put, these are proxies that run on your host and connect your server to a public network without opening a port on your router/firewall. + +This page aims to look at a variety of software used to open tunnels, their pros and cons and a bottom line: + +--- + +### Ngrok + +A single-binary application that exposes local TCP ports to the internet through secure tunnelling: to set up ngrok on your server... + +
    +
  • Create an ngrok.com account
  • +
  • Download the ngrok binary for your system
  • +
  • Copy and paste your authtoken command into the terminal, typically
  • +
+```bash +... + +/path/to/ngrok config set-authtoken + +... + +```` +
    +
  • Run the ngrok agent to expose a port
  • +
+```bash +... + +/path/to/ngrok tcp 25565 # or the port you want to expose + +... +```` + +#### Pros + +
    +
  • Relatively quick to set up (single binary)
  • +
  • Open-source integrations
  • +
+ +#### Cons + +The free version of Ngrok is very limited: + +
    +
  • Server address changes every time the ngrok agent is restarted (static URLs are only available for HTTP sites)
  • +
  • Extremely limited bandwidth (1GB/month)
  • +
+ +Additionally, ngrok does not support UDP tunnelling and therefore Geyser cannot be tunnelled for Bedrock Edition players + +#### Bottom Line + +Ngrok is best suited to development servers that should be able to be accessed from anywhere, as well as smaller servers run by those who cannot forward ports on their network equipment. + + + +--- + +### Playit + +A global proxy that exposes your game server to the Internet, securely tunneled through Playit's servers. To set up Playit on your Minecraft server... (assuming you use Bukkit or a fork) + +
    +
  • Create an account on [playit.gg](https://playit.gg) and verify your email address
  • +
  • Download the Playit agent plugin from [here](https://playit.gg/download/plugins) to your server's plugins folder
  • +
  • Restart your server
  • +
  • Click on the URL that the plugin outputs to the console or chat and log in to Playit
  • +
  • Add the agent to your account and wait for the tunnel to be created
  • +
+Your tunnel should then be active! Share the address given by Playit with your players and you should be good to go! + +#### Pros + +
    +
  • Generous free plan (4 TCP and 4 UDP ports, 6 firewall rules to block IPs and ranges etc.)
  • +
  • Premium plan only $3 per month, offers good upgrades such as extra ports and firewall rules, up to 6 external domains and even 3 dedicated IPv6 addresses (provided your network uses IPv6)
  • +
  • Static domain name for servers
  • +
  • Server plugin allows integration with Playit without running the agent as a separate process
  • +
+#### Cons +
    +
  • Playit only allows for external domains to be used on its premium plan: the free plan assigns a randomly-generated subdomain in the format `name.ply.gg`
  • +
+ +#### Bottom Line + +Playit is the most common and recommended option when it comes to Minecraft server tunnelling, with a vast community on its forums and Discord server and knowledgebase for common guides and issues. + + + +--- + +### Connect + +Minekube's Connect is a plugin that links Minecraft servers to a global network in a similar practice to [Minehut](https://minehut.com) + +#### Pros + +
    +
  • Plug and play: just drop the plugin into your server's plugins directory and copy the generated address
  • +
  • Brandable with free custom domains / sub-domains
  • +
  • Passive advertising on the Connect network allows for extra player traffic
  • +
+ +#### Cons + +
    +
  • A paid plan is required to provide an ad-free experience
  • +
+ +#### Bottom Line + +Out of the options listed on this page, Connect has the easiest setup: just install the plugin and Connect will generate a domain for you! +This option is best suited for public server owners who want simple setup with organic growth from other players joining from the Connect global network. + +:::caution +Players joining your server through the Connect network will not be able to join if secure chat is enforced. To disable this: + +- On your backend server(s), make sure `enforce-secure-profile` is set to `false` in `server.properties` +- If using BungeeCord, set `enforce_secure_profile` to `false` in `config.yml` +- If using Velocity, set `force-key-authentication` to `false` in `velocity.toml` + +This can be a downside for those who want [signed chat](/t/signed-chat) to be enforced on their servers but want to advertise and grow their playerbase on the network. +::: + + + +--- + +### Cloudflared + +Cloudflared is a server-side daemon that allows the tunnelling of network traffic through Cloudflare's secure network + +Here are some resources on how to run and tunnel Minecraft servers using cloudflared: + + + + + + +#### Pros + +
    +
  • Traffic is proxied through Cloudflare's network, renowned for its terabit-capacity DDoS mitigation.
  • +
+ +#### Cons + +
    +
  • Setup is very complicated
  • +
  • Individual tunnels must be created using cloudflared for each port that you wish to be open
  • +
  • All players must have cloudflared installed and running on their computers to access the server
  • +
+ +#### Bottom Line + +This option is best for server owners and players who are willing to take on the more complicated setup and requirements, allowing for rock-solid security without the need for DDoS protected proxy + + diff --git a/folder/es/src/content/docs/troubleshooting/connectivity.mdx.mdx b/folder/es/src/content/docs/troubleshooting/connectivity.mdx.mdx new file mode 100644 index 0000000000..bb7a0c308f --- /dev/null +++ b/folder/es/src/content/docs/troubleshooting/connectivity.mdx.mdx @@ -0,0 +1,170 @@ +--- +description: A foundation for checking connectivity issues with your Minecraft server. +slug: ts/connection +title: Connectivity +lastUpdated: 2023-12-16 +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you're having trouble connecting to your Minecraft server there's a process you should follow in order to try and understand where the issue lies. If you're running on a third party hosting provider it's recommended to reach out to them directly or check their status page. + +### Server Binding to Port + +The first thing to check is that your server binds to the right port when you start it up, firstly you should see some errors in the console. This error will normally come from having two server processes running at the same time or you run an application on the same port as your Minecraft server. + +```bash +... + +**** FAILED TO BIND PORT! **** +The exception was: java.net.BindException: Address already in use +Perhaps a server is already running on that port? + +... +``` + +You can fix this by going to the `server.properties` file and look for the `server-port` variable and increase the number by 1. When you restart the server you should see the server start up without issues. + +If you don't see the above error message you can check using Powershell or Bash that your server is listening. + +#### Windows + +If you're running on windows please use the following command within a Powershell prompt. + +```powershell +... + +netstat -ano | find "{SERVER-PORT}" | find "LISTEN" + +... +``` + +#### Linux + +If you're running a linux distribution please use the following command within your active shell session. + +```bash +... + +netstat -anpe | grep "{SERVER-PORT}" |grep "LISTEN" + +... +``` + +Regardless of the operating system being used you should see one entry bound to 0.0.0.0, if you don't go back and ensure the `server-port` variable has been set properly. + +:::tip +If you're still having issues try deleting the server.properties file and then restart the server to recreate the file. One the file is deleted you can try again. +::: + +--- + +### OS Firewalls + +Now we know that the server is running on the right port you should check that the connection is allowed to break out past 'localhost' (the pc the server is running on). You can run the following command(s) depending on your OS to ensure the local firewall is configured. + +#### Windows + +If you're running on windows please use the following command within a Powershell prompt. + +```bash +... + +netsh advfirewall firewall add rule name= "Open Port 25565" dir=in action=allow protocol=TCP localport=25565 + +... +``` + +#### Linux + +If you're running a linux distribution please use the following command within your active shell session. + +```bash +... + +sudo iptables -I INPUT -p tcp -m tcp --dport 25565 -j ACCEPT + +... +``` + +To ensure things are all working locally within your network, attempt to connect from another device in your house to the internal LAN address. e.g. `192.168.1.58:25565` + +You can find your host devices internal LAN address by running `ipconfig` within command prompt or `ip addr` / `ifconfig` will work on Linux within the shell session. + +--- + +### External Port Forwarding + +Providing you can connect internally to your server, the issue most likely falls with either your router and port forwarding or your ISP and their use of CGNAT. + +The first thing we need to check is port forwarding is configured correctly. + +:::note +You will need to slightly adjust the below steps as the wording on every router model / firewall is different. +::: + +
    +
  • Login to the admin interface (normally on http(s)://192.168.1.254 or http(s)://192.168.1.1)
  • +
      +
    • Admin username and password is normally on the bottom but a Google search may also help
    • +
    +
  • Look for a 'Port Forwarding / NAT folder'
  • +
  • You may need to go into any 'Advanced Settings' tab first
  • +
  • You should ensure the rule has been configured as expected
  • +
      +
    • Service Name - 'Minecraft'
    • +
    • Protocol - 'TCP'
    • +
    • Internal IP - 'Internal LAN IP of Host Device'
    • +
    • Internal Port - 'Match server.properties file'
    • +
    • External Port - 'Match server.properties file'
    • +
    +
  • Save changes
  • +
+ +:::note +It might not be possible to reach your external IP from inside your own network so a tool like Can You See Me can check the port 25565 from an external source. +::: + +If all has been successful you should see OPEN but if you still see CLOSED it could be possible you're running behind CGNAT. + +You can find a great explanation on CGNAT below. + + + +--- + +### SRV Troubleshooting + +Since release 1.3 Minecraft supports a method of connectivity called 'SRV' Record, in principle they allow you to bind a hostname such as `play.mycoolserver.net` to an ip and a random port. The difference when using an SRV record over an A record is if you have a non standard port e.g. 25570 for your Minecraft server an A record would require you to type `play.mycoolserver.net:25570` into your client. + +In using an SRV record you bind the hostname and the service you're running (a Minecraft server) to the specific port so when you go to your client you would only have to type `play.mycoolserver.net` into your client and the SRV record would tell your client "hey use this port". + +:::note +Sometimes an end user may be using a DNS provider that doesn't support SRV records, any issues they have with connectivity can be resolved by changing their local DNS servers to a free public resolver such as one below. + +
    +
  • Quad9: 9.9.9.9
  • +
  • Cloudflare: 1.1.1.1
  • +
  • Google: 8.8.8.8
  • +
+::: + +When you create the record you should ensure it's configured as follows: + +`_minecraft._tcp. IN SRV 1 1 ` + +
    +
  • Host - this should be your current providers connection hostname
  • +
  • TTL - set this to auto if using Cloudflare DNS or 3600 in any other dns providers panel
  • +
  • Port - this should be the port you're currently using to connect to your server with
  • +
  • Subdomain - this should represent what you want your players to connect with
  • +
+ +An example of a functional SRV record has been provided below, this was created in Cloudflare's DNS manager so if Cloudflare is not your DNS solution then you may have a slightly different interface. + + diff --git a/folder/es/src/content/docs/troubleshooting/ip.mdx.mdx b/folder/es/src/content/docs/troubleshooting/ip.mdx.mdx new file mode 100644 index 0000000000..6829c4967a --- /dev/null +++ b/folder/es/src/content/docs/troubleshooting/ip.mdx.mdx @@ -0,0 +1,58 @@ +--- +description: One of the core fundamentals of networking, this page outlines the types of addresses you will come across and how you can work around them. +slug: ts/ip +title: IP Addresses +lastUpdated: 2023-12-16 +--- + +Every connected device has an IP address, similar to how every mobile phone also has a mobile number and we use this number to reference "hey, this is me... you can find me here". Similarly to phone numbers, when it comes to IP addresses we have two different types for internal (private networks) and external (public networks) usage. + +Within your house every laptop, desktop, phone etc has what we call an 'internal' IP, this will normally be represented as 192.168.0.(insert number here). If you run either `ipconfig /all`, `ip addr` or `ifconfig` command you will see your devices individual address. + +Private networks are great because we can reuse these address pools in every household without using any of our global quotas for addresses, when your local device makes a request this is sent to your device's `default gateway` address and requests information on how to proceed. + +If the request is for another local address it sends it where it needs to go and adds this address to it's "table of contents" however if you're trying to reach something outside of your network e.g. youtube.com or netflix.com your router makes a note of the original requesting device and uses it's `external address` to make that request on your behalf. + +We call this technology 'NAT', to understand why NAT exists you need to understand the challenges of IPv4 addresses. + +### Why NAT Exists + +With v4 addresses we have a limited supply of uniquely available addresses 4.3 billion to be precise. This number does sound huge until you realise that companies like Google, Microsoft, Facebook, US DoD and many, many more organisations hold tens of thousands IP addresses for business, cloud computing and just because they can which significantly shortens the pool that can be used by consumers. + +In order to combat this, NAT was introduced as a solution to provide a single entry and exit point for a network. This also allows us to bring additional connections online to the digital world which is rapidly becoming difficult to support. As the world becomes more connected and the IPv4 shortage gets worse more residential connections will move from 'Dynamic IPs to CG-NAT'. + +--- + +### Interim Technologies + +In order to stop the world falling apart, very smart individuals came up with the following solutions starting with the newest first. + +#### Dual Stack + +Dual Stack connections consist of providing both an IPv4 and IPv6 connection and helps encourage these large organisations to support the future technology (in principle, the more devices that support it the greater compatibility becomes). This is great middle-ground as it uses IPv6 first, then, if there is no IPv6 support implemented by a provider it can fall back to using a universal IPv4 address provided by your ISP (see CGNAT for more). + +Unfortunately progress towards a native IPv6 world is slow and DS will be around for a good few years to come before we can finally start to retire this dated address scheme. + +#### CG-NAT + +With CGNAT your ISP takes the concept of 'NAT' and applies it to their entire infrastructure. No longer do you have your own address provided for connecting out to the internet you instead utilise a unique private address pool to connect multiple routers to a central break out location (e.g. an internet exchange). With multiple people sharing the same public address this ultimately means no more residential port forwarding, an issue that that proves difficult for the home-hoster. + +#### Dynamic IPs + +Dynamic addresses allow your ISP to re-allocate your IP to another house waiting to get online in the event you turn off your router / lose power. It prevents idle connections claiming addresses when they're not being used so your ISP doesn't have to try and buy heavily overpriced IPs. + +For the average person this isn't the end of the world, you'll always be able to get online however if you decide to host services at home this can become a problem in the event your allocated IP changes. Anyone who connects to your service will need to be informed of the address changes and this can become a pain if you're on holiday but this can be mitigated with DDNS solutions such as [No-IP](https://noip.com). + +--- + +### The Future (IPv6) + +To every administrator's disappointment IPv6 is essential if we want to keep devices online. The address pool is significantly larger and there's enough of these IPs to allocate to every atom on the planet and we'd still have enough to repeat it 100 times over! Unfortunately with any new technology this won't become the norm overnight, IPv4 will be around for the next 30 years in one way shape or form. It is a huge learning curve for some and it will require many organisations to reconsider their current networking setups. + +The good news is adoption **IS** underway but there's still a lot of work to be done. A huge list of services that are not yet IPv6 native can be found [here](https://whynoipv6.com/), if you find a service you use on this list - give them a nudge and voice the need for change. + +### Cheat Sheets + +Avast have produces a nice summary cheat sheet which sums up everything listed above. + + diff --git a/folder/es/src/content/docs/troubleshooting/java.mdx.mdx b/folder/es/src/content/docs/troubleshooting/java.mdx.mdx new file mode 100644 index 0000000000..504825c30f --- /dev/null +++ b/folder/es/src/content/docs/troubleshooting/java.mdx.mdx @@ -0,0 +1,87 @@ +--- +description: Understand and troubleshoot some of the most common issues with Java when setting up your Minecraft server. +slug: ts/java +title: Java +--- + +Sometimes you can have issues at the first hurdle, getting your server to boot. Some of these issues are to do with your Java deployment and we will cover some quick fixes to get you up and running. + +### Missing PATH variable + +Depending on the OS you're running there are multiple ways to set the ENV / PATH location to call upon the java executable. + +#### Windows + +If you're on windows this can be done entirely via the UI however some steps maybe slightly different depending on your Windows release. Below are steps based on Windows 11. + +
    +
  • Navigate to `c:\program files\java` and identify the JDK version folder name e.g. `jdk-19`
  • +
  • Open the bin folder within the JDK folder and copy the full folder path from file explorer
  • +
  • Select the Windows icon open the start menu and go to 'Settings'
  • +
  • Select the 'System' tab on the left hand side and go to the 'About' menu
  • +
  • Open 'Advanced System Settings'
  • +
  • Select the 'Advanced' tab
  • +
  • Select 'Environment Variables'
  • +
  • Under 'System Variables' scroll down until you see 'Path'
  • +
  • Select 'Edit'
  • +
  • Now select 'New' and paste in the file explorer path you copied earlier
  • +
  • Press 'OK' to save changes
  • +
+ +You can verify the above steps have worked as expected by running the following command in a command prompt window. + +`java --version` or `javac` + +#### MacOS + +If you're running MacOS there's two different commands you could possibly run, the first (bash) is more for older devices and the latter (zsh) is for anything running Catalina or newer. + +##### Bash Command + +```bash +... + +echo export "JAVA_HOME=\$(/usr/libexec/java_home)" >> ~/.bash_profile +exec bash -l + +... +``` + +##### ZSH Command + +```bash +... + +echo export "JAVA_HOME=\$(/usr/libexec/java_home)" >> ~/.zshrc +exec zsh -l + +... +``` + +--- + +### Memory allocation + +--- + +### Wrong version of Java installed + +When it comes to the 'wrong version installed' there's a few factors to consider. + +
    +
  • Bit edition (x86 or x64 or ARM etc)
  • +
  • Major LTS revision
  • +
+ +You can identify if you're having issues due to the bit version by lowering the start-up args from a value greater than `4` for -Xms and -Xmx. If your server boots without issues to the `Done in X seconds` line you will need to uninstall your java release and download the 64 bit edition as this doesn't have the 4GB RAM memory limitation. + +If your server still doesn't boot after decreasing the RAM it's most likely that your machine has the wrong edition of Java installed, certain major releases of Java dropped legacy builds as time has gone on. + +The most commonly adopted Java releases are as follows: + +
    +
  • Java 8 (LTS)
  • +
  • Java 11 (LTS)
  • +
  • Java 17 (LTS)
  • +
  • Java 19 (LTS)
  • +
diff --git a/folder/es/src/content/docs/troubleshooting/latency.mdx.mdx b/folder/es/src/content/docs/troubleshooting/latency.mdx.mdx new file mode 100644 index 0000000000..1a882157f1 --- /dev/null +++ b/folder/es/src/content/docs/troubleshooting/latency.mdx.mdx @@ -0,0 +1,57 @@ +--- +description: Understand latency and how it can play a part in the user experience of your Minecraft server. +slug: ts/latency +title: Latency +lastUpdated: 2023-12-16 +--- + +If you've ever run a server, played on a server or you're Australian then the phrase "IT'S LAAAAAAAAAAAAAAAGING" probably sounds familiar. + + + +Unfortunately this isn't always something that's easily correctable, providing you've ensured the issue isn't related to your hardware the server runs on then you should consider the network and primarily latency. + +Latency related issues can normally be identified by one of these factors being true. + +
    +
  • Blocks don't automatically disappear after being mined
  • +
  • One bar of connectivity in the tab menu
  • +
  • You're located on the other side of the planet
  • +
+ +Technically speaking, the total duration of the request being sent from your machine, processed by the recipient and then sent back is measured in milliseconds 'ping' (latency). The longer it takes to process a request the more noticable and degraded your user experience becomes. + +:::note +If you've previously been able to join a Minecraft server without issues but you login the next day and it's unplayable then the latency should resolve with time. This is most likely due to maintenance in a datacentre somewhere on the planet that your requests utilise. + +
+Your ISP is unable to do anything about latency +::: + +### Tools to Help + +Unfortunately there is no single tool to fix your problem however if you're looking at hosting a Minecraft server for friends split across the globe we've got some advice and test locations you can use to estimate your ping. + +#### Testing Latency + +Before you purchase a server, you will want to test the location for it's ping. Vultr offer a wide range of locations that all support both IPv4 and IPv6 and respond to ICMP (ping), MTR and traceroute requests. + +We have selected 4 of their locations that represent the most common locations offered by service providers. You can use any of these locations to get an indication of what your ping would be like to any future server you buy, it could also be worth sending these links to your community memebers to ensure you find the best compromise for your entire playerbase. + +
    +
  • [https://lon-gb-ping.vultr.com](https://lon-gb-ping.vultr.com) - London, UK
  • +
  • [https://fra-de-ping.vultr.com](https://fra-de-ping.vultr.com) - Frankfurt, DE
  • +
  • [https://tor-ca-ping.vultr.com](https://tor-ca-ping.vultr.com) - Toronto, CA
  • +
  • [https://sgp-ping.vultr.com](https://sgp-ping.vultr.com) - Singapore, SG
  • +
+ +#### Ideal Ping + +Generally you can tollerate higher than normal ping within Minecraft compared to FPS titles due to the fact it's played at a slower pace. + +| Ping (MS) | Summary | +| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 0-10 | You're either hosting the server locally or the server is hosted within your city / country (providing you're an FTTP customer). | +| 11-50 | This is where most of your connections will reside, most often will also account for servers hosted in neighbouring countries / states. | +| 51-150 | This is where you _could_ start to see the occasional block break delay or quick movements might not work as expected. The avg Hypixel ping is roughly in this ball park. | +| 151 + | Most lag related complaints will occur from players in this category (mostly from Asia / Aus). If you have a large audience in this region it would be worth considering a second server here. | diff --git a/folder/fr/src/content/docs/about.mdx.mdx b/folder/fr/src/content/docs/about.mdx.mdx new file mode 100644 index 0000000000..02c898354a --- /dev/null +++ b/folder/fr/src/content/docs/about.mdx.mdx @@ -0,0 +1,65 @@ +--- +title: About Us +description: We're an administration wiki for Minecraft server administrators who are looking to enhance their server experience. +template: splash +--- + +We're building the ultimate Minecraft documentation project and if you're interested in making things even better this is the page for you. + +This page will be split up into three sections to help you get about: + +
    +
  • New Ideas
  • +
  • New Content
  • +
  • Improving Content
  • +
+ +:::caution + +If you don't already have a Github account you will be required to make one before proceeding, you can create one at https://github.com/signup. + +::: + +### Submitting Ideas + +If you're an administrator looking for docs that we don't currently have information on then this is probably the section for you, it will explain how to raise a new Github issue with the information required for us to get the ball rolling with your request. + +
    +
  • Head on over to the [setup.md Github repository](https://smd.gg/repoissue)
  • +
  • In the menu bar at the top select 'Issues'
  • +
  • Select 'New Issue'
  • +
  • Select 'Feature Request'
  • +
  • Complete the required sections on the provided form
  • +
+ +Ensure you fill out the form with as much information as you can as this will help us build better documentation + +--- + +### Writing Content + +If you're interested in writing content / migrating your own doc environment over to our wiki a Github PR is your best option. Please also ensure you have followed our [styling guide](https://contribute.setup.md) to ensure your PR doesn't get rejected for lack of continuity. + +#### Single Articles + +If you're going to write a single article you can do so with the following steps, before you consider uploading a document please ensure you are using a template from our [sister github repository](https://github.com/setupmd/templates/tree/main/Docs). + +
    +
  • Head on over to the [setup.md Github repository](https://smd.gg/pr)
  • +
  • In the menu bar at the top select 'Pull Requests'
  • +
  • Select 'New Pull Request'
  • +
  • Select the branch of your forked repo that you wish to commit as a PR
  • +
  • Select 'View Pull Request'
  • +
+ +The setup.md contributors will then verify the PR is good and will approve your content. + +#### Migrating Wikis + +If you already use docusaurus for your own project, adding your content here is super easy and should be a drag and drop migration. You'll need to [submit a PR](https://smd.gg/pr) but it's recommended you reach out to us on [Discord](https://smd.gg/discord) so we can setup some indexing for your future content. + +--- + +### Improving Content + +As Minecraft continues to grow so will our project and we hope that if you spot inconsistancies in our project you'll hit the 'Edit Page' link at the bottom to submit a PR request with any corrections you wish to make. diff --git a/folder/fr/src/content/docs/enhancements/Anti-X Tools/anticheat.mdx.mdx b/folder/fr/src/content/docs/enhancements/Anti-X Tools/anticheat.mdx.mdx new file mode 100644 index 0000000000..aebeeaef0b --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Anti-X Tools/anticheat.mdx.mdx @@ -0,0 +1,282 @@ +--- +description: A brief introduction to Anti-Cheats and the community recommended solutions. +slug: e/anti-x/ac +title: Anti-Cheats +lastUpdated: 2024-02-25 +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +:::info +Throughout this guide 'Anti-Cheat(s)' may be referred to as 'AC' or 'ACs' +::: + +ACs are an integral part of any public server and help with catching hackers, since Minecraft's built-in anti-cheat is practically useless, it's better to turn it off than to endure the constant false positives it spews out. + +You should change the following settings within the `server.properties` file. + +```yml +... + +allow-flight=true + +... +``` + +Within the `spigot.yml` file you should also set the following values. + +```yml +... + + moved-wrongly-threshold: 100000.0 + moved-too-quickly-multiplier: 100000.0 + +... +``` + +For the recommended anti-xray settings [click here](https://www.setup.md/e/anti-x/ax). + +:::warning +We highly discourage the usage of auto-bans as no anti-cheat is perfect. If you want to auto-ban, consider having something like AntiCheatReplay so that you can undo false bans. +::: + +### Common Anti-Cheats + +This list consists common ACs and some pros and cons of each AC. + +#### NoCheatPlus Spigot / Paper & forks only + +##### Pros + +
    +
  • Free and open-source
  • +
  • Good movement checks
  • +
+ +##### Cons + +
    +
  • Default configuration will spam false movement positives all over the place, you should buy a good config (eg. [MarkElf's](https://www.mc-market.org/resources/475/)) OR make your own
  • +
  • Mediocre combat checks
  • +
+ + + +--- + +#### Grim Spigot / Paper & forks only + +##### Pros + +
    +
  • Open-source
  • +
  • Great movement checks
  • +
  • Predictive technology
  • +
+ +##### Cons + +
    +
  • Currently WIP, not ready for production servers
  • +
  • Mediocre combat checks
  • +
  • Quite unoptimized
  • +
+ + + +--- + +#### Vulcan Spigot / Paper & forks only + +##### Pros + +
    +
  • Great movement and combat checks
  • +
  • Good default config
  • +
+ +##### Cons + +
    +
  • USD 20.00
  • +
  • Suboptimal performance when scaled to high player counts (>3% of ticks at 420 players)
  • +
+ + + +--- + +#### Spartan Spigot / Paper & forks only + +##### Pros + +
    +
  • 14-day money-back guarantee
  • +
  • Good Bedrock Checks
  • +
  • Decent movement checks
  • +
+ +##### Cons + +
    +
  • EUR 22.49
  • +
  • Relatively poor combat checks
  • +
  • Crashes on start up at times
  • +
  • Sub-par performance
  • +
+ + + +--- + +#### Matrix Spigot / Paper & forks only + +##### Pros + +
    +
  • Decent movement and combat checks
  • +
+ +##### Cons + +
    +
  • Bad default config, but there are some [good ones](https://github.com/QuantumSuite/MatrixChecks) out there
  • +
  • USD 20.00 (With 95% Checks) and USD 129.00 (All Checks)
  • +
  • Dedicated Server Limit
  • +
  • Terrible performance; Ate up >5% of the ticks at 135 players
  • +
+ + + +--- + +#### Themis Spigot / Paper & forks only + +##### Pros + +
    +
  • Free
  • +
  • Proper Geyser-Floodgate (Bedrock Players) checks (Only reason to use this anti-cheat)
  • +
+ +##### Cons + +
    +
  • Bad Combat & Mediocre Movement checks (Bad Elytra, Timer, KillAura Checks)
  • +
  • Lack of checks in general
  • +
+ + +
+ +:::note +This anti-cheat is optimised for bedrock players. +::: + +--- + +#### SoaromaSAC (Config 6) Spigot / Paper & forks only + +##### Pros + +
    +
  • Free
  • +
+ +##### Cons + +
    +
  • Bad Checks
  • +
  • Infinite False Positives
  • +
  • Fake Open Source Link. Leads to a Rick Roll
  • +
+ + + +--- + +#### Negativity v1 & v2 All major Java platforms + +##### Pros + +
    +
  • Free & Open Source
  • +
  • Paid Version (v2) is Open Source
  • +
  • v2 supports a lot of platforms (Minestom, Sponge, Fabric & more)
  • +
+ +##### Cons + +
    +
  • Lacks some important checks (No Elytra Checks, NoSlow Checks etc)
  • +
  • Poor movement and combat checks
  • +
+ + + +--- + +#### Polar + +##### Pros + +
    +
  • Great movement and combat checks
  • +
  • Works out-of-the-box on most servers
  • +
  • Cloud-based detections, which helps reducing stress on server resources
  • +
+ +##### Cons + +
    +
  • Subscription plans starting at EUR 15/month
  • +
  • Limitations on player count, server instances and dedicated servers based on subscription plan
  • +
+ + + +### Recommendations + +Both Astro and Vulcan offer a great price to performance ratio. However, Astro will be significantly lighter on system resources. +Also, Vulcan will support Bedrock in the near future. Astro already supports it. + +:::tip +Remember, no anti-cheat is perfect. Players will be able to bypass anti-cheats, so we recommend having a moderator or two online to keep an eye out for any cheaters. +::: diff --git a/folder/fr/src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx.mdx b/folder/fr/src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx.mdx new file mode 100644 index 0000000000..1ee39234bd --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx.mdx @@ -0,0 +1,47 @@ +--- +description: A brief introduction to Anti-Exploits and the community recommended solutions. +slug: e/anti-x/ae +title: Anti-Exploit +lastUpdated: 2024-02-25 +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +Anti-Exploit plugins resolve issues such as crashes, dupes, abusive NBT etc. + +:::info +Some of these plugins might only be useful if you are not using the latest version of Paper. +::: + +#### Panilla + +Panilla prevents abusive NBT and packets. Average or lenient modes recommended. Recently was found to be messing with items contained within shulkers, so test the plugin before you install it on production. + + + + + + +--- + +#### LPX + +Avoids NettyCrashers, slightly prevents Anti-Anti-Xrays, logs packets and limits them. + + + +--- + +#### BookExploitFix + +Improve the security of your Minecraft server by filtering illegal content from player created books. Although personally I would completely disable books because I don't trust them at all, you may use this plugin instead. + + + + + diff --git a/folder/fr/src/content/docs/enhancements/Anti-X Tools/antilag.mdx.mdx b/folder/fr/src/content/docs/enhancements/Anti-X Tools/antilag.mdx.mdx new file mode 100644 index 0000000000..511bac4815 --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Anti-X Tools/antilag.mdx.mdx @@ -0,0 +1,85 @@ +--- +description: A brief introduction to Anti-Lag and alternative performance management tools. +slug: e/anti-x/al +title: Anti-Lag +lastUpdated: 2024-02-25 +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +Below is a list of tools and optimisations you can use to identify and mitigate TPS (server) lag. + +:::caution +**Anti-lag plugins such as ClearLagg "don't work".** + +These plugins periodically clear dropped items at a set interval - this makes a negligible difference to lag and most anti-lag plugins have poor detection that can result in more lag. Aside from the fact any "gains" seen by such tools are just hiding performance issues under a thin veil rather than actually fixing them. +::: + +#### Guides to Optimisation + +We have published a couple of proven guides on optimisations below that should be reviewed first. + + + +--- + +#### Spark + +A modern performance profiler for 1.8+ servers on any platform - Forge, Spigot, Fabric, almost anything that isn't the vanilla server! This isn't an anti-lag plugin per se but it can help you find what's _causing_ lag on your server. + +It now comes built-in with the Purpur performance JAR and its forks. + + + + + + + +--- + +#### FarmControl + +This plugin allows you to manage certain properties of farms on your server. Among other things, the plugin acts as a farm limiter, can remove the ability of mobs in farms to collide and perform random movements, or can completely disable the AI of mobs in farms. These actions can be performed either passively or in response to the server's performance degrading. + + + + + + +--- + +#### EntityDetection + +This plugin lets you quickly find chunks with large quantities of mobs/animals & tile entities. Not an anti-lag plugin, but can be incredibly useful + + + + + + +--- + +#### CAProtect-Lite + +Prevents players from lagging the server with minecarts and boats. If you have FarmLimiter, consider configuring that plugin to do what CAProtect does instead, as CAProtect is a bit more intensive. Otherwise, consider using AjMac's fork. + + + + + + +--- + +#### RedstoneLimiter + +RedstoneLimiter is a plugin that limits how many times individual redstone contraptions can be activated in a customizable amount of time to fix lag machines. + + + + + diff --git a/folder/fr/src/content/docs/enhancements/Anti-X Tools/antixray.mdx.mdx b/folder/fr/src/content/docs/enhancements/Anti-X Tools/antixray.mdx.mdx new file mode 100644 index 0000000000..d18466f8b8 --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Anti-X Tools/antixray.mdx.mdx @@ -0,0 +1,50 @@ +--- +description: A brief introduction to Anti-Xray and the community recommended solutions. +slug: e/anti-x/ax +title: Anti-Xray +lastUpdated: 2024-02-25 +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +As the name suggests, Anti-Xray will prevent players from finding ores using Xray clients/resource packs. This is done by sending packets to the player where all of the ores are replaced by stone. The ores only appear if the player establishes direct visual contact with them/updates them. Two of the most common Anti-Xray plugins are shown below: + +#### PaperMC + +PaperMC (A fork of Spigot) comes with a built-in Anti-Xray. This Anti-Xray usually does the trick just fine. It is simple to setup and causes no lag for both the server and the client (unless you hide caves (air), which will be much laggier for the client). A great guide is shown [here](https://docs.papermc.io/paper/anti-xray). Again, make sure that you do NOT add `air` to `hidden-blocks`. + + + +--- + +#### Orebfuscator + +If you're stuck using Spigot for whatever reason, you should probably use Orebfuscator. It may also work well in junction with Paper's Anti-Xray, as it can also +hide containers better. + + +
+:::note +Orebfuscator does have a tendency to turn chests into dirt when server is laggy, this is a visual thing and doesn't delete the contents of said chests +::: + +--- + +### RayTraceAntiXray + +Paper plugin for server-side async multithreaded ray tracing to hide ores that are exposed to air using Paper Anti-Xray engine-mode 1. Might be worth using instead of engine-mode 2 as that can cause lag on slow devices. Only recommended if you have extra threads and don't mind using ProtocolLib. + + diff --git a/folder/fr/src/content/docs/enhancements/Anti-X Tools/intro.mdx.mdx b/folder/fr/src/content/docs/enhancements/Anti-X Tools/intro.mdx.mdx new file mode 100644 index 0000000000..5237647b53 --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Anti-X Tools/intro.mdx.mdx @@ -0,0 +1,22 @@ +--- +sidebar_position: 1 +slug: e/anti-x +description: Understand the types of 'preventative' tools that exist for Minecraft servers. +title: Introduction +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +Minecraft is an open game by nature and as great as that is, it doesn't always work in every servers favour and sometimes they need to make changes in order to restrict certain aspects of gameplay for any number of multiple reasons. + +The most common types of plugins you'll see in this category are: + + + + + + + + +We will attempt to cover multiple examples of each where possible. diff --git a/folder/fr/src/content/docs/enhancements/Economy/chest.mdx.mdx b/folder/fr/src/content/docs/enhancements/Economy/chest.mdx.mdx new file mode 100644 index 0000000000..59dccbe225 --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Economy/chest.mdx.mdx @@ -0,0 +1,17 @@ +--- +description: A focus on traditional chest based plugins for your servers economy. +slug: e/eco/chest +title: Chest Based +--- + +A chest shop is a Minecraft resource buying - selling enhancement that is fully craftable in game using normally a standard chest and a wooden sign. These solutions normally bring a more player-to-player style interraction with players chosing to rent space in an admin market / build their own market. + +### Examples + +We have collated a small list of plugins you can use to get you started with on your Minecraft server below. + +
    +
  • [QuickShop](/e/pl/quickshop)
  • +
  • [ChestShop](/e/pl/chestshop)
  • +
  • [DukesMart](/e/pl/dukesmart)
  • +
diff --git a/folder/fr/src/content/docs/enhancements/Economy/gui.mdx.mdx b/folder/fr/src/content/docs/enhancements/Economy/gui.mdx.mdx new file mode 100644 index 0000000000..7844735528 --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Economy/gui.mdx.mdx @@ -0,0 +1,19 @@ +--- +description: A focus on GUI based plugins for your servers economy. +slug: e/eco/gui +title: GUI Based +lastUpdated: 2024-01-01 +--- + +A GUI based shop plugin allows users to buy and sell using an interface, normally that of chests and can sometimes be more accessible for your players. + +### Examples + +We have collated a small list of plugins you can use to get you started with on your Minecraft server below. + +
    +
  • [AuctionHouse](/e/pl/auctionhouse)
  • +
  • [PlayerAuctions](/e/pl/playerauctions)
  • +
  • [PlayerShops (BPS)](/e/pl/playershops)
  • +
  • [zAuctionHouse](/e/pl/zauctionhouse)
  • +
diff --git a/folder/fr/src/content/docs/enhancements/Economy/intro.mdx.mdx b/folder/fr/src/content/docs/enhancements/Economy/intro.mdx.mdx new file mode 100644 index 0000000000..0319535ab4 --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Economy/intro.mdx.mdx @@ -0,0 +1,26 @@ +--- +description: Recommended plugins to kick start your Minecraft server's economy. +slug: e/eco +title: What is an economy? +sidebar: + order: 1 +--- + +An economy is essential to your Minecraft server, it allows for players to buy and sell between one another or between your players and the server for in-game ranks / items etc. + +Economies within Minecraft, much like the real world, can dictate supply and demand with availabilities of resources to your players. For example if you were running admin shops it would be possible to run a discount on certain items and random points within the year or if you want to make a product more valuable then this can be achieved too. + +The goal with this section is to highlight some viable options for your server along with some example plugins that will allow you to build the framework for your own server's economy to take place. + +### Requirements + +Most, if not all plugins require your server to have an Economy API (such as [Vault](/e/pl/vault)) and an Economy Handler installed. + +Some example economy handlers are below: + +
    +
  • [EssentialsX](/e/pl/essentialsx)
  • +
  • [TheNewEconomy](/e/pl/theneweconomy) (Optional Vault Support)
  • +
  • [iConomy](/e/pl/iconomy)
  • +
  • [Gringott's Economy](/e/pl/gringottseco)
  • +
diff --git a/folder/fr/src/content/docs/enhancements/Economy/shop.mdx.mdx b/folder/fr/src/content/docs/enhancements/Economy/shop.mdx.mdx new file mode 100644 index 0000000000..9fd5bcd954 --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Economy/shop.mdx.mdx @@ -0,0 +1,44 @@ +--- +description: A focus on /shop based plugins for your servers economy. +slug: e/eco/shop +title: Command Based +--- + +### /shop Plugins + +/shop Plugins are server-sided shops, meaning that all items are bought and sold from and to the the server instead of a player. + +#### ShopGUI+ + +ShopGUI+ is probably the most well known /shop plugin out there. Kitted out with basically every feature you might need (other than a dynamically evolving economy), it is a pretty solid choice for most servers. +Too bad that it's 18 USD and performs poorly when scaled to higher player counts. Only worth buying if you want support for other plugins. + +
+Spigot +
+ +#### BossShopPro + +Solid /shop plugin with a lot of good features. I highly recommend that you find a fork to download instead of using the old SpigotMC version. + +
+Spigot +
+ +#### EconomyShopGUI + +Free, simple /shop plugin that just does the job. It also has a premium version for 12 USD. Free version is extremely limiting. + +
+Spigot +
+ +#### DeluxeMenus + +Now hear me out.. I know that DeluxeMenus isn't exactly a server-shop plugin, but it is nearly perfect for the job since it is EXTREMELY flexible. cj89898 has made a wonderful DeluxeMenus shop [here](https://github.com/cj89898/DeluxeMenus-DeluxeShop). + +You may also use a setup.md provided version [here](https://github.com/setupmd/templates/raw/main/Plugin%20Configurations/deluxemenusshop.zip). + +
+Spigot +
diff --git a/folder/fr/src/content/docs/enhancements/Permissions/breakdown.mdx.mdx b/folder/fr/src/content/docs/enhancements/Permissions/breakdown.mdx.mdx new file mode 100644 index 0000000000..467527519f --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Permissions/breakdown.mdx.mdx @@ -0,0 +1,28 @@ +--- +sidebar_position: 1 +slug: e/perms +title: How They Work +lastUpdated: 2024-01-01 +sidebar: + order: 4 + badge: + text: Important + variant: danger +--- + +When you're setting up a new server, a very important part of the process is managing permissions and **configuring them as you go**. + +Permissions are little pieces of text that indicate an action. When you grant a certain group of players this permission, the plugin will know that they are allowed to perform this action. They are usually laid out like `pluginname.permission`. + +An example is the `essentials.afk` permission. If you give this permission to a player, they will be able to perform the `/afk` command. + +:::note +You can use the wildcard (`*`) operator to indicate everything when supplying a permission. +Ex: `essentials.*` will give you every permission that starts with `essentials.`. +::: + +:::danger +It is a very bad idea to give someone (even yourself!) either the `*` or `*.*` permission(s). +::: + +So how does one grant permissions to their players? For this exact purpose people have created permission plugins. They allow you to create groups, usually associated with the term Rank. You can then give certain permissions to these groups, and assign players to these groups. diff --git a/folder/fr/src/content/docs/enhancements/Permissions/plugins.mdx.mdx b/folder/fr/src/content/docs/enhancements/Permissions/plugins.mdx.mdx new file mode 100644 index 0000000000..a8e5b6111d --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Permissions/plugins.mdx.mdx @@ -0,0 +1,17 @@ +--- +description: A focus on permission manager plugins for your server. +slug: e/perms/plugins +title: Plugins +lastUpdated: 2024-01-01 +--- + +Permission manager plugins allow you to define groups (ranks), and permission levels for all of your players on your server. + +### Examples + +We have collated a small list of plugins you can use to get you started with on your Minecraft server below. + +
    +
  • [LuckPerms](/e/pl/luckperms)
  • +
  • [PowerRanks](/e/pl/powerranks)
  • +
diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/AntiCrasher.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/AntiCrasher.mdx.mdx new file mode 100644 index 0000000000..83e03f9edb --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/AntiCrasher.mdx.mdx @@ -0,0 +1,12 @@ +--- +description: AntiCrasher fixes a crash exploit that affects every version, only fixed in very recent builds of paper/pufferfish/purpur for 1.20.2 and a backport for pufferfish 1.20.1 +slug: e/pl/anticrasher +title: AntiCrasher +--- + +Fixes a very popular and very used crash exploit that affects most versions of Minecraft + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/MiniMOTD.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/MiniMOTD.mdx.mdx new file mode 100644 index 0000000000..01da7628be --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/MiniMOTD.mdx.mdx @@ -0,0 +1,33 @@ +--- +description: MiniMOTD has the functionality to add an MOTD (Message Of The Day) to your server, which shows on the Multiplayer page of Minecraft before a player logs into your server. +slug: e/pl/minimotd +title: MiniMOTD +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Bungeecord, Waterfall & Velocity Spigot / Paper & forks only +
+MiniMOTD is a plugin of which allows you to **fully** customize your server's MOTD by: + +
    +
  • Adding multiple MOTD messages that can alternate between one another
  • +
  • Adding RGB gradients
  • +
  • Adding Placeholders
  • +
  • and much more...
  • +
+ +#### Note + +Whilst MiniMOTD can run on your backend server, if you are running a network via a proxy such as Bungeecord or Velocity, MiniMOTD will be ran on your proxy. Therefore, you should download MiniMOTD to your proxy rather than your individual servers. If you are just running one singular server, MiniMOTD will run directly on that server. + + + + + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/auctionhouse.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/auctionhouse.mdx.mdx new file mode 100644 index 0000000000..93b2115d67 --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/auctionhouse.mdx.mdx @@ -0,0 +1,24 @@ +--- +description: A GUI based player shop plugin to enhance your economy. +slug: e/pl/auctionhouse +title: AuctionHouse +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+A decent /ah plugin. Unfortunately, it does have it's fair share of issues. For example, it is one of the most laggiest plugins in every server and also has caused dupes here and there (rare but still possible). + +There are better options out there with far more customizability. + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/chestshop.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/chestshop.mdx.mdx new file mode 100644 index 0000000000..3befbc50a7 --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/chestshop.mdx.mdx @@ -0,0 +1,22 @@ +--- +description: A chest based player shop plugin to enhance your economy. +slug: e/pl/chestshop +title: ChestShop +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+A simple bare bones chest shop plugin, think 'QuickShop' without all the fancy bells and whistles. ChestShop makes a great plugin for anyone who just wants to get some simple buying and selling going in their server. + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/discordsrv.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/discordsrv.mdx.mdx new file mode 100644 index 0000000000..74e97937bb --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/discordsrv.mdx.mdx @@ -0,0 +1,22 @@ +--- +description: DiscordSRV acts as a bridge between a Discord server and your Minecraft server, allowing them to communicate. +slug: e/pl/discordsrv +title: DiscordSRV +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+DiscordSRV is a very commonly used plugin that acts as a bridge between your Minecraft and Discord servers, allowing them to communicate and for actions to be called via interactions in Discord and vice-versa. DiscordSRV also supports livechat functionality between your Minecraft and Discord server so players that aren't logged in can still chat. Moreover, DiscordSRV allows for linking a users Discord account to their Minecraft account on a per-instance basis. That said, the setup of DiscordSRV relies on the creation of an application and Bot on Discord's Developer Portal. + + + + + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/dukesmart.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/dukesmart.mdx.mdx new file mode 100644 index 0000000000..89c3e66970 --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/dukesmart.mdx.mdx @@ -0,0 +1,22 @@ +--- +description: A chest based player shop plugin to enhance your economy. +slug: e/pl/dukesmart +title: DukesMart +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+A plugin to watch as the light weight chest shop plugin was rumoured to be getting one final breath of life with a fork. + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/essentialsx.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/essentialsx.mdx.mdx new file mode 100644 index 0000000000..66130c749e --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/essentialsx.mdx.mdx @@ -0,0 +1,28 @@ +--- +description: EssentalsX introduces over 130 commands for servers of all sizes which will enhance the gameplay with QoL features for all. +slug: e/pl/essentialsx +title: EssentialsX +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +EssentialsX, formerly just Essentials is the core backbone to any Minecraft server, it introduces a wide range of utility commands (all of which are permission toggle controllable) that can be used to enhance the base gameplay over the vanilla commands. + + + + + + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/luckperms.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/luckperms.mdx.mdx new file mode 100644 index 0000000000..895140d4ef --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/luckperms.mdx.mdx @@ -0,0 +1,25 @@ +--- +description: Learn about the PowerRanks plugin and how to get a basic configuration up and running. +slug: e/pl/powerranks +title: PowerRanks +lastUpdated: 2024-01-01 +sidebar: + badge: + text: New + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+PowerRanks is an alternative to Luckperms, it's a Bukkit plugin that support Spigot and it's forks. PowerRanks does have support for NukkitX but has not been updated since Dec 2023. + + + + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/playerauctions.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/playerauctions.mdx.mdx new file mode 100644 index 0000000000..605c04b36d --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/playerauctions.mdx.mdx @@ -0,0 +1,24 @@ +--- +description: A GUI based player shop plugin to enhance your economy. +slug: e/pl/playerauctions +title: PlayerAuctions +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+It has great levels of customizability and flexibility, to the point where you can edit pretty much every aspect of every single menu. It also has compatibility with lots of other plugins and also an author who is always there to provide support. + +The plugin does however lack in the open source department. + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/playershops.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/playershops.mdx.mdx new file mode 100644 index 0000000000..15ce1dedb3 --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/playershops.mdx.mdx @@ -0,0 +1,23 @@ +--- +description: A GUI based player shop plugin to enhance your economy. +slug: e/pl/playershops +title: PlayerShops (BSP) +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +It allows every player to create their own shop GUI, similarly to BossShopPro. Players may sell their items in said shop. Might replacement for ChestShops. this plugin hasn't been updated in a while, though. + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/powerranks.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/powerranks.mdx.mdx new file mode 100644 index 0000000000..60165c89ee --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/powerranks.mdx.mdx @@ -0,0 +1,25 @@ +--- +description: Learn about the Luckperms plugin and how to get a basic configuration up and running. +slug: e/pl/luckperms +title: Luckperms +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Bungeecord, Waterfall & Velocity All major Java & Bedrock platforms +
+LuckPerms is probably the most feature-rich permissions plugin in existence currently. It supports many different kinds of servers, like Bukkit/Spigot or Sponge, but also all the major proxies like Velocity and Bungeecord. + + + + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/quickshop.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/quickshop.mdx.mdx new file mode 100644 index 0000000000..9380421371 --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/quickshop.mdx.mdx @@ -0,0 +1,33 @@ +--- +description: A chest based player shop plugin to enhance your economy. +slug: e/pl/quickshop +title: Quick Shop Remake +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+QuickShop Remake is a forked and maintained version of the long standing '[QuickShop](https://dev.bukkit.org/projects/quickshop)' plugin of the earlier Minecraft days. It allows players to buy and sell between one another and the 'admin store' using chests. + +### Features + +
    +
  • Full sign support
  • +
  • Full support for multi-currency
  • +
  • Supports Taxes
  • +
  • WorldGuard, Towny, PlotSquared and Factions support
  • +
+ +And so much more, the important links for this plugin can be found below. + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/ultimatetimber.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/ultimatetimber.mdx.mdx new file mode 100644 index 0000000000..96a97d627e --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/ultimatetimber.mdx.mdx @@ -0,0 +1,31 @@ +--- +description: A free plugin that freshens up the most basic task in Minecraft - cutting down a tree. +slug: e/pl/ultimatetimber +title: Ultimate Timber +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+Give your players a new and exciting way to cut down trees in Minecraft. + +### Features + +
    +
  • Auto pickup
  • +
  • Auto replant
  • +
  • Custom animations (inc block falling)
  • +
  • Custom item drops
  • +
  • Custom sounds
  • +
+ + + + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/vault.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/vault.mdx.mdx new file mode 100644 index 0000000000..1d8fc72841 --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/vault.mdx.mdx @@ -0,0 +1,29 @@ +--- +description: Vault API is a core framework for most economy, permission and chat plugins and has become a key dependency for many plugins. +slug: e/pl/vault +title: Vault API +lastUpdated: 2023-12-16 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +The Vault API is the longest standing, most reliable permissions, chat and economy API backbone for Minecraft. It's been around for about a decade at this point in time and with every update that passes reliability has always remained. + +Vault is a plugin that once added will rarely need updating and with a lot of plugins requiring it, you should make sure it's first on your download list! + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/worldedit.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/worldedit.mdx.mdx new file mode 100644 index 0000000000..038aa582bc --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/worldedit.mdx.mdx @@ -0,0 +1,28 @@ +--- +description: WorldEdit is a plugin that's been around for over a decade and can be used to help speed up large builds / world changes. +slug: e/pl/worldedit +title: WorldEdit +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+Worldedit is a no-brainer, this is a plugin that's been around for the entire lifespan of Minecraft multiplayer as we know it and it's not going anywhere fast. If you need to move large buildings in your world, export or import schematics this is the tool for you and your build team. Consider using WETS (WorldEdit Tick Spreader) OR AsyncWorldEdit OR FastAsyncWorldEdit, as they can perform tasks faster & prevent crashes. + +Ironically, FAWE performs far worse than WE at higher player counts while it is idle due to it unnecessarily listening to player interactions. If you want to squeeze every last drop of performance out of your server and are not actively using FAWE in any way, we recommend switching back to WE. AWE's idle performance is untested. + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/worldguard.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/worldguard.mdx.mdx new file mode 100644 index 0000000000..4cf011e9e5 --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/worldguard.mdx.mdx @@ -0,0 +1,26 @@ +--- +description: WorldGuard is one of the oldest forms of 'admin land claim' systems and has been a core plugin for many servers over the last decade or so. +slug: e/pl/worldguard +title: WorldGuard +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+If you're using WorldEdit then you've most likely already heard of WorldGuard but for those who haven't WorldGuard allows you to create 'admin land claims' which will prevent certain regions from being griefable. This is a perfect solution for building playershops, central landmarks in your server such as spawns and admin shops and more. Some plugins can even hook into the WorldGuard plugin and enhance it's capability offering a better overall experience to your players. + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Free/znpc.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Free/znpc.mdx.mdx new file mode 100644 index 0000000000..3c4475eaf0 --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Free/znpc.mdx.mdx @@ -0,0 +1,37 @@ +--- +description: An NPC plugin for your Minecraft server. +slug: e/pl/znpc +title: ZPNCs +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +### ZNPCs + +ZNPCs is another popular NPC plugin. Although it is better than Citizens from a performance perspective, it is quite janky and unpleasant to setup. + + + +--- + +### ZNPCsPlus + +ZNPCsPlus delivers great performance while also being easy to setup & edit. Recommended as long as you don't mind the lack of support in other plugins for it, V2 can be compiled from the Github page. + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Premium/citizens.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Premium/citizens.mdx.mdx new file mode 100644 index 0000000000..99924efc1c --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Premium/citizens.mdx.mdx @@ -0,0 +1,23 @@ +--- +description: An NPC plugin for your Minecraft server. +slug: e/pl/citizens +title: Citizens +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +Citizens is the most popular and widely supported NPC plugin in the market. It is purchasable on Spigot and open source as well. Free downloads can be found on it's Jenkins server. Not recommended for servers with high player counts as it can eat a lot of ticks. + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Premium/litebans.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Premium/litebans.mdx.mdx new file mode 100644 index 0000000000..8d226e9d8d --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Premium/litebans.mdx.mdx @@ -0,0 +1,37 @@ +--- +description: Litebans is a premium plugin that centralises ban management for 'networked' servers. +slug: e/pl/litebans +title: Litebans +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Recommended + variant: tip +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Bungeecord, Waterfall & Velocity Spigot / Paper & forks only +
+If you're looking for a method of syncing Minecraft bans between multiple Minecraft proxies, servers (or both) or perhaps you're looking for a way to give your end users some transparency over the punishments that are handed out within your community. If this sounds of interest then Litebans is the tool for you. + +This plugin allows for central management of all punishments via a database and provides you the ability to host a public punishment website for people to view additional details. + +### Features + +
    +
  • UUID based punishments (no username change ban evasions)
  • +
  • UI is fully customisable
  • +
  • Punishment templates
  • +
  • Punishment scope support (multi-server specific)
  • +
  • Web-UI included for free
  • +
+ + + + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/Premium/zauctionhouse.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/Premium/zauctionhouse.mdx.mdx new file mode 100644 index 0000000000..5e790f5a3e --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/Premium/zauctionhouse.mdx.mdx @@ -0,0 +1,25 @@ +--- +description: A GUI based player shop plugin to enhance your economy. +slug: e/pl/zauctionhouse +title: zAuctionHouse +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +A premium version of Player Auctions. You may find greater performance in addition to a few extra features, notably the Shulker viewer and a Sell inventory but that's about it. + +Player Auctions listed in the comparison page says that several features, such as multi-currency support & custom inventories, are not in PA. This is not true as PA does have said features. + + diff --git a/folder/fr/src/content/docs/enhancements/Plugins/intro.mdx.mdx b/folder/fr/src/content/docs/enhancements/Plugins/intro.mdx.mdx new file mode 100644 index 0000000000..7b20e4764f --- /dev/null +++ b/folder/fr/src/content/docs/enhancements/Plugins/intro.mdx.mdx @@ -0,0 +1,16 @@ +--- +sidebar_position: 1 +slug: e/pl +title: Why Plugins +--- + +Our goal is to highlight some must have plugins for Minecraft, in order for them to make the list they have to meet the below criteria. + +
    +
  • Publish to reputable marketplaces
  • +
  • Premium plugins should be on Spigot marketplace
  • +
  • Provide a benefit to either server owners or it's players
  • +
  • Reputable development team
  • +
+ +This is not a definitive list and may change as we add more plugins diff --git a/folder/fr/src/content/docs/guides/Minecraft/Optimisation/advanced.mdx.mdx b/folder/fr/src/content/docs/guides/Minecraft/Optimisation/advanced.mdx.mdx new file mode 100644 index 0000000000..3c1d364a04 --- /dev/null +++ b/folder/fr/src/content/docs/guides/Minecraft/Optimisation/advanced.mdx.mdx @@ -0,0 +1,107 @@ +--- +slug: guides/optimisation/advanced +title: Advanced Checklist +description: A more focused approach on squeezing out every last drop of performance at scale. +sidebar: + order: 3 +--- + +This section covers plugins that you can modify/replace to improve performance. Only recommended at higher player counts. + +#### TAB + +The plugin author's optimisation guide is linked below.. The `anti-override` options are especially important as TAB's overriding is quite intensive. An additional config worth changing to false is `unlimited-nametag-mode`. + +Regarding anti-override, first make sure that none of your plugins mess with the tablist or scoreboard other than TAB itself. Some common culprits might be BetterTeams, eGlow, Paper's collision rules and CMI. + +You will have to remove eGlow in order to take full advantage of this optimisation. Once you're done modifying/removing such plugins, make sure `enable-player-collisions` in Paper's configuration is true. After you do that, you can disable player collisions in TAB's config by changing `scoreboard-teams.enable-collisions`. + +Finally, switch `anti-override` from true to false. If your tablist does not have proper order, an external plugin is probably still modifying the tablist. + +
+Guide +
+ +--- + +#### ProtocolLib & it's Dependants + +ProtocolLib is not very well optimised. Lots of plugins also abuse ProtocolLib a lot, causing even worse performance. Examples are DeluxeCombat (If ProtocolLib hook is enabled) and InteractiveChat. Removal has resulted in significantly better performance in all large servers. + +Consider finding alternatives to plugins that use ProtocolLib, or fork them to use PacketEvents. + +--- + +#### Citizens + +Citizens often eats up >5% of ticks on larger servers. It is recommended that you use ZNPCsPlus instead if you don't mind a smaller catalogue of supported plugins. Overall, ZNPCsPlus was using 0.03% of the ticks at 330 players according to a spark report. + +
+GitHub +
+ +--- + +#### ajLeaderboards + +Although ajLeaderboards has seen great optimization patches in recent times, it is still a tad laggier than it really should be. We recommend LeaderHeadsRevamped instead. Yes, LHR still works perfectly even though it hasn't seen an update in ages. + +If you insist on using ajLeaderboards, make sure `register-lp-contexts` is set to false. + +
+Spigot +
+ +--- + +#### AntiCheat + +Vulcan as an anti-cheat does not scale well at higher player counts, where every bit of performance matters. >1.6% ticks eaten at 350+ players is supoptimal. AstroAC on the other hand only eats 0.03% of ticks at 330 players while having checks that are almost as good as Vulcan's. + +Polar might also be worth it but we have yet to check it's performance at higher player counts + +Spartan (Both Java and Bedrock) is an absolute no-go for even medium-sized servers. Performance is extremely poor and checks are subpar. + +
+Astro +
+ +--- + +#### FastAsyncWorldEdit + +Although FAWE performs far better than WE when it's actually being used for building, it's performance is, rather ironically, significantly worse than standard WorldEdit's at idle due to FAWE listening to player interaction events. + +If you nor any of your plugins are actively using FAWE, consider switching to standard WorldEdit. + +--- + +#### Vanish Plugins + +It is recommended to use AdvancedVanish instead of plugins like SuperVanish and PremiumVanish as their performance is rather poor in comparison. + +
+Spigot +
+ +--- + +#### Geyser + +To offload Geyser's performance impact on your Spigot/Proxy server, you can use Geyser Standalone. Worth it for servers that have a lot of bedrock players. + +#### DiscordSRV + +If you are fine with losing a few features, consider replacing DiscordSRV with Essentials Discord as it isn't as bloated. + +#### Auction House Plugins + +zAuctionHouse is recommended as it runs the smoothest while also having the most features. PlayerAuctions is an alright alternative if you want a free plugin, but it's performance is marginally inferior. Consider enabling zAuctionHouse's cacheItems setting as well. + +#### Stacking Plugins + +Stacking plugins can be very detrimental to server performance depending on their implementations and configurations. RoseStacker is the best we've used thus far, but might end up lagging the server a bit more than if you didn't have it installed. + +#### WorldGuard + +WorldGuard allows you to prevent it from listening to certain events in it's configuration file. Could prove useful for very specific servers, but not something the average server should tinker with. diff --git a/folder/fr/src/content/docs/guides/Minecraft/Optimisation/intro.mdx.mdx b/folder/fr/src/content/docs/guides/Minecraft/Optimisation/intro.mdx.mdx new file mode 100644 index 0000000000..e5952e9a46 --- /dev/null +++ b/folder/fr/src/content/docs/guides/Minecraft/Optimisation/intro.mdx.mdx @@ -0,0 +1,29 @@ +--- +description: This section of setup.md goes in-depth for server optimisation +slug: guides/optimisation +title: Introduction +sidebar: + order: 1 +--- + +A section for optimising Minecraft servers. Optimising your server means to improve the performance of the server by implementing tweaks without heavily modifying desired mechanics. Advanced optimisation is only recommended for large servers suffering from poor performance. + +### Spark Profiler + +You should use the Spark Profiler for monitoring server performance e.g. vanilla mechanics, plugins, GC pauses and cycles, memory usage etc. + + + +### Server JAR + + is currently the fastest, most stable free Paper fork available. Another alternative would be [Purpur](https://purpurmc.org/downloads), which provides additional mechanics for players at the expense of rather negligible performance loss against Pufferfish. +As for proxies, [Velocity](https://papermc.io/software/velocity) is easily the best option. Although it doesn't have as many plugins as Bungeecord, it is far more stable and secure by default. Most popular plugins have already added support for Velocity. + +You may also want to take a look at [UniverseSpigot](https://polymart.org/resource/universespigot-1-20-1.4805). Highly recommended for servers with player counts exceeding 200 (and experiencing lag, of course). It's $70 price tag is certainly worth it. Do be careful with what settings you change as they can drastically affect gameplay. + +| Topic | Summary | +| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Basic Optimisation | Tweaks that will likely suffice for small to medium-sized servers (\< 100 Players) assuming that they have sufficient CPU & memory resources. | +| Advanced Optimisation | Tweaks made for larger servers with at least 150 players. | diff --git a/folder/fr/src/content/docs/guides/Minecraft/Plugins/luckperms.mdx.mdx b/folder/fr/src/content/docs/guides/Minecraft/Plugins/luckperms.mdx.mdx new file mode 100644 index 0000000000..eb154cf5c6 --- /dev/null +++ b/folder/fr/src/content/docs/guides/Minecraft/Plugins/luckperms.mdx.mdx @@ -0,0 +1,98 @@ +--- +description: Learn about the Luckperms plugin and how to get a basic configuration up and running. +slug: guides/luckperms +title: Luckperms +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Advanced + variant: note +--- + +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +### The Basics + +LuckPerms embraces many concepts like "Inheritance" or " Contexts" that might be confusing for a beginner. Consider this section a breakdown of those. + +:::info +For a more in depth explanation of the plugin, one might use the [official wiki](https://luckperms.net/wiki). + +#### Permissions + +A permission is simply put just a piece of text that plugins use to determine what a player can do. They are usually split by periods (like `minecraft.command.kick` for the vanilla /kick command). A permission can have 3 states: + +- `true`: the player can then use the feature which is associated to the permission +- `false` the player is explicitly revoked access to this command or feature. +- undefined: this permission has not been set for this group and defaults to either `true` or `false`, depending how the plugin which uses the permission has determined. + +#### Groups + +A group (or a "rank" as some prefer to call it) is a collection of permissions and other kinds of data which can be given to a player. This simplifies management of, lets say, the staff team as you can simply create a group `admin` and grant it `*` (this permission automatically allows access to everything) which can then be given to your admins and they will all have the same permissions. In this example it might seem counter intuitive, but for ranks with 100s of different permissions, it will become useful. +::: + +One Group always exists: `default`. As its name implies, everybody is in this group, and it is used to give out permissions which every player should have. + +#### Inheritance + +Inheritance is very useful to minimise repeated work. Let us consider the following example: +You have a group `VIP` and a group `MVP`. The group `VIP` is only used to **add** features on top of the `MVP` group. Yet by setting the users group to `MVP`, they would have the permissions from `VIP` revoked. This is where inheritance comes into play. You can make `MVP` inherit `VIP`, so every permission that is granted to `VIP` is automatically reflected in the permissions of `MVP`. + +#### Contexts + +Contexts define the circumstances under which a permission or other data is applied. Still confused? + +Lets take the `gamemode` context as an example. Giving a permission to a player with the context `gamemode=creative` means that they player shall only have that permission if they are in game-mode creative. Quite simple, isn't it? Many plugins add their own contexts, such as EssentialsX' `vanished` pr `god`. + +--- + +### First Steps with LuckPerms + +#### Storage + +Your first step with LuckPerms will be choosing a storage solution. This is a very extensive topic, as each of the storage types come with their own advantages and disadvantages. +A good write up on this would be the [official article](https://luckperms.net/wiki/Storage-types) in the LuckPerms wiki. Essentially there are 3 types of storage: + +- Flat file (In-memory-databases, they work out-of-box) +- Text file (Slower than flat-file, but editable and readable in plain text) +- Database (fastest, readable, but requires an external Database Server) + +In case you run a multi-server setup (e.g. BungeeCord) your only option is a Database! + +#### Your First Commands! + +Once you have LuckPerms installed, you will notice that you do not have access to its primary command `/lp`. You could set it all up through your console, but for the sake of simplicity the command `lp user permission set * ` will give your player full access to every command to simplify the setup. + +Now that that's out of the way let's get started! + +Let's say we want the following architecture: + +![Ranks Example](https://smd.gg/d0bgqaa) + +This structure would allow us to use LuckPerms "promote" feature to, well, promote people. But for that to work, you have to setup "tracks" which the command should follow. Let's say for example you promote a `default` player. They should become a `VIP` and not an `Admin`! + +First we have to create all those groups. Which is simple enough. It's just `/lp creategroup `! + +LuckPerms has many features to edit in its groups and it might overwhelm you at the beginning. But really the only parts you need to know right now are `permission`, `parent`, `meta` and `setweight`. The rest are rather advanced or generally not needed. You already know how to add permissions, so go ahead, give out all the permissions you want your groups to have! In case you screw up somewhere, there always is `unset` to revoke it. +In order to setup the inheritance/promote feature, you simply have to use the `parent` subcommand like this: `/lp group admin parent add mod` or generically `/lp group parent add `. + +That's the entire magic! Your setup is now working! + +#### Prefixes and Rank Tags + +LuckPerms does include the ability to set prefixes and suffixes in its `meta` submenu. But it does not apply them on its own! For that you need other plugins. A general plugin you will need is [Vault](https://dev.bukkit.org/projects/vault). For now don't worry about what Vault on its own does, just know that it's important! + + This intro will be split into 2 parts: Chat and Nametags (Tablist or above the playerhead). + +##### Chat + +There is no end to the list of chat formatting plugins. Most of them offer support to customize your chat format, and as such your prefixes too. It really depends on the specific plugin, but most ones will have a placeholder which you can include in the chat format. + +#### Tablist and Nametag + +The entire story is a different one when we move to the Tablist part of this guide. There are only really 2 options: + + + + + diff --git a/folder/fr/src/content/docs/guides/Minecraft/Plugins/terra.mdx.mdx b/folder/fr/src/content/docs/guides/Minecraft/Plugins/terra.mdx.mdx new file mode 100644 index 0000000000..e20903f78d --- /dev/null +++ b/folder/fr/src/content/docs/guides/Minecraft/Plugins/terra.mdx.mdx @@ -0,0 +1,85 @@ +--- +description: Configure a Terra world gen world for use in both Single and Multiplayer environments. +slug: guides/terra +title: Terra World Generation +lastUpdated: 2024-03-04 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +The setup.md wiki provides Terra worlds available for download monthly, the principle of this guide can be used in situations with / without our pre-provided files if you wish to generate things for yourself. + +Before continuing with configuring Terra we are assuming the following: + +
    +
  • You are using one of our provided world files
  • +
  • You are running atleast version 1.20.4
  • +
+ +Make sure you download one of our maps via our 'Additional Services' page. + + + +You will then need to scroll down to one of the following topic headers to complete setup. + +
    +
  • Paper & Forks
  • +
  • Fabric & Forge
  • +
+ +### Paper & Forks + +Download the latest `.jar` file from the Modrinth page using the link below and add it directly to your `/plugins/` folder inside the server directory. + + + +You will also need to append the following changes to the end of your `bukkit.yml` file **BEFORE** launching your server, this will ensure your server uses the Terra world gen plugin. + +``` +... + +worlds: + world: + generator: Terra:OVERWORLD + +... +``` + +Once this has been complete you can upload and unzip the World.XXXXXXX.zip folder into your server directory. This will automatically extract into a `world` folder and you should be ready to start your server. + +console logs + +Once the server is powered on, check for the three lines highlighted above. If these are displayed that means Terra is responsible for your world and chunk management / generation going forward. + +--- + +### Fabric & Forge + +Download the latest `.jar` file from the Modrinth page using the link below and add it directly to your `/mods/` folder inside the server directory. + + + +Add the following key to your `server.properties` file **BEFORE** launching your server, this will ensure your server uses the Terra world gen plugin. + +``` +... + +level-type=terra:overworld/overworld + +... +``` + +Once this has been complete you can upload and unzip the World.XXXXXXX.zip folder into your server directory. This will automatically extract into a `world` folder and you should be ready to start your server. diff --git a/folder/fr/src/content/docs/guides/Minecraft/Self-Host/Standalone (Java)/linux.mdx.mdx b/folder/fr/src/content/docs/guides/Minecraft/Self-Host/Standalone (Java)/linux.mdx.mdx new file mode 100644 index 0000000000..8e56d7ccf9 --- /dev/null +++ b/folder/fr/src/content/docs/guides/Minecraft/Self-Host/Standalone (Java)/linux.mdx.mdx @@ -0,0 +1,230 @@ +--- +description: If you're just looking to setup a Minecraft server within Linux on your own personal machine then this is the tutorial for you. +slug: guides/self-host/linux +title: Linux +--- + +If you're in the position where you want to host a Minecraft server but you don't want to learn or interface with the command line too frequently then Windows will most likely be your OS of choice either on your own PC or a spare machine you have around the house. + +This guide will not cover the basics of deploying Windows, securing your OS and patch automation as we have already covered those within our [lab](https://setup.md/guides/lab) series. + +### Installing Java + +The first thing you need to do is ensure you have installed the relevant Java JDK version for your desired Minecraft version. The latest release of Minecraft (1.20.1) currently uses Java 17 so that is the version we will be installing in this tutorial. + +Ubuntu uses the `APT` package manager, it's generally considered a good idea to run the following commands before trying to install an application for the first time. + +```bash +... + +sudo apt update +sudo apt upgrade -y + +... +``` + +Once you've ensured the package list has been updated and installed packaged upgraded you can proceed with installing java depending on which Minecraft version you're looking to install you may need to change this command slightly. + +To identify which versions of JRE are installable you can run the following command. + +```bash +... + +apt search "jre-headless" + +... +``` + +This should result in the following output. + +```bash +... + +Sorting... Done +Full Text Search... Done + +default-jre-headless/stable,stable 2:1.11-72 amd64 + Standard Java or Java compatible Runtime (headless) + +openjdk-11-jre-headless/stable,stable-security,stable,stable-security 11.0.14+9-1~deb11u1 amd64 + OpenJDK Java runtime, using Hotspot JIT (headless) + +openjdk-17-jre-headless/stable,stable-security,stable,stable-security 17.0.2+8-1~deb11u1 amd64 + OpenJDK Java runtime, using Hotspot JIT (headless) + +... +``` + +:::info +Java 16 was not an LTS release and therefore isn't present in the list. + +You can now run the following command changing the `version-number` to determine if you would like to install Java 8, Java 11 or Java 17. + +::: + +```bash +... + +sudo apt install "openjdk-17-jre-headless" -y + +... +``` + +The above command will install Java 17 and will allow for us to create a server using the latest builds. You can confirm this has installed successfully by running the following command. + +```java +... + +java --version + +... +``` + +The above command should print out the latest build number for the Java 17 release we have just installed. If you have any errors you can checkout the following guide [troubleshooting java](/ts/java). + +### Creating the Minecraft server + +We are nearing the end of this guide, only a few more things to do! + +Before we download anything, we should make a directory to put our server in. You can do this by typing the following commands. + +```bash +... + +mkdir minecraft-server-folder +cd minecraft-server-folder + +... +``` + +Now we can deploy the server jar we're wanting to use, this tutorial will reference [purpur](https://purpurmc.org) but there are plenty of other server platforms and [this page](/t/server-software) explains the pros and cons of the major ones. + +```bash +... + +wget https://jar.smd.gg/download/purpur/latest/latest --content-disposition + +... +``` + +By adding the `--content-disposition` we're preventing the downloaded file being an extension-less file called `download`. + +To confirm the file has downloaded correctly you can use the `ls -al` command to display the contents of the `minecraft-server-folder`. + +```bash +... + +-rw-r--r-- 1 root root 42329978 Jul 9 08:07 purpur-1.20.1-2058.jar + +... +``` + +In order to start our server we need to create a file that accepts the EULA for Mojang. This can be done with the following command. + +```bash +... + +bash -c 'echo "eula=true" > eula.txt' + +... +``` + +We can now run the following command from the console in order to start our server, this will start the server and create all of the files it needs to run as expected. + +```bash +... + +java -Xmx4G -Xms4G -jar purpur-1.20.1-2058.jar nogui + +... +``` + +Once you see the line `Done in (seconds)` you can press `shift + c` to end the session or type `stop` like a normal server. + +So now technically everything is setup and ready - If your newly created VPS was sitting in your house you would be able to play right now... but it's not - so we need to open the 25565 port to the internet. + +#### Making it accessible over the internet (Port Forwarding) + +While we're still connected via SSH it will save time later for us to configure the servers local firewall now. + +:::info +This tutorial uses Ubuntu and UFW. If you chose another another distro at the start of this guide you will most likely have a different wrapper, if this is the case you will need to consult the docs for how best to open ports 25565 for TCP and UDP traffic. +::: + +To open TCP and UDP traffic within Ubuntu we need to use the following commands. + +```bash +... + +sudo ufw allow 22/tcp #this will allow us to continue SSH access +sudo ufw allow 25565/tcp #this will open the tcp port 25565 (minecraft game) +sudo ufw allow 25565/udp #this will open the udp port 25565 (minecraft query) +sudo ufw enable + +... +``` + +You can check UFW has successfully deployed and enabled by typing the following command. + +```bash +... + +sudo ufw status + +... +``` + +Switching back to the server, you should now be able to start the server again using the same command we used previously. + +```bash +... + +java -Xmx4G -Xms4G -jar purpur-1.20.1-2058.jar nogui + +... +``` + +You are now technically complete, you should be able to join your newly created server using the IPv4 address of the Linux box you're hosting on... There's a couple of things to note in the below 'Optional Configuration' settings which will help you down the line. + +#### Optional Configuration + +The above steps will get you up and running with the basics, but some settings can be adjusted further to make life easier for yourself as an admin. + +##### Adjusting RAM Allocation + +We go over adjusting the RAM allocation in more depth [here](/t/flags). + +##### Installing 'Screen' + +Screen is an application that allows for you to run your server in the background even after you close your SSH session. + +To install screen run the following command. + +```bash +... + +sudo apt install screen -y + +... +``` + +Now screen has been installed you can run the following commands to launch your server within screen. + +```bash +... + +screen +java -Xmx4G -Xms4G -jar purpur-1.20.1-2058.jar nogui + +... +``` + +To exit the screen session you should press `CTRL + A + D`. You should now be able to close the command prompt window without the server crashing. If you need to return to your screen windows you can use the command `screen -r`. + +##### Installing Plugins + +We go over installing plugins in more depth [here](/e/pl). + +##### JVM Flags (Aikar) + +We go over adjusting the start-up flags in more depth [here](/t/flags). diff --git a/folder/fr/src/content/docs/guides/Minecraft/sftp.mdx.mdx b/folder/fr/src/content/docs/guides/Minecraft/sftp.mdx.mdx new file mode 100644 index 0000000000..636a76aeff --- /dev/null +++ b/folder/fr/src/content/docs/guides/Minecraft/sftp.mdx.mdx @@ -0,0 +1,84 @@ +--- +description: Learn how to upload files to Pterodactyl panels using SFTP. +slug: guides/using-sftp +title: Using SFTP +lastUpdated: 2024-08-10 +sidebar: + badge: + text: New + variant: success +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you're new to hosting a Minecraft server and you are looking to bring across a world file of your own or upload some plugins / mods to make your experience a little bit better, +this guide will focus on using SFTP in order to get around the 100MB file upload limit of the web-based file manager. + +### Requirements + +Depending on your computers operating system you will need to download one of the following SFTP tools, our tutorials will use FileZilla because this is cross platform. + +#### Windows + +The following clients are free for Windows users, there are alternatives however these are the most common and best supported solutions. + + + + + + +#### MacOS + +The Mac has a whole suite of paid SFTP products on the App Store however FileZilla is also Mac native and is the solution we recommend for this platform. + + + + + + +#### Linux (Deb) + +For simplicity we're also recommending FileZilla for Debian based distros. + + + +--- + +### Identifying your Credentials + +Once you have installed FileZilla the next step is for you to get connected to your Minecraft server. You can find the information within your provider panel, most providers are now using Pterodactyl so you need to find the following block of information below\*. + + +*Depending on your provider your panel will look different but they will all display this set of information +
+Copy the information from the `SFTP Address` and `Username` fields we will need this information within our FileZilla client. + +:::note + +Your SFTP password will be the same password you use to login to the panel, you can also configure SSH keys to use with SFTP but that is out of scope for this tutorial. +::: + +--- + +### Configuring FileZilla + +Once you have the information we're going to 'create a site' so we don't need to input this data everytime we want to file transfer, to do this select the site manager in the top left corner. + + + +Select 'New Site' and you can now fill in the section on the right hand side, you should change Protocol from FTP to SFTP else you will run into issues while connecting. + + + +Once you have copied this information over you should press 'Connect' and you will be presented with one final confirmation window, select 'Always trust this host' and then press 'Ok'. + + + +You will now be connected to your server via SFTP, you can upload/download, edit or delete files from the highlighted window below. + + diff --git a/folder/fr/src/content/docs/guides/OVH/Optional/Configuration/hardening.mdx.mdx b/folder/fr/src/content/docs/guides/OVH/Optional/Configuration/hardening.mdx.mdx new file mode 100644 index 0000000000..346dda5c95 --- /dev/null +++ b/folder/fr/src/content/docs/guides/OVH/Optional/Configuration/hardening.mdx.mdx @@ -0,0 +1,249 @@ +--- +description: Device hardening guide and and explantion of the tools used to complete such activities. +slug: guides/lab/hardening +title: Hardening +sidebar: + badge: + text: Recommended + variant: tip +--- + +This document is designed specifcally for those who want to tighten up windows and add some preventative measures to lock down their machine, it should be made known that the more you lock down a machine the less functionality it will have. + +You should find a balance for your own environment that works best for you by either disabling or enhancing the provided policies, this page breaks down the NCSC guidelines for systems hosting '[OFFICAL](https://smd.gg/jx9p7xw)' data. + +### Windows Home + +As home based editions of Windows cannot use Group Policy below are some things you should look into securing and enabling. + +#### Permissions + +When setting up a new environment it's easy to give anything and everything full admin credentials in order to get something up and running but STOP and take the time to do things right. You should consider implementing a [principle of least privilege](https://www.f5.com/labs/articles/education/what-is-the-principle-of-least-privilege-and-why-is-it-important) from the get-go as it: + +- Enables greater control over who can manage / change a system +- Reduces the level of damage compromised accounts can cause +- Reduces the attack surface (entry points) +- Reduces risk through error / negligence / internal malicious attacks + +While Home users can't use Group Policy for file permissions it can all be easily controlled via the Windows UI, as part of the least privilege principle this will assist in ensuring data access is only performed on a 'need to know' / 'required for function', you can find a good explanation for this [here](https://youtu.be/S-tTcRC5Q2A?t=123) + +#### Patching + +Patch Tuesday, the second Tuesday of every month is the most important Tuesday in the calendar for your computer. It's the day that Microsoft delivers important updates that will address potentially dangerous exploits that can give an attacker full complete access to your machine, unless the machine will never be connected to the internet again after being deployed you should enable 'Automatically check for Windows Updates' (in Windows 10/11 you shouldn't be able to disable this via the settings UI). + +#### Applications + +Firstly, every application on your system is a potential entry point for an attacker, if you're never going to use it then uninstall it! This includes Windows features too, it's recommended that you atleast uninstall the following Windows features: + +- Internet Explorer +- SMB 1.0 + +This can be done by going to 'Control Panel' > 'Uninstall a program' > 'Turn Windows features on or off' and removing the tickbox next to the above entries. + +:::tip +A reboot will be required after completing this step +::: + +#### Windows (Defender) Security + +The following settings are configured within 'Windows Security' application and _should_ be enabled by default but regardless it's important to check. + +- Reputation based scanning is configured under the 'App and Browser control' setting +- Core Isolation is configured under the 'Device security' setting + - Memory Integrity is also a feature enabled within this section but you will need to 'View details' before you can toggle this on +- Exploit protection is configured under the 'Device security' setting along side the below nested items for this category + - Control Flow Guard + - Data Execution Protection + - Mandatory ASLR + +#### Windows OS + +There are a couple of things that are recommended if you're not actively using these features, firstly disable bluetooth if you're not using it and secondly turn off auto play as it has previously been used to exploit systems. + +- Autoplay settings can be found under 'Settings' > 'Devices' > 'Autoplay' + +--- + +### Windows Pro / Enterprise + +You can download the Group Policy template files from [here](https://github.com/ukncsc/Device-Security-Guidance-Configuration-Packs/raw/main/Microsoft/Windows/GPO/NCSC_Windows_GPO.zip). + +#### App Guard Policies + +The Windows App Guard policy will make the following changes to your PC. + +- General hardening of Defender App Guard policies. + +#### App Locker Policies + +The Windows App Locker policy will make the following changes to your PC. + +- Allows only execution of Microsoft signed applications, dlls, installers, scripts and appx + +:::tip +Development machines should be excluded from this policy otherwise they may end up not being able to run the required tools. +::: + +#### Bitlocker Policies + +The Windows bitlocker policy will make the following changes to your PC. + +- Disables standby mode when sleeping +- Encrypts the drive with XTS-AES 128 +- Disables devices such as thunderbolt that have direct memory access while a device is sleeping +- TPM bitlocker settings are configured +- Deny write access to removable media for devices configured to work with another organisation + +#### Computer Policies + +The Windows computer policy will make the following changes to your PC. + +- Prevents login with personal Microsoft accounts +- Disables user trusted root CAs +- Disables the ability for users to trust certificates +- Defines trusted root CAs for the device to use +- Prevents lock screen camera +- Requires a domain admin to change network location +- Defines proxy values +- Prevents installation of devices that match X hardware IDs +- Prevents installation of devices that use drivers matching X setup classes +- Disables Windows 'PC-Phone' link +- Disables sign-in with picture login +- Disables clipboard history +- Disables clipboard sync across devices +- Disables upload and publishing of user activities +- Disables activity feed +- Blocks universal windows apps from launching with Windows runtime API +- Removes the display password button on login forms +- Disables telemetry gathering +- Disables diagnostic data viewer +- Disables windows-to-go +- Disables cortana +- Disables search the web in windows start menu +- Disables all store applications within the MS Store +- Disables the MS Store +- Disables syncronisation of windows settings +- Ensures defender is enabled +- Disables windows error reporting +- Ensures Windows Hello is enabled for TPM 2.0 and disables lower +- Removes access to 'pause windows updates' +- Disables preview builds of windows +- Ensures a semi-annual release channel is configured using Windows update for business +- Disables Edge data collection +- Disables further telemetry +- Removes local password reset questions +- Edge pre-loading tabs disabled +- Edge extension sideloading disabled +- Blocks non-admins from enterting the device into safe-mode + +#### Device Guard + +The Windows device guard policy will make the following changes to your PC. + +- Enables virtualisation based securty +- Ensures code integrity +- Ensures credential guard is configured +- Ensures secure boot and direct memory access protection is configured + +:::tip +When enabling this policy you will need to ensure the VMs are created with Nested support otherwise Credential guard will fail to deploy. Option B would be to disable the 'Turn on Virtualisation Based Security' policy located in 'Computer Configuration' > 'Policies' > 'Administrative Templates' > 'System' > 'Device Guard' +::: + +#### Device Health + +This policy can be considered optional unless the device is enrolled into SCCM or another MDM platform. + +- Enables Device Health monitoring and reporting services + +#### Firewall Settings + +You should add further rules here if additional services are required for the network otherwise additional device / group based policies should be created using the 'Duplicate' feature and adding additional policies. + +- Enables Windows firewall +- Blocks inbound connections (unless explicitly stated) +- Allows outbound connections +- For both 'Private' and 'Personal' network settings outbound connections are blocked +- Configures outbound rules for the following services + - DHCP + - DNS + - Kerbose + - LDAP + - NCSI Probe + +#### OneDrive Settings + +This policy is entirely optional for home / lab environments where Office 365 business / dev subscriptions are not present. + +- Prevents personal OneDrive accounts syncing + +#### User Settings + +This policy is entirely optional but recommended for laptops / busy environments. + +- Ensures screen lockout time is set to 600 seconds + +#### Windows Defender + +The Windows defender policy will make the following changes to your PC. + +- Enables block on first sight +- Enrolls device to Microsoft MAPs (requirement for 'block on first sight' to work) +- Send sample file analysis +- Ensures real-time protection is enabled +- Prevents app installation from sources outside of the Microsoft Store +- Ensures smart screen is configured for Windows +- Ensures smart screen is configured for Edge +- Prevents you from being able to bypass the smartscreen prompt + +#### Installation Guide + +For Active Directory deployments you should use `Group Policy Management Editor` to import the policies. + +For single machine deployments you should consider `Powershell` to import the policies, the below command may help. + +```powershell + +... + +import-gpo -BackupId {folder-name} -TargetName {gpo} -path {c:\full\path\to\folder} -CreateIfNeeded + +... +``` + +#### Closing Thoughts + +From using these settings within our own environment you will want to make some changes, most specifically in the following areas. + +- Windows Firewall (opening RDP will prevent you needing to use proxmox viewer) +- App Guard (you will want to add any core non-ms apps you use in this policy e.g. chrome, firefox, vscode... anything that isn't published by Microsoft Corporation) + +--- + +### Ubuntu Script + +You can download the post-deployment bash script from [here](https://github.com/ukncsc/Device-Security-Guidance-Configuration-Packs/tree/main/Linux/UbuntuLTS) and manually run it on the server. + +Ubuntu, unlike Microsoft, does not require a certain edition for the script to work, at the time of writing this script worked on the latest LTS build of Ubuntu. + +#### Script break down + +- Firstly the script must be run as 'sudo' +- Secondly it will fetch the admin user +- You will then need to select the administrator account that you created during installation +- You will confirm the app repositories +- The system will complete an update, upgrade and install app armour +- Grub password is configured +- Automatic updates are configured +- Prevents standard users executing as `super user` +- Protects home directories +- Modified shell access for other users on the machine except admin account specified +- Configures pw complexity +- Enables app armour +- Enables system audting +- Disables error reporting service +- Option to disable Bluetooth +- Configures 600s lock screen timer +- Modifies lockscreen behaviour +- Optional settings for location services, privacy and usb restrictions +- Fixes folder permissions +- Sets up UFW without any rules diff --git a/folder/fr/src/content/docs/guides/Services/domainpark.mdx.mdx b/folder/fr/src/content/docs/guides/Services/domainpark.mdx.mdx new file mode 100644 index 0000000000..bdc6eb1ca1 --- /dev/null +++ b/folder/fr/src/content/docs/guides/Services/domainpark.mdx.mdx @@ -0,0 +1,85 @@ +--- +description: Run a self hosted instance of domain-park.org for those extra domains you own but don't know what to do with. +slug: guides/domain-parking +title: Domain Parking +--- + +If you own multiple domains it may be worth looking into a service such as `domain-park` to ensure these domains remain secure while you're not using them. Thankfully domain-park is an open source project and implements the following features. + +- Best practices for SPF, DKIM, DMARC and MX compliance for parked domains +- Easy to deploy with no server configuration per domain +- Ability to configure DMARC reports + +If you do decide to run an instance (or two) of domain park you should aim for the following setup. + +- A domain you use for everything e.g. `servers.fun` +- A domain you want to park e.g. `urho.st` +- A VPS (or two) that have static (and public) IP addresses we can assign hostnames to +- A DNS management panel such as `Cloudflare DNS` + +:::danger +Cloudflare registry doesn't support using external name servers, if your domain you wish to park is registered with Cloudflare you will need to use an alternative solution. +::: + +--- + +### Creating a VPS + +If you're looking for a solid VPS provider, checkout Hetzner. You can use our affiliate link https://smd.gg/joinhetzner for €20 free credit and in return we'll also get a little bit back from Hetzner. + +If you're using Hetzner you should be able to get away with deploying x2 `CPX11 instances` with the latest LTS build of Ubuntu (Debian works too) which should set you back €9/mo. It's also recommended that you add an SSH key and avoid using password based authentication. + +--- + +### Setting up DNS (Active) + +So the first thing we will do is configure the DNS, this is because these _can_ take the longest to update in the background. + +- Login to your DNS provider and head to your DNS record section. +- Select 'Add' and create an `A Record` enter `one.ns` and point it to one of your VPS IPs + - **Optional**: If you have an IPv6 also add a `AAA Record` for the same hostname +- Repeat this but replace `one.ns` with `two.ns` + +:::tip + +If you're using Cloudflare for your "Active Domain" you should ensure the orange cloud is disabled. + +::: + +Once you have configured these addresses your DNS panel should look something like this. + +![IMG](https://uk.thot.cc/api/shares/U3NTk4N/files/7bb07f91-af5d-4741-bd3f-7cb20421e586?download=false) + +After a short while your records will have propagated and you should be able to check the A and AAA records for your hostname using a tool such as MXToolbox or the `dig` linux package. + +#### Dig Commands + +```bash +... + +dig one.ns.servers.fun A +dig one.ns.servers.fun AAA # Not configured in example + +dig two.ns.servers.fun A +dig two.ns.servers.fun AAA # Not configured in example + +... +``` + +Providing you replace `servers.fun` with your own domain you should see a response with the IP addresses you entered into your panel above. + +--- + +### Setting up DNS (Parked) + +On the domain you wish to park using your newly setup service you'll need to change your nameservers. You can do this within your domain's control panel (probably in a similar location to the DNS modification page). + +You should ensure you fill out the nameservers as per the screenshot below. Once these have been added correctly, save changes and await up-to 48 hours for this to complete. + +![IMG](https://uk.thot.cc/api/shares/Y2NjM0O/files/471bcb1d-42bf-4e52-a9b2-be56323eb3c5?download=false) + +When using these nameservers you will not be able to host **ANY** content via the domain as domain-park does not allow for it. We have configured our nameservers to redirect to this page when accessing any of our IPs / Hostnames directly. + +--- + +### Deploying Domain-Park diff --git a/folder/fr/src/content/docs/guides/Services/oracle.mdx.mdx b/folder/fr/src/content/docs/guides/Services/oracle.mdx.mdx new file mode 100644 index 0000000000..ad26338841 --- /dev/null +++ b/folder/fr/src/content/docs/guides/Services/oracle.mdx.mdx @@ -0,0 +1,330 @@ +--- +description: A modified version of the guide produced by u/Belaboy1095969 on the Admincraft reddit using Ubuntu LTS. +title: Oracle Cloud +slug: guides/oracle-cloud +--- + +:::note + +Due to the increased popularity of the Oracle free tier, services may not be available in your desired region at the time of creating your account. You can either use another region close to your playerbase, wait until free capacity becomes available within your desired region or migrate to a paid account. + +::: + +This guide originally comes from the Admincraft subreddit user [u/Belaboy1095969](https://www.reddit.com/r/admincraft/comments/qo78be/creating_a_minecraft_server_with_oracle_cloud/), with full prior permission we have re-uploaded this tutorial into our central repository. + +If you're looking to host a basic server that is kept online (for free, 24/7) that you and your friends can play on then this is the guide for you. This guide comes with the following expectations, further expansion on some of these points can be requested within the setup.md [discord server](https://discord.gg/pXaQgzneed) if required. + +### You Will Need + +- A ~~Java Minecraft Account~~ Minecraft license, as of 07 June 2022 these games are now [bundled together](https://www.minecraft.net/en-us/article/java---bedrock-edition-pc-out-june-7). +- A credit / debit card for oracle account verification (anti-bot process) + +--- + +### Getting Started + +This guide will assume you have already gone through the sign-up process for the [OCI console](https://signup.cloud.oracle.com/?sourceType=_ref_coc-asset-opcSignIn&language=en_US). Once this step has been completed you can follow the rest of this guide. + +#### Creating a Virtual Machine instance. + +Don't Panic! This part isn't as complicated as it sounds. Once you have finished setting up your account, click the "Create a VM instance" panel. + +![img1](https://preview.redd.it/lb6qbe1fd0y71.png?width=912&format=png&auto=webp&s=eb13c09a39b8c9b4d8e8d6a7de588d96a4847afe) + +Give your VM instance a name. Anything will work, but make it easily identifiable. You can leave the default (Root) compartment selected. + +![img2](https://preview.redd.it/z0fcocxpd0y71.png?width=792&format=png&auto=webp&s=99637b502a83ff60f5189a73a77cfb5a88304e7f) + +Now, Scroll down to the "Image and Shape" section. Make sure "Ubuntu LTS 22.04 (Or just the latest build)" Is selected. Then click "Change shape". Under "Shape series", Select "Ampere". Now set the amount of Ram and CPU Cores you would like. + +:::tip +You should allocate no less than 2 CPU Cores and 8GB of ram to the VPS. After you have finished selecting the shape, make sure the "Always free eligible" Tag is showing. + +![img3](https://preview.redd.it/32bkfk8te0y71.png?width=757&format=png&auto=webp&s=d7f50ceae622064c9590c9ef41f82afdce809fed) + +::: + +Next, we need to create a VCN (Or Virtual Cloud Network). If you already have a VCN, use that. If not, select "Create a Virtual Cloud Network" Copy the settings in the picture below! + +![img4](https://preview.redd.it/xtozv7u9f0y71.png?width=766&format=png&auto=webp&s=6d1c1643aa182fc52b418854d95763bc19996c90) + +We'll need an SSH Key pair to access the server remotely. To generate a keypair, tick the box that says "Generate a new keypair" and then download both the public and private keys. Don't lose these, or else you won't be able to connect to your server remotely! + +![img5](https://preview.redd.it/rzk6yq65g0y71.png?width=791&format=png&auto=webp&s=1fcc085a62f2235d9fd179bb9bff1625ed95055b) + +Leave the boot volume settings alone and hit "Create"! + +Once you hit "Create", you will be redirected to your VM details and your VM will be in a "Provisioning" state. Wait for it to be in a running state, which should take 30-60 seconds. Under the "Instance access", you should see an IP Address. Copy it. + +#### Connecting to your VM with SSH. + +There are multiple SSH clients out there from classics such as PuTTY and newer clients such as Termius. For simplicity and universal sake we will use a command prompt / terminal window. + +Open a command prompt / terminal window and type in the following command : + +```bash +... + +ssh root@ -i "path-to-ssh-private.key" + +... +``` + +As this is your first time connecting you'll need to 'accept' either by pressing `Y` or typing `Yes` in the confirmation box. You should then see a screen similar to the below. + +![img6](https://preview.redd.it/ix7ilvzyl0y71.png?width=970&format=png&auto=webp&s=580fa11dcbce68b0dc12bb9e2ddd8e3d832830fc) + +Our VM is now deployed and ready to configure with Java and our server. + +#### Installing Java + +Ubuntu uses the `APT` package manager, it's generally considered a good idea to run the following commands before trying to install an application for the first time. + +```bash +... + +sudo apt update +sudo apt upgrade -y + +... +``` + +Once you've ensured the package list has been updated and installed packaged upgraded you can proceed with installing java depending on which Minecraft version you're looking to install you may need to change this command slightly. + +To identify which versions of JRE are installable you can run the following command. + +```bash +... + +apt search "jre-headless" + +... +``` + +This should result in the following output. + +```bash +... + +Sorting... Done +Full Text Search... Done + +default-jre-headless/stable,stable 2:1.11-72 amd64 + Standard Java or Java compatible Runtime (headless) + +openjdk-11-jre-headless/stable,stable-security,stable,stable-security 11.0.14+9-1~deb11u1 amd64 + OpenJDK Java runtime, using Hotspot JIT (headless) + +openjdk-17-jre-headless/stable,stable-security,stable,stable-security 17.0.2+8-1~deb11u1 amd64 + OpenJDK Java runtime, using Hotspot JIT (headless) + +... +``` + +:::info +Java 16 was not an LTS release and therefore isn't present in the list. + +You can now run the following command changing the `version-number` to determine if you would like to install Java 8, Java 11 or Java 17. + +::: + +```bash +... + +sudo apt install "openjdk-17-jre-headless" -y + +... +``` + +The above command will install Java 17 and will allow for us to create a server using the latest builds. You can confirm this has installed successfully by running the following command. + +```bash +... + +java --version + +... +``` + +The above command should print out the latest build number for the Java 17 release we have just installed. If you have any errors you can checkout the following guide [troubleshooting java](/ts/java). + +### Creating the Minecraft server + +We are nearing the end of this guide, only a few more things to do! + +Before we download anything, we should make a directory to put our server in. You can do this by typing the following commands. + +```bash +... + +mkdir minecraft-server-folder +cd minecraft-server-folder + +... +``` + +Now we can deploy the server jar we're wanting to use, this tutorial will reference [purpur](https://purpurmc.org) but there are plenty of other server platforms and [this page](/t/server-software) explains the pros and cons of the major ones. + +```bash +... + +wget https://jar.smd.gg/download/purpur/latest/latest --content-disposition +# You can replace 'purpur' for 'paper' if you prefer. +wget https://jar.smd.gg/download/purpur/latest/latest --content-disposition + +... +``` + +By adding the `--content-disposition` we're preventing the downloaded file being an extension-less file called `download`. + +To confirm the file has downloaded correctly you can use the `ls -al` command to display the contents of the `minecraft-server-folder`. + +```bash +... + +root@vps:~/minecraft-server-folder# ls -al +total 41348 +drwxr-xr-x 2 root root 4096 Jul 9 16:59 . +drwx------ 7 root root 4096 Jul 9 16:59 .. +-rw-r--r-- 1 root root 42329978 Jul 9 08:07 purpur-1.19-1708.jar + +... +``` + +In order to start our server we need to create a file that accepts the EULA for Mojang. This can be done with the following command. + +```bash +... + +bash -c 'echo "eula=true" > eula.txt' + +... +``` + +We can now run the following command from the console in order to start our server, this will start the server and create all of the files it needs to run as expected. + +```bash +... + +java -Xmx6G -Xms6G -jar purpur-1.19-1708.jar nogui + +... +``` + +Once you see the line `Done in (seconds)` you can press `shift + c` to end the session or type `stop` like a normal server. + +So now technically everything is setup and ready - If your newly created VPS was sitting in your house you would be able to play right now... but it's not - so we need to open the 25565 port to the internet. + +#### Making it accessible over the internet (Port Forwarding) + +While we're still connected via SSH it will save time later for us to configure the servers local firewall now. + +:::info +This tutorial uses Ubuntu and UFW. If you chose another another distro at the start of this guide you will most likely have a different wrapper, if this is the case you will need to consult the docs for how best to open ports 25565 for TCP and UDP traffic. +::: + +To open TCP and UDP traffic within Ubuntu we need to use the following commands. + +```bash +... + +sudo ufw allow 22/tcp #this will allow us to continue SSH access +sudo ufw allow 25565/tcp #this will open the tcp port 25565 (minecraft game) +sudo ufw allow 25565/udp #this will open the udp port 25565 (minecraft query) +sudo ufw enable + +... +``` + +You can check UFW has successfully deployed and enabled by typing the following command. + +```bash +... + +sudo ufw status + +... +``` + +The next steps are to do the same things within the Oracle Cloud interface. You will need to look for the category "Primary VNIC". Click the "Public Subnet" link. + +![img7](https://preview.redd.it/puhdgco6s0y71.png?width=724&format=png&auto=webp&s=62c56c8262c55129000a90726e05aa4de4039d19) + +Then click the "Default Security list" link. + +![img8](https://preview.redd.it/2poaepmcs0y71.png?width=537&format=png&auto=webp&s=3fa87f551aa084e5fb23699c670dab2a4d6c4d8a) + +And Add an "Ingress Rule". Copy the configuration shown here ,Then create another ingress rule with the same configuration, but change the "IP Protocol" to TCP, as shown below. + +![img9](https://preview.redd.it/23cjw70hs0y71.png?width=756&format=png&auto=webp&s=e33b04dab55c625d3fc68fd15c1d6adc7871c78c) + +Switching back to the server, you should now be able to start the server again using the same command we used previously. + +```bash +... + +java -Xmx6G -Xms6G -jar purpur-1.19-1708.jar nogui + +... +``` + +You are now technically complete, you should be able to join your newly created server and share the IP with your friends... There's a couple of things to note in the below 'Optional Configuration' settings which will help you down the line. + +#### Optional Configuration + +The above steps will get you up and running with the basics, but some settings can be adjusted further to make life easier for yourself as an admin. + +##### Adjusting RAM Allocation + +We go over adjusting the RAM allocation in more depth [here](/t/flags). + +##### Installing 'Screen' + +Screen is an application that allows for you to run your server in the background even after you close your SSH session. + +To install screen run the following command. + +```bash +... + +sudo apt install screen -y + +... +``` + +Now screen has been installed you can run the following commands to launch your server within screen. + +```bash +... + +screen +java -Xmx6G -Xms6G -jar purpur-1.19-1708.jar nogui + +... +``` + +To exit the screen session you should press `CTRL + A + D`. You should now be able to close the command prompt window without the server crashing. If you need to return to your screen windows you can use the command `screen -r`. + +##### Installing Plugins + +We go over installing plugins in more depth [here](/e/pl). + +##### JVM Flags (Aikar) + +We go over adjusting the start-up flags in more depth [here](/t/flags). + +--- + +### **Disclaimer** + +This guide has been modified slightly to cater for the needs of this project, setup.md has adjusted the following from the original article. + +- Moved from Oracle Linux to Ubuntu LTS +- Moved some Optional Configuration topics to either their own pages within our KB / hyperlinked to existing documents (this prevents topic duplication). +- Ordering / Combining of steps in relation to EULA and port forwarding. + +--- + +### Additional Note + +While Oracle cloud is great, ARM CPUs will fall short in high-demand workloads when it comes to Minecraft servers. If you find yourself outgrowing the Oracle instance you can check out the following [hosting guide](/h/types). diff --git a/folder/fr/src/content/docs/hosting/bad-rep-providers.mdx.mdx b/folder/fr/src/content/docs/hosting/bad-rep-providers.mdx.mdx new file mode 100644 index 0000000000..353bc7ff76 --- /dev/null +++ b/folder/fr/src/content/docs/hosting/bad-rep-providers.mdx.mdx @@ -0,0 +1,6 @@ +--- +title: Bad Rep Hosts +description: A list of hosting providers that are considered 'summerhosts', reckless and just outright something you should avoid. +template: splash +slug: /h/bad-rep-providers +--- diff --git a/folder/fr/src/content/docs/hosting/hardware.mdx.mdx b/folder/fr/src/content/docs/hosting/hardware.mdx.mdx new file mode 100644 index 0000000000..5481009452 --- /dev/null +++ b/folder/fr/src/content/docs/hosting/hardware.mdx.mdx @@ -0,0 +1,52 @@ +--- +description: Picking the right hardware is the most important thing when it comes to hosting as it will determine how far you can push your ideas before you have to throttle back or risk destroying the user experience. +slug: h/hardware +title: Hardware +--- + +If you haven't identified the type of hosting you wish to go for it's highly recommended to read our [types of hosting](types) document first. + +:::note +The first point we want to stress is **do not go out and buy the latest flagship CPU for a single Minecraft server**. This is a complete waste of money and you will not be able to utilise the full CPU, you should however find a hosting provider that offers the desired CPU line up and use 'shared hosting'. +::: + +### CPU + +When it comes to finding a CPU (for Minecraft) the most important factor is the [IC](https://www.bbc.co.uk/bitesize/guides/z2342hv/revision/5), this consists of a fetch, decode, read and execute cycle all taking place to complete a single cycle. + +Depending on your workload, CPU Cache & Instruction Sets should also be considered as one CPU might be better at a particular set than another (it's important to complete your own research based on your needs). + +The myth of clock speed being the sole performance factor has been disproven many times over, Apple being the most famous example that often compared a lower clock speed PowerPC to the newer Pentium 3/4 line ups from IBM and similar. + +At its core Minecraft's main logic loop is a single thread this is a fundamental issue that dictates how it runs. Consequently, Minecraft is primarily concerned with single core performance. You still need at least two cores however, the second is to offload things like Garbage Collection and non core logic threads (networking, io) to so they don't steal time from the main loop. + +--- + +### RAM + +RAM is not nearly as important as people think, fast RAM is as important ([it's benefits only go as far as your chosen CPU](https://premiumbuilds.com/features/ryzen-ram-speed-benchmark-analysis/)) as the capacity and over capacity of RAM can hurt your performance (this is because the JVM garbage collector has more to collect and therefore this intensive CPU task takes longer causing lag spikes). + +The general consensus as of late 2022 is to start with using 4GB / 6GB but use no more than 12GB per individual server. + +Memory allocation and Java Flags go hand in hand with one another and some flags (specifically Aikar's) have some values that change based on the total RAM allocation to your server. + +If you're running in Docker consider overhead for the JVM, this should be about 1/2GB that you will need to compensate for (sometimes the host will take care of this step for you). + +--- + +### Storage + +For your server's live application data it's the current consensus to at least be using some form of flash storage as the random read/write speeds can help massively when it comes to users spawning in chunks all over the map. + +For backups you are still more than welcome to use spinning disks as this data hopefully isn't used as often - it's also possible to configure archival s3 based storage (cold-site) which could end up cheaper than buying and protecting your own disks. + +--- + +### Recommended Specs + +If you're looking for specific specs we'd recommend using the below as a baseline. + +| SKU | CPU | RAM | DISK | +| ---------- | --------------------------------------------------- | ---------- | ------------------------------- | +| Budget | Intel 9th - 12th Gen / Ryzen 9 3000 - Ryzen 7 5800X | 4GB - 6GB | 30GB (NVMe) | +| Enthusiast | Intel 13th & 14th Gen / Ryzen 9 5900X & 7000 Series | 8GB - 12GB | 75GB+ (NVMe) | diff --git a/folder/fr/src/content/docs/hosting/intro.mdx.mdx b/folder/fr/src/content/docs/hosting/intro.mdx.mdx new file mode 100644 index 0000000000..acbee77d6a --- /dev/null +++ b/folder/fr/src/content/docs/hosting/intro.mdx.mdx @@ -0,0 +1,22 @@ +--- +sidebar_position: 1 +description: The entry point for those looking to host a Minecraft server but don't know where to start. +slug: h +title: Where To Start +--- + +If you're looking to run a Minecraft server of your own there are multiple things you should consider. + +
    +
  • Where do you want to host it?
  • +
  • How do you want to host it?
  • +
  • Do you want the ability to be able to host more than Minecraft?
  • +
+ +Our goal is to cover all of this and offer our own recommendations on providers you can use for all possibilities, some key articles can be found below. + +| Topic | KB Article | Summary | +| ----------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| Service Offerings | [Types](types) | Identify what different types of hosting exist, what should be used and when. | +| Hardware | [Hardware](hardware) | The second most important decision is determining how powerful you need the hardware to be for the work you're wanting to push on it. | +| Providers | [CSPs](providers) | Non-biased recommendations for hosting providers based on previous experience and their industry position. | diff --git a/folder/fr/src/content/docs/hosting/os.mdx.mdx b/folder/fr/src/content/docs/hosting/os.mdx.mdx new file mode 100644 index 0000000000..f82b1b4301 --- /dev/null +++ b/folder/fr/src/content/docs/hosting/os.mdx.mdx @@ -0,0 +1,30 @@ +--- +description: Let's discuss the major operating systems that you will come across when hosting a Minecraft server. +slug: h/os +title: Operating Systems +--- + +When running a Minecraft server on [bare metal](/h/types/#bare-metal--vds), or a [VPS](/h/types#virtual-private-servers) you'll need to install a base operating system before you can get started. Unless you're running an apple device your options are Windows / Windows Server or Linux and the abundance of distros that come along with it. + +This page will explain the common choices available. + +
    +
  • Windows (Desktop and Server)
  • +
  • Ubuntu LTS
  • +
+ +### Windows + +If you're looking to host a server for your friends then the easiest option for self-hosting is Windows, you're already using it and if you're going to use a cloud provider for a server they will include a monthly fee for Windows Server. At their core both OSes are 'the same' and for Minecraft running a personal server within Windows 10/11 from your home PC will be fine. + +Moving to Windows Server will give you a couple of advantages, primarily longer OS support - these tend to follow a N+10 policy when discussing depreciation which is normally a good few years more than standard desktop releases. + +Windows Server OS is lighter out of the box and includes nothing but the core files needed to get Windows functional which compared to the desktop OS could see a perf gain with less resource wastage and can slightly reduce your attack surface by ensuring there are no little to none un-patched applications installed / configured. + +--- + +### Ubuntu LTS + +Unofficially you can also throw the base 'Debian' into this argument too however with Ubuntu Pro now becoming a free feature (for up to 5 devices) it's a huge win for the home lab. Ubuntu Pro offers 10 years of LTS patches so now follows a Windows Server like support plan which will save a lot of hassle needing to move your Instance from one release to another. + +If you want to get into the more professional side of hosting, Linux is the way to go - it's further optimised and will let you get the absolute most performance out of the hardware as possible. Day-to-day you will be interfacing with this OS through a command line but unlike Windows Server if you go to a CSP you won't be charged for these, web-based game management portals do exist for those on Linux who don't want to manage everything via the CLI. diff --git a/folder/fr/src/content/docs/hosting/panels.mdx.mdx b/folder/fr/src/content/docs/hosting/panels.mdx.mdx new file mode 100644 index 0000000000..a818326256 --- /dev/null +++ b/folder/fr/src/content/docs/hosting/panels.mdx.mdx @@ -0,0 +1,137 @@ +--- +description: You don't always want to be using the CLI to manage your server, consider a web panel and share the responsibility with your other administrators. +slug: h/ui +title: Panels +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you're running a Minecraft server the chances are you'll want an easier method of management, this is where panels come into play. Every [shared hosting](types#shared-hosting) provider will come with a control panel, this is how you'll interface with your server normally at a URL similar to https://panel.mydomain.com. Depending on how long the provider has been in business they'll either be using Multicraft or Pterodactyl (newer hosts using the latter). + +While Multicraft and Pterodactyl became the widely adopted platforms for Minecraft hosting this doesn't mean they're the only players in the game and with a VPS / Bare Metal you can install any one of a number of different solutions. We could write this article for the next six months documenting every single different panel and why it should be used but we're going to focus on a couple. + +The top 4 shortlisted panels this article will be covering are. + +
    +
  • AMP
  • +
  • Moonlight
  • +
  • Pterodactyl
  • +
  • PufferPanel
  • +
+ +### AMP Windows & Linux only + +AMP is a licensed panel produced by CubeCoders which supports both Windows and Linux including Ubuntu, Debian, Arch, Cent OS and more. CubeCrafters are by no means new to the hosting game, their previous product McMyAdmin launched all the way back in 2013. + +At this time there is **NO** Apple builds so for legacy McMyAdmin2 users this product may not be suitable for you unless you're running boot camp or run your servers on a different machine. + +#### Pros + +
    +
  • Community backed game contributions
  • +
  • Migration path for McMyAdmin2 users
  • +
  • One click/line installers
  • +
  • Proactive support
  • +
  • Support for many popular titles
  • +
+ +#### Cons + +
    +
  • Licensed
  • +
  • Multiple security requirements before installable (principle isn't a con but it's a pain)
  • +
  • Not open-source
  • +
+ + + + + + +--- + +### Moonlight Linux only + +Moonlight is an up and coming panel solution that is aimed towards those looking to replace Pterodactyl. The project is still in it's early phase and we've been pleased with the outcome so far in small scale testing and has therefore made our list as a one to watch. + +#### Pros + +
    +
  • Automatic plugin installer
  • +
  • Automatic SRV record creator
  • +
  • One click/line installers
  • +
  • Migration guide for Pterodactyl installs
  • +
  • Support for pterodactyl eggs (kind of)
  • +
  • Many more features constantly being added
  • +
+#### Cons +
    +
  • No billing support at this time
  • +
  • Lack of third party modifications
  • +
+ + + + + + +--- + +### Pterodactyl Linux only + +Multicraft had to die for Pterodactyl to breathe, an open source panel in active development and great support behind it. For those who like the sound of pterodactyl but not the self-hosting setup process you can look at the SaaS version [WISP](https://wisp.gg) which will cost you around $5 a month for the community plan. + +Pterodactyl boasts a two part setup, a web-server and a docker agent (wings) that only has official support for Linux. WSL has no official support same with Mac OS, you may find better luck utilising their 'panel-in-docker' and 'wings-in-docker' if you wish to attempt an install on either of these platforms. + +#### Pros + +
    +
  • ARM instruction set support
  • +
  • Billing integration for WHMCS / Blesta
  • +
  • Industry standard tool
  • +
  • Marketplaces for third party panel enhancements
  • +
+#### Cons +
    +
  • Complex multi-stage setup process
  • +
  • Setup support can be hit or miss (you're normally told to RTFM)
  • +
+ + + + + + + +--- + +### PufferPanel Linux only + +PufferPanel could have been the Pterodactyl industry standard tool today, a panel formerly developed by a Pterodactyl team member prior to a clashing of heads and a splitting of the product, however PufferPanel remains open source and in active development by the original founder and an long-time dev. + +The situation is the same for PufferPanel as it is for Pterodactyl, only has official support for Linux, however Windows builds are available (if unsupported). + +#### Pros + +
    +
  • One click/line installers via APT/YUM
  • +
  • ARM instruction set support
  • +
+ +#### Cons + +
    +
  • Lack of industry adoption / third party support
  • +
  • No billing modules
  • +
+ +:::note +PufferPanel (OSS Project) should not be confused with the proprietary puffer panel used by https://pufferfish.host, **these are two separate entities**. +::: + + + + + + diff --git a/folder/fr/src/content/docs/hosting/providers.mdx.mdx b/folder/fr/src/content/docs/hosting/providers.mdx.mdx new file mode 100644 index 0000000000..fbc621c431 --- /dev/null +++ b/folder/fr/src/content/docs/hosting/providers.mdx.mdx @@ -0,0 +1,207 @@ +--- +description: This page should be used as a reference to hosting providers and is not a substitute for their trustpilot and / or other clients real world experiences. +slug: h/providers +title: Providers +--- + +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +With the game becoming as big as it has done over the last decade there have been hundreds of hosting providers of past and present that either deliver high-quality services or awful services that someone could pay you enough to use daily. The goal with this page is to highlight a few trustworthy names in the Industry that meet the following criteria. + +
    +
  • Deliver to audiences at scale
  • +
  • Developed an overall positive reputation
  • +
  • Modernises hardware when required
  • +
  • Respectable end product for the price paid
  • +
+ +It should be made clear that none of the references below are sponsored. + +:::tip +If you don't know what kind of hosting you need, it's recommended to checkout the following article here to understand the different available platforms. +::: + +### Bloom.host + +Unparalleled price to performance with dedicated resources on high-end AMD Ryzen hardware and a bespoke customised version of the Pterodactyl panel. Bloom is also now a provider in the VPS and managed server solutions space across multiple regions. + +
    +
  • Locations: Ashburn, Dallas, Los Angeles, Miami, Falkenstein, Singapore (Performance+ plans only)
  • +
+ +#### Pricing + +
    +
  • Essentials MC 4GB: $10/month
  • +
  • Performance MC 8GB: $18/month
  • +
  • Performance+ MC 8GB: $24/month
  • +
+ + + +--- + +### EnviroMC + +EnviroMC is a quality Minecraft service provider that focuses on both the budget and high-end requirements of their customers, as of Sept. 19th 2022 URHOST clients will be absorbed into EnviroMC as part of a takeover agreement. EnviroMC also provides a VPS solution across the US, Europe and Asia. + +
    +
  • Locations: Falkenstein, New York, Singapore, Warsaw (VPS Only)
  • +
+ +#### Pricing + +
    +
  • Budget: $1/GB/month
  • +
  • Premium: $2.50/GB/month
  • +
  • Dedicated: See website for pricing
  • +
+ + + +--- + +### Hetzner GMBH + +It would be impossible to create a provider list and not include Hetzner, they currently stand as the German kings when it comes to high-end hardware at an ultra affordable price point. If you're running a large enough solution and just looking for the bare metal to run it on they should be food for thought. + +
    +
  • Locations: Ashburn (VPS Only), Falkenstein, Helsinki, Nuremberg (VPS Only), Vint Hill (VPS Only)
  • +
+ +#### Pricing + +
    +
  • Cloud Starting: €3.79/month
  • +
  • Dedicated Starting: €37/month
  • +
+ + + +--- + +### OVHCloud + +OVH, much like Hetzner, is a compute only provider meaning they specialise in Cloud services and Metal (the platform we use for Labs) + +
    +
  • Locations: Beauharnois, Frankfurt, Gravelines, London, Roubaix, Singapore, Strasbourg, Sydney, Vint Hill, Warsaw
  • +
+ +#### Pricing + +
    +
  • Cloud Starting: $3.50/month
  • +
  • Dedicated Starting: $56/month
  • +
+ + + +--- + +### MCHO.ST + +MCHO.ST is a hosting provider with both a free tier and a premium product, the latter using the Ryzen 8700G CPUs offering great price to performance with a brand new panel. + +
    +
  • Location: Nuremberg
  • +
+ +#### Pricing + +
    +
  • Free Tier: Free
  • +
  • 8700G Premium: £6.25/month
  • +
+ + + +--- + +### Pebblehost + +A long standing hosting provider that has modernised with the times offering a great budget service tier as well as offering tiers with additional performance those that require it. + +
    +
  • Locations: Coventry, Gravelines, Hillsboro, Montreal, Roubaix, Sydney
  • +
+ +#### Pricing + +
    +
  • Budget: $1/GB/month
  • +
  • Premium: $2.25/GB/month
  • +
  • Extreme: $2/GB/month (Min Order 6GB / 3 Threads)
  • +
+ + + +--- + +### WitherHosting + +A budget hosting provider with a global reach and an entry price point of 1$/GB utilising a range of both Ryzen and Xeon grade processors. + +
    +
  • Locations: Chicago, Dallas, Frankfurt, London, Los Angeles, Miami, New York, Singapore, Sydney
  • +
+ +#### Pricing + +
    +
  • Budget: $1/GB/month
  • +
  • Premium: $2/GB/month
  • +
+ + + +--- + +### Other Providers + +Yes, there are other great providers that haven't made our list for one reason or another - if you do decide to venture out and search for other providers some things we'd recommend you looking out for are + +#### Avoid These Things + +
    +
  • Don't use a host that makes you pay with a 'per-player slot' model - This is awfully dated and you should focus on resource based pricing instead
  • +
  • Don't use Mojang (Microsoft) Realms - This is an Azure backed platform designed for bedrock but also has Java presence, in the long run you will not have an enjoyable experience
  • +
  • Don't use a host that appears on a 'drama site' / forum - Hosts that make these lists tend to be awfully run and you'll have a bad time with them
  • +
+ +#### Look For These Things + +
    +
  • Do your own research, check the companies TrustPilot reviews etc to get an understanding of how the customers feel
  • +
  • Look for hosts that advertise hardware components and don't make you dig through pages of docs to get the information
  • +
  • Check the providers status page for a better understanding of reliability
  • +
+We'd also recommend you ensure your chosen provider hasn't ended up on our list of 'Summerhosts' + +
+ If in doubt ASK! Measure twice and cut once. diff --git a/folder/fr/src/content/docs/hosting/self.mdx.mdx b/folder/fr/src/content/docs/hosting/self.mdx.mdx new file mode 100644 index 0000000000..961a9fca34 --- /dev/null +++ b/folder/fr/src/content/docs/hosting/self.mdx.mdx @@ -0,0 +1,31 @@ +--- +description: So you want to host a Minecraft server yourself? Checkout your options and find the solution that suits your requirements. +slug: h/self +title: Self Hosting +--- + +When it comes to running everything yourself you have two options + +
    +
  • Rent hardware / compute in the 'cloud'
  • +
  • Provide your own hardware and run at a data centre / your house
  • +
+ +### Option 1 + +If you can afford it, this is your better option. While this is the most expensive option your monthly bill does include hardware, electricity, internet and in some cases ddos protection. A mid-range to high end service will cost you anywhere from 100$ per month in this regards so may not be suitable for those who don't already have an established community, we discuss this option a in a bit more depth [here](/h/types#bare-metal--vds). + +--- + +### Option 2 + +The cheapest option but is does require some additional thought however for one or two people this option may still make the most sense. + +
    +
  • Do you have a suitable internet connection? Firstly run a speed test, this will give you an idea of where your current connection sits. A 50mbps connection for both upload and download should be sufficient for your regular household activities **and** your Minecraft server, remember your connection is shared between all devices so downloading something on your internet e.g. steam games will reduce the available connection to Minecraft.
  • +
  • Do you have proper IPv4 addresses? Yes, Minecraft *can* support IPv6 but it requires all parties involved to also support V6 connectivity. You also need to consider if you have a [static IPv4 address](/ts/ip).
  • +
  • Have you considered the overhead to security, power utilisation, heat generated, noise produced and cost of hardware? Protecting the rest of your network can cost you either in man-hours or hardware if you need to purchase additional tools to get operational. This should all be considered before you commit to running things from home.
  • +
  • 24/7 Availability? If you're not prepared to run a server 24/7 from your home are you players happy with the fact a server will only be online for a few hours a day.
  • +
+ +If you do want to host things yourself we have documentation on how to do such things [here](/guides/self-host). diff --git a/folder/fr/src/content/docs/hosting/summerhosts.mdx.mdx b/folder/fr/src/content/docs/hosting/summerhosts.mdx.mdx new file mode 100644 index 0000000000..7e1d45292a --- /dev/null +++ b/folder/fr/src/content/docs/hosting/summerhosts.mdx.mdx @@ -0,0 +1,70 @@ +--- +title: Summerhosts +description: Summerhost - A service provider that is poorly ran and/or operating illegally which should be avoided. +slug: h/summerhosts +--- + +The term "Summerhost" is used for service providers that are poorly ran and/or operating illegally which should be avoided, below is a list of characteristics that will end you up on our avoid list. + +:::note + +For hosting providers that meet the requirements below but are not already on the list you can [submit an issue on GitHub](https://smd.gg/summerhost-addition). Providers that no longer meet the criteria defined below can request removal using [this link](https://smd.gg/summerhost-removal) + +Disclaimer: Information was accurate at the time of publication and may not reflect any recent changes we've not been made aware of. The list of providers below should be used as a reference point. This page mostly relies on publicly available information published by listed providers (and information that is not public will be displayed on this page). +::: + +### Avoid providers that feature the following: + +
    +
  • Businesses that do not contain contact details (ex. email & phone)
  • +
  • Website with false or missing information
  • +
  • Improper billing (discord checkout etc)
  • +
  • No Terms of Service or Privacy Policy
  • +
  • No SLA ("Service Level Agreement")
  • +
  • Oversold servers
  • +
  • Deceptive sales
  • +
  • Rigged reviews (ex. review rewards)
  • +
  • Obstructive Terms of Service that disallows doing basic stuff within the server (ex. pregenning)
  • +
  • Lack of basic features such as databases and backups
  • +
  • Pirating software used on the provider (ex. "nulled" WHMCS and other software)
  • +
  • Violating other project's rights (ex. selling licensed software without authorization)
  • +
  • GSP (Game Server Providers) that sell preconfigured FiveM servers (excluding Zap Hosting)
  • +
+ +#### Sources & Useful Tools: + +
    +
  • FiveM Documentation: https://docs.fivem.net/docs/support/ban-faq/#unauthorized-game-server-provider-gsp
  • +
  • FiveM Terms of Service: https://fivem.net/terms (5.8. Authorized & Unauthorized Services)
  • +
  • WHMCS License Checker: https://www.whmcs.com/members/verifydomain.php/verifydomain.php
  • +
  • Blesta License Checker: https://account.blesta.com/client/plugin/license_verify
  • +
+ +### Here is a list of providers that you should avoid with reasoning: + +| Provider | Reason | +| -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [ThunderNodes](https://thundernodes.cloud) | Improper (discord) checkout | +| [Luxe Hosting](https://my.luxe-hosting.nl) | No publicly available Terms of Service, Privacy Policy and SLA, missing publicly available information (regarding hardware), unauthorized GSP selling FiveM servers | +| [Proxynode](https://proxynode.pro) | No publicly available SLA | +| [Vellias Hosting](https://velliashosting.online) | No publicly available SLA & Privacy Policy, unauthorized GSP selling FiveM servers | +| [Lunes Hosting](https://lunes.host) | No publicly available SLA, missing publicly available information (regarding hardware), Terms of Service is a template (termly.io) | +| [Foxomy](https://foxomy.com) | Terms of Service that requires you to `"Identify as Black, Indigenous, Latino, Hispanic, Asian, Pacific Islander, or a Person of Color."` | +| [Crystallized Hosting](https://crystallized.host) | Missing publicly available information (regarding hardware) | +| [The Minecraft Hosting](https://theminecrafthosting.com) | Missing publicly available information (regarding hardware), no publicly available Privacy Policy & SLA | +| [Evix Datacenter](https://evix-datacenter.online) | No publicly available Privacy Policy & SLA, official account threatening to DDoS people ([1](https://smd.gg/lkn5vtl), [2](https://smd.gg/54owa1o), [3](https://smd.gg/flsgxnu), [4](https://smd.gg/x0omgfm), [5](https://smd.gg/mdp5sul)), official discord account using slurs ([1](https://smd.gg/fenwcql), [2](https://smd.gg/7p9co2m)) | +| [Skytale Hosting](https://billing.skytalehosting.net) | No publicly available Terms of Service, Privacy Policy & SLA, unauthorized GSP selling FiveM servers | +| [BlackNode](https://blacknode.pro) | [Bulletproof](https://www.urbandictionary.com/define.php?term=Bulletproof%20hosting) provider that promotes themselves for spoofed & bulletproof servers and botnets & DDoS tools | +| [Boundless Hosting](https://boundlesshosting.xyz) | No publicly available Privacy Policy, unauthorized GSP selling FiveM servers | +| [SpaceNode Hosting](https://spacenodehosting.com) | No publicly available Terms of Service, Privacy Policy & SLA, missing publicly available information (regarding hardware), unauthorized GSP selling FiveM servers | +| [PSB Hosting](https://psb.hosting) | [Bulletproof](https://www.urbandictionary.com/define.php?term=Bulletproof%20hosting) provider that promotes themselves for DMCA ignorant & bulletproof servers | +| [Realms Hosting](https://realmshosting.com) | Unauthorized GSP selling FiveM servers | +| [RAPIDHost](https://rapidhosting.cloud) | Unauthorized GSP selling FiveM & RedM servers, hardware information is unspecific (different processors in the "Xeon E-series" can have noticeable performance difference) | +| [proxied.host](https://proxied.host) | No publicly available Privacy Policy & SLA | +| [Nyxiality Hosting](https://nyxialityhosting.com) | No publicly available Terms of Service, Privacy Policy & SLA, missing publicly available information (regarding hardware) | +| [EmpireNodes Hosting](https://www.empirenodes.com/) | [Rigged reviews](https://www.trustpilot.com/review/empirenodes.com), no Privacy Policy | +| [Cosmic Hosting](https://cosmichosting.xyz) | No publicly available Terms of Service, Privacy Policy & SLA, unauthorized GSP selling FiveM servers | +| [HostSpace](http://hostspace.co.il/) | Improper (discord) checkout, missing publicly available information (regarding hardware) | +| [Tegra Hosting](https://tegra.gg/) | Fallback company made by ZTX, the companies lost data several times had their nodes suspended. | +| [Springracks](https://springracks.com) | Obstructive Terms of Service that disallows `running any task that will completely cap out the CPU limit set on your service` (What if there's just high load on your Minecraft server? Who knows!) | +| [EmpireNodes](https://empirenodes.com) | No Privacy Policy, Terms of Service that disallows `"Saying we are using fake ram"`, `Beg for new nodes` | diff --git a/folder/fr/src/content/docs/hosting/tls.mdx.mdx b/folder/fr/src/content/docs/hosting/tls.mdx.mdx new file mode 100644 index 0000000000..5111d1254a --- /dev/null +++ b/folder/fr/src/content/docs/hosting/tls.mdx.mdx @@ -0,0 +1,52 @@ +--- +sidebar_position: 2 +description: Identifiy the different tools available that can be used to help you deploy SSL certificates. +slug: h/ssl +title: TLS +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you're hosting more than just your Minecraft server, maybe you're using a Map service / forum / server store an SSL / TLS certificate is an absolute must. + +### Web Services + +If you're accessing the service via a web-browser then this part of the page will be for you, this will not cover successful deployment tutorials - we may decide to include this at a later time. + +#### Cloudflare + +This is the easiest solution to adding TLS capabilities to your website as Cloudflare can operate as a reverse proxy for the traffic allowing the SSL to terminate at their edge network and transit back to your origin server over HTTP (full SSL to origin is also supported). + + + +#### Caddy + +A self-hosted solution similar to Cloudflare but without the additional DDoS protection. Caddy supports automatic SSL deployment from any ACME provider on the market and is our provider of choice in conjunction with ZeroSSL. + + + +--- + +### Linux + +This is for tools suitable for generating certificates but perhaps might not be solely for web-servers. + +#### Certbot + +Certbot is a tool that can be deployed either as a Snap package or a Python module and is designed purely for generating valid Let's Encrypt certificates. The certificates generated from Certbot do not need to solely be used in a Web-Server and can be used system wide. + + diff --git a/folder/fr/src/content/docs/hosting/types.mdx.mdx b/folder/fr/src/content/docs/hosting/types.mdx.mdx new file mode 100644 index 0000000000..b5b659bff1 --- /dev/null +++ b/folder/fr/src/content/docs/hosting/types.mdx.mdx @@ -0,0 +1,60 @@ +--- +description: Understand the different types of hosting services available and what may be the best fit for your project. +slug: h/types +title: Types of Hosting +--- + +When you start looking at hosting your server online you'll see many different answers of which none are wrong, but they're not always suited to your needs. This page has a goal of helping you identify when you may need each type of hosting. + +The three most common types you'll find in forum responses are: + +
    +
  • Shared Hosting
  • +
  • Virtual Private Servers (VPS)
  • +
  • Dedicated Servers (Bare Metal / VDS)
  • +
+ +### Shared Hosting + +The most common type you'll find is 'Shared Hosting', this is where a hosting provider will own a physical server and partition the resources out to clients and you will connect to / manage your server via a [web panel](/h/ui) and SFTP. If you select this style of hosting you should be careful and note that some providers will oversell the resources. Overselling allows for them to provide cheaper monthly plans but may come at a performance hit due to this over allocation. Others will provide a dedicated quota that is only allocated to yourself, this will be slightly more expensive but you will have the entire quota to your disposal whenever you need it (plus it will still be cheaper than a VPS / Bare Metal). + +Traditionally this space was dominated by the likes of Nitrado, MCProHosting, Shockbyte etc... but in recent years players like [Bloom](https://bloom.host), [DedicatedMC](https://dedicatedmc.io) & [EnviroMC](https://enviromc.host) have dominated in this space offering Ryzen based solutions instead of the old school Xeons used by the legacy giants. + +--- + +### Virtual Private Servers + +The other common response you'll see people mention is 'grab yourself a VPS from Digital Ocean or Linode'. While you certainly can, it won't be much better than using [oracle cloud](/guides/oracle-cloud) on ARM (which is free). + +VPS instances have some differences to shared hosting, the core differences are. + +
    +
  • Linux knowledge is required for setup
  • +
  • Patching becomes your responsibility
  • +
  • Shell access which allows you to run more than just Minecraft servers
  • +
  • Slower but higher core count CPUs
  • +
  • You get a Dedicated IP address rather than a Shared one
  • +
  • You can install a custom panel such as [Pterodactyl](/h/ui#pterodactyl)
  • +
+There are times when a VPS can make sense, a prime example is using a VPS provider that uses consumer 'Gaming Grade' CPUs (Intel Core i9 / AMD Ryzen 7 / 9). These would provide the same experience for Minecraft as using a regular 'shared hosting' provider and it would allow you to host say a web / database server, a discord bot or anything else you could imagine. + +--- + +### Bare Metal / VDS + +The final common type of hosting you'll see people mention is, "go all out and own your hardware". While yes, this has some advantages for a novice the prospect of having no one around for support can be unsettling. Bare metal gives you full, dedicated, system normally in 32 / 64 or 128 GB RAM configurations with 256 / 512 or multi-TB disk configs. Bare metal can either be built yourself and shipped to a data centre for a monthly fee or you can rent from providers such as Hetzner, OVH or ReliableSite for a monthly fee. This option can set you back multiple hundreds of dollars per month and would only be recommended for larger scale deployments. + +Bare metal has a few advantages over the other types of solutions such as. + +
    +
  • Complete ownership of the server data
  • +
  • Complete ownership of physical and networking resources
  • +
  • Some providers will offer a managed solution for an additional fee
  • +
+Bare metal also carries the same differences to shared hosting as a VPS. + +:::tip + +If you don't already know what level of hardware you should be looking at then please consider reading our [hardware guide](hardware) first, then once you know what hardware and solution you're looking for head on over to our [recommendation page](providers) for vendors that can deliver what you're looking for. + +::: diff --git a/folder/fr/src/content/docs/index.mdx.mdx b/folder/fr/src/content/docs/index.mdx.mdx new file mode 100644 index 0000000000..be7147a922 --- /dev/null +++ b/folder/fr/src/content/docs/index.mdx.mdx @@ -0,0 +1,34 @@ +--- +title: Minecraft Admin Wiki +description: We're setup.md, the Minecraft administration wiki, written by enthusiasts and targeted to the novice. +template: splash +hero: + tagline: Your home of good information written by enthusiasts for the novice Minecraft server owner. + image: + file: ../../assets/houston.webp + actions: + - text: View the docs + link: /docs + icon: right-arrow + variant: primary + - text: Visit us on Github! + link: https://smd.gg/repo + icon: external +--- + +import { Card, CardGrid } from '@astrojs/starlight/components'; + + + + Behind the scenes our wiki has lost some weight as is built on the fastest framework to date! + + + Version 3 of the wiki launches with a focus on improving contribution requirements. + + + With V3 we now have the functionality to implement translations following the i18n standard. **SOON!** + + + We're still backed by the amazing members of the [Admincraft](https://smd.gg/acdiscord) community. + + diff --git a/folder/fr/src/content/docs/information/discord.mdx.mdx b/folder/fr/src/content/docs/information/discord.mdx.mdx new file mode 100644 index 0000000000..b9b210e8cc --- /dev/null +++ b/folder/fr/src/content/docs/information/discord.mdx.mdx @@ -0,0 +1,36 @@ +--- +description: We have a Discord server, check out the basics here. +title: Discord Server +slug: discord +--- + +All project contributors are volunteers and will carry the `project contributor` role within our server. + +Those that carry the `project lead` role are the core representatives of the project and should be the ones who are consulted on any issues within. + +A permanent invite to our server can be found here. + +### Ground Rules + +As with any public server, there are some rules that need to be followed. + +
    +
  • Be kind to one another
  • +
  • Don't be an ass, no one is paid to deal with your poor behaviour
  • +
  • Don't post any NSFW content
  • +
  • Follow the Discord community guidelines
  • +
  • Follow the Discord terms of service
  • +
+ +--- + +### Server Roles + +A brief overview of important roles within our server and how they are obtained. + +| Roles | Description | +| :------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Project Lead | This is a role that is reserved for first-party members of the project. | +| Project Contributors | Anyone who has submitted work for the Github repository is eligible for this role, you should have your Github account linked to your Discord account and publicly visible. | +| Community Nerds | People who have shown significant knowledge in areas and support the community without being a wiki contributor. | +| Sponsors | This role is automatically assigned to anyone who sponsors the project. (This role is not currently obtainable) | diff --git a/folder/fr/src/content/docs/information/eula.mdx.mdx b/folder/fr/src/content/docs/information/eula.mdx.mdx new file mode 100644 index 0000000000..42484d52c5 --- /dev/null +++ b/folder/fr/src/content/docs/information/eula.mdx.mdx @@ -0,0 +1,29 @@ +--- +description: Helping you navigate through the latest changes to Mojang's EULA. +slug: eula +title: Minecraft EULA +lastUpdated: 2023-08-02 +sidebar: + order: 4 + badge: + text: Important + variant: danger +--- + +If you're new to hosting a Minecraft server you should probably become familiar with what the EULA and CUG actually are. In short they're a scope of principles Mojang would like your server to adhere to at all times if you don't want it blacklisted at auth server level, these policies can change at any time and more often than not aren't published to Mojang's official channels e.g. Twitter. + +### Changes + +The following additional changes have been made which will affect the most amount of servers since the huge enforcements in 2014. + +
    +
  • All servers are now required to be suitable for all ages
  • +
  • All servers are now required to disclose their non-affiliation with Mojang and/or Microsoft
  • +
  • All servers are now required to implement their own ToS before a player is allowed to play
  • +
  • All players are now required to check back to the EULA on their own accord and players will not be updated of the change
  • +
  • Anything from non-commercial blogs, servers, community forums, fan sites, fan clubs, news groups, events, and gatherings are now deemed as commercial and must follow the CUG even if it will never make money
  • +
  • Mojang now has complete control over all forms of Minecraft content on online platforms
  • +
  • Mojang now has control over the term 'Minecraft' in creative content (YouTube, Twitch etc.) which may result in content removal
  • +
  • Mojang has the authority to grant or revoke permissions and consents at their discretion if they deem it appropriate or dislike what players are doing
  • +
  • Mojang has now outlawed the use of out-of-game mechanics to limit access to your Minecraft server e.g. queue based platforms in addition to gatekept content
  • +
diff --git a/folder/fr/src/content/docs/information/releases.mdx.mdx b/folder/fr/src/content/docs/information/releases.mdx.mdx new file mode 100644 index 0000000000..9bb709cfbc --- /dev/null +++ b/folder/fr/src/content/docs/information/releases.mdx.mdx @@ -0,0 +1,26 @@ +--- +description: Every major Minecraft release, it's required Java version and noticable changes. +slug: release +title: Release Tracker +lastUpdated: 2023-12-10 +sidebar: + order: 3 +--- + +This page aims to cover the latest information for Java tracking the required Java builds and fork compatibility. + +| Major Release | Revision Version | Java Support | PaperMC Build | Purpur Build | +| ------------- | ---------------- | ---------------- | ------------- | ------------ | +| 1.21 | 0 | Java 21 | ✔ | ✔ | + +If you come back to this page at a later date in time and you cannot see a build for the newest release check one of the following links for updates: PaperMC Github or PurpurMC Github + +### Notable Changes + +
    +
  • Added new structures
  • +
  • Added new mobs
  • +
  • Added new weapon
  • +
+ +A full change log can be found here: https://www.minecraft.net/en-us/article/minecraft-java-edition-1-21 diff --git a/folder/fr/src/content/docs/information/services.mdx.mdx b/folder/fr/src/content/docs/information/services.mdx.mdx new file mode 100644 index 0000000000..0a50ac405d --- /dev/null +++ b/folder/fr/src/content/docs/information/services.mdx.mdx @@ -0,0 +1,57 @@ +--- +description: Additional resources that are hosted by the setup.md team. +title: Additional Services +slug: services +lastUpdated: 2024-04-01 +sidebar: + order: 2 +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +As time has progressed we've continued to identify ways we can help server owners get up and running, setup.md has launched some additional services to help make your life easier. + +### Asset Hosting + +We launched a file sharing platform that can be used to share assets quickly with your communities, host resource packs for your server and even create 'link-in-bio' style pages to help bring your community together. + +#### Features + +
    +
  • 100MB file upload limit
  • +
  • Custom domain support premium
  • +
  • URL Shortener
  • +
+ + + + + + +--- + +### Server Jar API + +We took a cool idea produced by PenguiLoader on Github and we fixed some bugs then made it faster by distributing the workload to Cloudflare workers and running it on their amazing edge network. + +#### Quickstart + +The base domain is `https://jar.smd.gg` + +The subsequent URL that follows is syntaxed as below. + +`/download/{SOFTWARE}/{VERSION}/{BUILD}` + +To grab the latest paper .jar download. + +`GET https://jar.smd.gg/download/paper/latest/latest` + +To grab the latest vanilla server.jar download link. (no build parameter required) + +`GET https://jar.smd.gg/download/vanilla/latest` + + + + + diff --git a/folder/fr/src/content/docs/jarapi.mdx.mdx b/folder/fr/src/content/docs/jarapi.mdx.mdx new file mode 100644 index 0000000000..c82306823e --- /dev/null +++ b/folder/fr/src/content/docs/jarapi.mdx.mdx @@ -0,0 +1,18 @@ +--- +title: JAR API +description: An API to easily grab popular Minecraft server software. +template: splash +slug: service/jar-api +hero: + tagline: An API to easily grab popular Minecraft server software. + image: + file: ../../assets/javaicon.png + actions: + - text: Source Code + link: https://smd.gg/api + icon: github + variant: primary +--- + +import MainStatusPill from '../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; diff --git a/folder/fr/src/content/docs/mchost.mdx.mdx b/folder/fr/src/content/docs/mchost.mdx.mdx new file mode 100644 index 0000000000..aa93e9225f --- /dev/null +++ b/folder/fr/src/content/docs/mchost.mdx.mdx @@ -0,0 +1,21 @@ +--- +title: MCHO.ST +description: The free Minecraft hosting solution, sponsored (in-part) by the setup.md wiki. +template: splash +slug: service/mcho.st +hero: + tagline: The free Minecraft hosting solution, sponsored (in-part) by the setup.md wiki. + image: + file: ../../assets/mchost.webp + actions: + - text: Game Panel + link: https://my.mcho.st + icon: external + variant: primary + - text: Join our Discord! + link: https://mcho.st/discord + icon: discord +--- + +import MainStatusPill from '../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; diff --git a/folder/fr/src/content/docs/tools/database.mdx.mdx b/folder/fr/src/content/docs/tools/database.mdx.mdx new file mode 100644 index 0000000000..d3b23510f2 --- /dev/null +++ b/folder/fr/src/content/docs/tools/database.mdx.mdx @@ -0,0 +1,41 @@ +--- +description: This page covers centralised plugin data storage using databases. +slug: t/database +title: Databases +--- + +Before you go and implement a database you should first understand what a database can help to achieve, this will ensure that you're not burning time unnecessarily deploying things you don't need. + +### Why use databases + +Databases are used for centralised storage with unrestricted limitations to read, write new data and modify existing data. Storing data in a database can also be efficient, decreases time for looking up data that you can export into another application / format without significant difficulty. + +--- + +### Common database types + +If you're hosting a server the most common types of databases you'll be interacting with are 'SQL' based. This will most likely be one of the following solutions: + +
    +
  • MySQL (Legacy project)
  • +
  • MariaDB (Modern MySQL fork)
  • +
  • MSSQL (The Microsoft edition of MySQL)
  • +
+From an end user perspective all database types will produce a `.sql` file when exported and can be maintained through a common interface like phpMyAdmin, Adminer or MySQL Workbench. + +:::tip + +You should also be able to move your databases between all three without any major difficulties but this may depend on implementation +::: + +--- + +### When to use a database + +In a Minecraft environment you're most likely going to come across databases in a 'Network' environment e.g. when you're using a tool such as ['Velocity'](/t/server-software#velocity), or ['Bungee'](/t/server-software#bungeecord), this will allow you to share information between your backend servers and have one consistent dataset e.g. economy balances, synced ranks and permissions etc just to name a few examples. + +If you're running a server with a hosting provider they too will most likely give you the ability to create databases for your plugin data, if you're limited on local disk space using SQL for plugin data may off-lift some local capacity constraints. + +:::note +If you're looking to deploy your own Private SQL instance, you can follow a tutorial such as the one on the [Digital Ocean community forums](https://www.digitalocean.com/community/tutorials/how-to-install-mysql-on-ubuntu-22-04) that covers installation, configuration and securing your instance. +::: diff --git a/folder/fr/src/content/docs/tools/offline-mode.mdx.mdx b/folder/fr/src/content/docs/tools/offline-mode.mdx.mdx new file mode 100644 index 0000000000..87deae162d --- /dev/null +++ b/folder/fr/src/content/docs/tools/offline-mode.mdx.mdx @@ -0,0 +1,40 @@ +--- +slug: t/offline +description: What is offline mode and what are the implications? +title: Offline Mode +--- + +Offline mode is a legacy feature of Minecraft servers that disables the requirement for Mojang user authentication, allowing cracked Minecraft clients such as TLauncher et al. to join. +It can be set by either passing the `--singleplayer` flag to the server jar or setting `online-mode=false` in server.properties. However, there are several risks, legal and especially security, which will be covered on this page. + +### Reasons not to use offline mode + +#### Security Risks + +Due to the lack of authentication required on an offline mode server, anyone can use any username to log in - this especially comes into play when players join as certain names to either gain operator permissions or to relentlessly evade bans. + +AuthMe is a plugin for Bukkit servers that coats an insecure offline mode server with a thin veil of 'authentication', which partially mitigates these vulnerabilities at most - however, other plugins or mods still may provide operator access. +Such authentication plugins may prove an annoyance to players, an incentive to use weak passwords which then can be hacked into by malicious players - completely destroying the objective of these plugins. + +#### Software Issues + +Using offline mode on your server may also cause plugins that rely on UUID lookup to break - each 'account' has its own unique UUID, which can cause issues breaking many mods or plugins. + +When switching between modes, this becomes even more of an issue - plugins will have stored data in one format, and changing from online to offline or vice-versa will make them default to the respective format and effectively break all existing user data + +#### Legal Implications + +Offline mode (cracked) servers are commonly a breeding ground for piracy of Minecraft, which may constitute a violation of their EULA, specially their [One Major Rule](https://www.minecraft.net/eula#one-major-rule). +This may prove a problem for larger servers, as Mojang may blacklist clients from connecting to them for common EULA violations such as pay-to-win mechanics et al. + +--- + +### Valid Use Cases + +However, there are a few valid use cases in which offline mode can be used without such implications. They will be listed below: + +
    +
  • Proxies such as BungeeCord and Velocity which require backend servers to have online mode disabled - the proxy must have online mode enabled for this to count
  • +
  • Offline local-hosted environments which lack internet access, assuming everyone owns a Minecraft account otherwise
  • +
  • Local-hosted development servers for testing plugins and mods
  • +
diff --git a/folder/fr/src/content/docs/tools/server-software.mdx.mdx b/folder/fr/src/content/docs/tools/server-software.mdx.mdx new file mode 100644 index 0000000000..c5ca3c19db --- /dev/null +++ b/folder/fr/src/content/docs/tools/server-software.mdx.mdx @@ -0,0 +1,189 @@ +--- +slug: t/server-software +description: This page covers a list of well known server.jars. +title: Server Software +lastUpdated: 2024-03-27 +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +When creating a server there are multiple different names you will come across. Each server software has its own uses. + +Server Software is very often referred to as "Server Jar(s)". + +:::note +A "Fork" is a modified version of server software. These often share the same codebase and will sometimes patch in their own changes on top of the previous projects' code. An example of "forks" is something such as "Bukkit > CraftBukkit > Spigot > Paper > Purpur". +::: + +### Backend Servers + +There are hundreds (if not thousands) of different forks. This document will only include the recommended, stable, widely-used ones. + +#### Vanilla No Plugin Support + +As the name suggests, it is a completely Vanilla server from Mojang itself without any modifications. Great for those who want to host a small server for a couple of friends without altering any mechanics, but definitely not good for large servers. + + + +#### Paper Recommended + +Paper is the most widely-used Server Jar nowadays. A fork of Spigot with its own API, numerous optimizations alongside tons of glitch/dupe fixes make Paper the main choice for most server owners. + + + +#### Purpur + +A fork of Paper which provides numerous gameplay-enhancing features without having to download/create plugins. These include being able to adjust gameplay behaviors not seen in Paper, mob health, and more. Only has a couple of optimization options, but it does allow you to toggle some dupes. + + + +#### Pufferfish + +A fork of Paper which greatly improves performance without causing any noticeable impact to gameplay. Includes hopper, entity, map rendering and many other optimizations. Highly recommended for most servers. + + + +#### Folia + +A fork of Paper which groups nearby loaded chunks to form an "independent region." Each independent region has its own tick loop, which is ticked at the regular Minecraft tickrate (20TPS). The tick loops are executed on a thread pool in parallel. There is no main thread anymore, as each region effectively has its own "main thread" that executes the entire tick loop. + +:::caution + +#### Yes, Folia is relatively usable. + +Do you need to use it? Highly unlikely. Can you use it? Probably. Will a good chunk of your plugins break? Definitely. It's currently only recommended for very large servers that are vanilla/semi-vanilla, have a beefy enough CPU and enough threads as well. If you do end up using it, make sure to test it thoroughly. If you can, consider implementing some patches from Pufferfish and other jars as well. + +**Every command and feature should be tested.** +::: + + + +#### Legacy 1.8 Jars + +It is highly recommended that you do not use 1.8 or any of its other releases. However, if it's a requirement for whatever reason these are the better jars to use. + + + + + + + + + +#### Forge + +Forge is a modding API and server jar. It is most commonly used for servers with large modpacks. However, it is not very optimized and can suffer from poor performance. + + + +#### NeoForge + +NeoForge is a fork of the Forge project with almost all of the original team [excluding LexManos](https://neoforged.net/news/theproject/), made to fix its community issues and to provide better support to modders and later versions of Minecraft. + + + +#### Fabric + +Fabric is another modding API and server jar. Fabric mods are able to change practically any mechanics of the game, is more lightweight compared to Forge, and generally performs better than vanilla thanks to the wide range of optimization mods avaliable such as Lithium, Starlight, ModernFix etc. Take a look at [this list](https://github.com/NordicGamerFE/usefulmods). + + + +--- + +### Proxies + +Proxies are used to connect multiple regular servers (such as Paper servers) together. These are what power "networks" and are used by servers which have multiple gamemodes separated in their own subservers. I.E. Survival, Minigames, Prison, etc. all in one "server". + +#### Velocity + +A more recent project, now run by the Paper developers. Velocity uses its own API, meaning it does not work with Bungeecord / Waterfall (Unless you use [SNAP!](https://forums.papermc.io/threads/snap-run-bungeecord-plugins-on-velocity.31/), which allows you to use Bungeecord plugins on Velocity. Not recommended, though.) + +Velocity is a superior solution compared to Bungeecord / Waterfall unless you're hosting older than 1.13 servers but many developers haven't added Velocity support to their plugins. + + + +#### Waterfall + +A fork of Bungeecord run by the Paper developers, Waterfall supports most if not all Bungeecord plugins. It also comes with a couple of networking optimizations. + + + +:::caution +The PaperMC team have announced that Waterfall has now reached end of life in favour of Velocity. You can read the full announcement here - https://smd.gg/waterfall-eol. We will remove this option from our wiki in the coming months. +::: + +--- + +### Geyser Standalone + +Functioning almost exactly like the Geyser plugin, Geyser Standalone allows you to take load off of your main proxy/backend instance. It also supports auto-updating on Pterodactyl (assuming that you're using the Geyser Standalone egg). Recommended for servers that have higher player counts. + +If you're using Pterodactyl, consider using the [Geyser Standalone Egg](https://github.com/GeyserMC/pterodactyl-stuff). After installation, simply set "remote" in the config.yml of Geyser Standalone to the IP of the proxy/backend server & add Floodgate-Spigot & Floodgate-Velocity/Bungeecord to the spigot and proxy instances respectively. + +Geyser Standalone also allows you to connect to servers that you do not own. However, this is not recommended as it will more than likely lead to a swift ban from the anti-cheat. + + + +--- + +### Interesting Projects + +There are sometimes cool spin-offs that we feel are worthy of mentioning their existance, please note they may no longer be in active development at the time you're viewing this article. + + + + + + +:::danger + +#### Avoid any Jar that combines Plugins & Mods + +Do not use any hybrid server software such as Magma or Mohist. These are generally unstable. [Mohist also replaces EssentialsX jars with modified jars](https://essentialsx.net/do-not-use-mohist.html), which might not be safe. + +::: diff --git a/folder/fr/src/content/docs/tools/signed-chat.mdx.mdx b/folder/fr/src/content/docs/tools/signed-chat.mdx.mdx new file mode 100644 index 0000000000..6374dafbd1 --- /dev/null +++ b/folder/fr/src/content/docs/tools/signed-chat.mdx.mdx @@ -0,0 +1,147 @@ +--- +description: 1.19.1 overhauled the current reporting features and therefore caused a lot of panic, this page is written to cut through the misinformation and provide the facts. +title: Signed Chat +slug: t/signed-chat +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard } from '@astrojs/starlight/components'; + +First things first, it's important to set the story straight. Mojang had always had a reporting toolset for anyone who wished to use it however with the introduction of 1.19.1 changes were made to this system that a reasonable portion of the community didn't like. + +This patch specially introduces a couple of new features being: + +
    +
  • In-Game UI reporting
  • +
  • Cryptography and signing
  • +
+ +The purpose of this page serves as an advisory for those who wish to understand further what this means and what options are available to them. + +--- + +### How does it work + +This is accurate to the best of our abilities, if there is someone with a better understanding of cryptography that can help improve this page please submit a PR. + +#### Technical aspects + +These new keys are stored in .json format under the '%appdata%/.minecraft/profilekeys' folder on your PC. + +:::note +These keys are regenerated after 48 hours +::: + +The 'process' now works as follows: + +
    +
  • User opens up their Minecraft client
  • +
  • Check for keys / generation of new keys occurs if required
  • +
  • User launches Game
  • +
  • User joins their desired Minecraft server
  • +
      +
    • On join the client also makes it's public key available to the server
    • +
    +
  • User sends a message in chat
  • +
      +
    • Client signs the message using the private key providing a level of authenticity
    • +
    • Signed message is sent to the server
    • +
    • Server can validate the message came from your client using your public key
    • +
    • Server displays the chat messages
    • +
    +
+ +Every time a message is sent in chat the last 2 steps are repeated. +
+ + +#### User Reports + +When a user is reported via the new in-game screen ui the following process occurs: + +
    +
  • User selects the offending user and messages they wish to report
  • +
  • The message in question and surrounding message are also sent to Microsoft for review
  • +
+ +Once a report is sent, it is reviewed by Mojang's moderation team who will gauge an appropriate punishment for the offender(s). Any Microsoft punishment is in-line with it's current community guidelines and effect your entire account not just the single Minecraft server, these punishments can result in removal of your Multiplayer access. + +#### In-depth Review + +The best current source of data for the chat reporting is on Github created by KennyTV. A link to the document can be found [here](https://gist.github.com/kennytv/ed783dd244ca0321bbd882c347892874#file-readme-md) + +Below is a list of ways server owners and players can effectively disable the new chat reporting feature, by using one or more of these features you may limit either your own or your communities functionality. + +--- + +### Options + +#### Client Side + +Option one is disabling 'chat-signing' within your client, this will prevent you from joining any server where this setting is enforced. + +#### Server Side + +If you're running your own server there are a few options that can be used depending if you're running vanilla, modded or a plugin based server, these are as follows. + +##### Edit server.properties file Global + +You can edit the following switch to 'false' which will disable the requirement for users to use chat-signing. + +```yaml +... + +enforce-secure-profile = false + +... +``` + +##### No Chat Reports Modded Only + +No Chat Reports is a Minecraft mod created by Aizistral that works on both the client and server sides. It strips cryptographic signatures from player chat messages, effectively converting them to system messages, thus making them non-reportable. + +:::note +Joining a server with `enforce-secure-profile=true` on a client with No Chat Reports installed will display a prompt warning the user that chat will be signed if they agree to it. +::: + + + +##### FreedomChat Spigot / Paper & forks only + +FreedomChat effectively serves the same purpose as No Chat Reports would on a modded server, it converts player chat messages to system messages at the packet level, making them once again non-reportable by players. + + + +##### AntiPopup Spigot / Paper & forks only + +While this plugin works, manual setup is required - the command `/antipopup setup` must be ran in console unless `enforce-secure-profile` is set to `false` already. + + + +##### UnSignedVelocity Velocity only + +This plugin works by removing signed information from commands and messages sent by clients 1.19.1 or higher, allowing plugins that cancel proxy messages to work again. Requires VPacketEvents + + + +:::caution + +All of the above plugins could give you issues with the recent EULA changes as of Aug 2023, the above plugins are no-longer considered endorsed by setup.md. + +::: diff --git a/folder/fr/src/content/docs/tools/startup.mdx.mdx b/folder/fr/src/content/docs/tools/startup.mdx.mdx new file mode 100644 index 0000000000..e8b76f62f7 --- /dev/null +++ b/folder/fr/src/content/docs/tools/startup.mdx.mdx @@ -0,0 +1,117 @@ +--- +description: Understand the startup file used when hosting a server. +slug: t/flags +title: Startup Scripts +--- + +### Basics + +This is how your most bare-bones startup script looks like. + +```bash +... + +java -XmxG -XmsG -jar .jar nogui + +... +``` + +`-Xmx` sets the maximum amount of memory the Java Virtual Machine is allowed to reserve. Don't set this over the amount of memory you have on your machine/given to you by the hosting provider. + +`-Xms` sets the minimum amount of memory the JVM is allowed to reserve. It should always be below or equal to the `-Xmx` value. + +The JVM only uses memory in its heap space - an area of memory that is reserved for the Java application (in our case, the server) - and the flags `-Xms` and `-Xmx` determine the possible bounds of this area. The heap size may be dynamically changed depending on how much memory the application actually needs, but it will always stay within those bounds. + +For example, `-Xmx3G -Xms1G` would set the maximum heap size to 3 gigabytes and the minimum to 1 gigabyte. You can also use the letters M and K - megabytes and kilobytes (though the latter is not usually used) to set the value more precisely, e.t `-Xmx512M`. + +Setting them both to be the same usually improves performance as no calculations need to be done regarding the heap size, but this may take away memory from other programs on your host machine (if any) in case the server does not always need to allocate the full `-Xmx`. + +You should set your RAM allocation according to your average server load - allocating more memory than your server needs is likely to cause GC lag spikes. For example, if you are a starting out server with 0-2 players most of the time, you'll be fine with 2 GB, but if you have 5-10 players online at once, you'll need 4-5 GB. + +`nogui` hides the Minecraft server GUI panel, only leaving the console visible. Remove the flag if you choose to use the panel. It has basic features like a player list, performance metrics and console output. + +`-jar .jar` points to the server .jar - see [Server Software](https://www.setup.md/t/server-software). + +--- + +### Java flags + +Java flags are used to improve server performance and client stuttering by tuning Java's Garbage Collection and adding other optimizations. + +JVM flags go **before** the `-jar` flag. + +#### Aikar flags + +Aikar's flags, while very well optimized for older Java versions, have not been updated since its creation and are severely out of date for modern Java versions. If you are running a 1.17+ Minecraft Java server (and use java 16+), it is recommended to use more up-to-date flags. + +#### Hilltty flags + +These flags are a more up to date version of Aikar's flags designed for modern versions of Java (16 and 17) which should perform better. You can check the startup scripts [here](https://github.com/hilltty/hilltty-flags/blob/main/english-lang.md). + +--- + +### Advanced JVM flags and optimizations + +The JVM can be further tweaked to optimize server and client stutters relating to Java. See [Minecraft Performance Flags](https://github.com/Mukul1127/Minecraft-Performance-Flags-Benchmarks), a up-to-date guide for Java flags, Garbage Collectors, Java runtimes (GraalVM), and other performance tips such as Large Pages and optimized Linux Distributions. + +--- + +### Minecraft server flags + +Minecraft also has quite a few startup options that directly affects the server in some way. Those go _after_ `-jar` in the startup script. +The following information is from [the wiki](https://minecraft.wiki/w/Tutorials/Setting_up_a_server#Minecraft_options). + +#### Minecraft options + +- `--bonusChest` + +If a bonus chest should be generated, when the world is first generated. + +- `--demo` + +If the server is in demo mode. (Shows the players a demo pop-up, and players cannot break or place blocks or eat if the demo time has expired) +Equivalent to playing minecraft without a account, you have about 5 in-game days before your trial ends. + +- `--eraseCache` + +Erases the lighting caches, etc. Same option as when optimizing single player worlds. + +- `--forceUpgrade` + +Forces upgrade on all the chunks, such that the data version of all chunks matches the current server version (same as with sp worlds). +This option significantly increases the time needed to start the server. + +- `--initSettings` + +Loads the settings from 'server.properties' and 'eula.txt', then quits. + +- `--jfrprofile` + +Initializes the Java Flight Recorder on the server. Only available on 1.18+. + +- `--port ` + +Which port to listen on, overrides the server.properties value. (default: -1, read from server.properties) + +See Server.properties for restrictions on this value. + +- `--safeMode` + +Loads level with vanilla datapack only. + +- `--serverId ` + +Gives an ID to the server. (??) +Seemingly no effect ?? + +- `--singleplayer` + +Runs the server in offline mode. + +- `--universe ` + +The folder in which to look for world folders. (default: .) + +- `--world ` + +The name of the world folder in which the level.dat resides. diff --git a/folder/fr/src/content/docs/tools/textures.mdx.mdx b/folder/fr/src/content/docs/tools/textures.mdx.mdx new file mode 100644 index 0000000000..0fbc5f6eca --- /dev/null +++ b/folder/fr/src/content/docs/tools/textures.mdx.mdx @@ -0,0 +1,63 @@ +--- +description: Hosting texture packs for your server. +slug: t/textures +title: Resource Pack Hosting +--- + +If you're looking to host your texture pack for your Minecraft community you can use a third party file hosting service to deliver your pack to Minecraft clients. + +We (setup.md) have an official sharing site that can be used (for free) providing your packs are under 250MB in size. + +--- + +### Using our uploader + +Firstly, open a browser and navigate to https://smd.gg/upload. + +Sign in using one of our SSO options / create a 'traditional' account using a username and password. + + + +Select the 'Getting Started' free tier to finish setting up your account. + + + +You will now be brought to the dashboard page, on the left hand side select 'File link' + + + +By pressing the 'New Link' button in the top right hand side you will be shown a file uploader + + + +Select where your texture pack is on the system and upload the .zip file. + + + +Select 'create new file URL' and await for the upload to be completed + + + +You will then be presented with additional customisation options as well as the URL that needs to be added to your server.properties content. + + + +Go into your `server.properties` file and where it has resource-pack paste in the URL provided from the website like so. + + + +--- + +#### Compliance Reporting + +This service is operated out of the United Kingdom and is distributed globally via the Cloudflare CDN. + +--- + +### Reporting Content + +If you notice content that shouldn't be on our platform, please inform us via a Github issue and we will complete a take-down request. + +:::note + +Content reviewed by our admins and will be dealt with accordingly, we will not respond directly with a list of actions taken. As required by law any CSAM reports will be directed to local authorities and the NCMEC. diff --git a/folder/fr/src/content/docs/tools/tunnels.mdx.mdx b/folder/fr/src/content/docs/tools/tunnels.mdx.mdx new file mode 100644 index 0000000000..b4d12da944 --- /dev/null +++ b/folder/fr/src/content/docs/tools/tunnels.mdx.mdx @@ -0,0 +1,183 @@ +--- +slug: t/tunnels +description: Using tunnels to host without port forwarding +title: Tunnels +--- + +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you want to host a Minecraft server that others can access but don't want to or cannot forward ports due to reasons such as security implications or restrictions imposed by your host or Internet service provider, look no further than using tunnels. + +Simply put, these are proxies that run on your host and connect your server to a public network without opening a port on your router/firewall. + +This page aims to look at a variety of software used to open tunnels, their pros and cons and a bottom line: + +--- + +### Ngrok + +A single-binary application that exposes local TCP ports to the internet through secure tunnelling: to set up ngrok on your server... + +
    +
  • Create an ngrok.com account
  • +
  • Download the ngrok binary for your system
  • +
  • Copy and paste your authtoken command into the terminal, typically
  • +
+```bash +... + +/path/to/ngrok config set-authtoken + +... + +```` +
    +
  • Run the ngrok agent to expose a port
  • +
+```bash +... + +/path/to/ngrok tcp 25565 # or the port you want to expose + +... +```` + +#### Pros + +
    +
  • Relatively quick to set up (single binary)
  • +
  • Open-source integrations
  • +
+ +#### Cons + +The free version of Ngrok is very limited: + +
    +
  • Server address changes every time the ngrok agent is restarted (static URLs are only available for HTTP sites)
  • +
  • Extremely limited bandwidth (1GB/month)
  • +
+ +Additionally, ngrok does not support UDP tunnelling and therefore Geyser cannot be tunnelled for Bedrock Edition players + +#### Bottom Line + +Ngrok is best suited to development servers that should be able to be accessed from anywhere, as well as smaller servers run by those who cannot forward ports on their network equipment. + + + +--- + +### Playit + +A global proxy that exposes your game server to the Internet, securely tunneled through Playit's servers. To set up Playit on your Minecraft server... (assuming you use Bukkit or a fork) + +
    +
  • Create an account on [playit.gg](https://playit.gg) and verify your email address
  • +
  • Download the Playit agent plugin from [here](https://playit.gg/download/plugins) to your server's plugins folder
  • +
  • Restart your server
  • +
  • Click on the URL that the plugin outputs to the console or chat and log in to Playit
  • +
  • Add the agent to your account and wait for the tunnel to be created
  • +
+Your tunnel should then be active! Share the address given by Playit with your players and you should be good to go! + +#### Pros + +
    +
  • Generous free plan (4 TCP and 4 UDP ports, 6 firewall rules to block IPs and ranges etc.)
  • +
  • Premium plan only $3 per month, offers good upgrades such as extra ports and firewall rules, up to 6 external domains and even 3 dedicated IPv6 addresses (provided your network uses IPv6)
  • +
  • Static domain name for servers
  • +
  • Server plugin allows integration with Playit without running the agent as a separate process
  • +
+#### Cons +
    +
  • Playit only allows for external domains to be used on its premium plan: the free plan assigns a randomly-generated subdomain in the format `name.ply.gg`
  • +
+ +#### Bottom Line + +Playit is the most common and recommended option when it comes to Minecraft server tunnelling, with a vast community on its forums and Discord server and knowledgebase for common guides and issues. + + + +--- + +### Connect + +Minekube's Connect is a plugin that links Minecraft servers to a global network in a similar practice to [Minehut](https://minehut.com) + +#### Pros + +
    +
  • Plug and play: just drop the plugin into your server's plugins directory and copy the generated address
  • +
  • Brandable with free custom domains / sub-domains
  • +
  • Passive advertising on the Connect network allows for extra player traffic
  • +
+ +#### Cons + +
    +
  • A paid plan is required to provide an ad-free experience
  • +
+ +#### Bottom Line + +Out of the options listed on this page, Connect has the easiest setup: just install the plugin and Connect will generate a domain for you! +This option is best suited for public server owners who want simple setup with organic growth from other players joining from the Connect global network. + +:::caution +Players joining your server through the Connect network will not be able to join if secure chat is enforced. To disable this: + +- On your backend server(s), make sure `enforce-secure-profile` is set to `false` in `server.properties` +- If using BungeeCord, set `enforce_secure_profile` to `false` in `config.yml` +- If using Velocity, set `force-key-authentication` to `false` in `velocity.toml` + +This can be a downside for those who want [signed chat](/t/signed-chat) to be enforced on their servers but want to advertise and grow their playerbase on the network. +::: + + + +--- + +### Cloudflared + +Cloudflared is a server-side daemon that allows the tunnelling of network traffic through Cloudflare's secure network + +Here are some resources on how to run and tunnel Minecraft servers using cloudflared: + + + + + + +#### Pros + +
    +
  • Traffic is proxied through Cloudflare's network, renowned for its terabit-capacity DDoS mitigation.
  • +
+ +#### Cons + +
    +
  • Setup is very complicated
  • +
  • Individual tunnels must be created using cloudflared for each port that you wish to be open
  • +
  • All players must have cloudflared installed and running on their computers to access the server
  • +
+ +#### Bottom Line + +This option is best for server owners and players who are willing to take on the more complicated setup and requirements, allowing for rock-solid security without the need for DDoS protected proxy + + diff --git a/folder/fr/src/content/docs/troubleshooting/connectivity.mdx.mdx b/folder/fr/src/content/docs/troubleshooting/connectivity.mdx.mdx new file mode 100644 index 0000000000..bb7a0c308f --- /dev/null +++ b/folder/fr/src/content/docs/troubleshooting/connectivity.mdx.mdx @@ -0,0 +1,170 @@ +--- +description: A foundation for checking connectivity issues with your Minecraft server. +slug: ts/connection +title: Connectivity +lastUpdated: 2023-12-16 +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you're having trouble connecting to your Minecraft server there's a process you should follow in order to try and understand where the issue lies. If you're running on a third party hosting provider it's recommended to reach out to them directly or check their status page. + +### Server Binding to Port + +The first thing to check is that your server binds to the right port when you start it up, firstly you should see some errors in the console. This error will normally come from having two server processes running at the same time or you run an application on the same port as your Minecraft server. + +```bash +... + +**** FAILED TO BIND PORT! **** +The exception was: java.net.BindException: Address already in use +Perhaps a server is already running on that port? + +... +``` + +You can fix this by going to the `server.properties` file and look for the `server-port` variable and increase the number by 1. When you restart the server you should see the server start up without issues. + +If you don't see the above error message you can check using Powershell or Bash that your server is listening. + +#### Windows + +If you're running on windows please use the following command within a Powershell prompt. + +```powershell +... + +netstat -ano | find "{SERVER-PORT}" | find "LISTEN" + +... +``` + +#### Linux + +If you're running a linux distribution please use the following command within your active shell session. + +```bash +... + +netstat -anpe | grep "{SERVER-PORT}" |grep "LISTEN" + +... +``` + +Regardless of the operating system being used you should see one entry bound to 0.0.0.0, if you don't go back and ensure the `server-port` variable has been set properly. + +:::tip +If you're still having issues try deleting the server.properties file and then restart the server to recreate the file. One the file is deleted you can try again. +::: + +--- + +### OS Firewalls + +Now we know that the server is running on the right port you should check that the connection is allowed to break out past 'localhost' (the pc the server is running on). You can run the following command(s) depending on your OS to ensure the local firewall is configured. + +#### Windows + +If you're running on windows please use the following command within a Powershell prompt. + +```bash +... + +netsh advfirewall firewall add rule name= "Open Port 25565" dir=in action=allow protocol=TCP localport=25565 + +... +``` + +#### Linux + +If you're running a linux distribution please use the following command within your active shell session. + +```bash +... + +sudo iptables -I INPUT -p tcp -m tcp --dport 25565 -j ACCEPT + +... +``` + +To ensure things are all working locally within your network, attempt to connect from another device in your house to the internal LAN address. e.g. `192.168.1.58:25565` + +You can find your host devices internal LAN address by running `ipconfig` within command prompt or `ip addr` / `ifconfig` will work on Linux within the shell session. + +--- + +### External Port Forwarding + +Providing you can connect internally to your server, the issue most likely falls with either your router and port forwarding or your ISP and their use of CGNAT. + +The first thing we need to check is port forwarding is configured correctly. + +:::note +You will need to slightly adjust the below steps as the wording on every router model / firewall is different. +::: + +
    +
  • Login to the admin interface (normally on http(s)://192.168.1.254 or http(s)://192.168.1.1)
  • +
      +
    • Admin username and password is normally on the bottom but a Google search may also help
    • +
    +
  • Look for a 'Port Forwarding / NAT folder'
  • +
  • You may need to go into any 'Advanced Settings' tab first
  • +
  • You should ensure the rule has been configured as expected
  • +
      +
    • Service Name - 'Minecraft'
    • +
    • Protocol - 'TCP'
    • +
    • Internal IP - 'Internal LAN IP of Host Device'
    • +
    • Internal Port - 'Match server.properties file'
    • +
    • External Port - 'Match server.properties file'
    • +
    +
  • Save changes
  • +
+ +:::note +It might not be possible to reach your external IP from inside your own network so a tool like Can You See Me can check the port 25565 from an external source. +::: + +If all has been successful you should see OPEN but if you still see CLOSED it could be possible you're running behind CGNAT. + +You can find a great explanation on CGNAT below. + + + +--- + +### SRV Troubleshooting + +Since release 1.3 Minecraft supports a method of connectivity called 'SRV' Record, in principle they allow you to bind a hostname such as `play.mycoolserver.net` to an ip and a random port. The difference when using an SRV record over an A record is if you have a non standard port e.g. 25570 for your Minecraft server an A record would require you to type `play.mycoolserver.net:25570` into your client. + +In using an SRV record you bind the hostname and the service you're running (a Minecraft server) to the specific port so when you go to your client you would only have to type `play.mycoolserver.net` into your client and the SRV record would tell your client "hey use this port". + +:::note +Sometimes an end user may be using a DNS provider that doesn't support SRV records, any issues they have with connectivity can be resolved by changing their local DNS servers to a free public resolver such as one below. + +
    +
  • Quad9: 9.9.9.9
  • +
  • Cloudflare: 1.1.1.1
  • +
  • Google: 8.8.8.8
  • +
+::: + +When you create the record you should ensure it's configured as follows: + +`_minecraft._tcp. IN SRV 1 1 ` + +
    +
  • Host - this should be your current providers connection hostname
  • +
  • TTL - set this to auto if using Cloudflare DNS or 3600 in any other dns providers panel
  • +
  • Port - this should be the port you're currently using to connect to your server with
  • +
  • Subdomain - this should represent what you want your players to connect with
  • +
+ +An example of a functional SRV record has been provided below, this was created in Cloudflare's DNS manager so if Cloudflare is not your DNS solution then you may have a slightly different interface. + + diff --git a/folder/fr/src/content/docs/troubleshooting/ip.mdx.mdx b/folder/fr/src/content/docs/troubleshooting/ip.mdx.mdx new file mode 100644 index 0000000000..6829c4967a --- /dev/null +++ b/folder/fr/src/content/docs/troubleshooting/ip.mdx.mdx @@ -0,0 +1,58 @@ +--- +description: One of the core fundamentals of networking, this page outlines the types of addresses you will come across and how you can work around them. +slug: ts/ip +title: IP Addresses +lastUpdated: 2023-12-16 +--- + +Every connected device has an IP address, similar to how every mobile phone also has a mobile number and we use this number to reference "hey, this is me... you can find me here". Similarly to phone numbers, when it comes to IP addresses we have two different types for internal (private networks) and external (public networks) usage. + +Within your house every laptop, desktop, phone etc has what we call an 'internal' IP, this will normally be represented as 192.168.0.(insert number here). If you run either `ipconfig /all`, `ip addr` or `ifconfig` command you will see your devices individual address. + +Private networks are great because we can reuse these address pools in every household without using any of our global quotas for addresses, when your local device makes a request this is sent to your device's `default gateway` address and requests information on how to proceed. + +If the request is for another local address it sends it where it needs to go and adds this address to it's "table of contents" however if you're trying to reach something outside of your network e.g. youtube.com or netflix.com your router makes a note of the original requesting device and uses it's `external address` to make that request on your behalf. + +We call this technology 'NAT', to understand why NAT exists you need to understand the challenges of IPv4 addresses. + +### Why NAT Exists + +With v4 addresses we have a limited supply of uniquely available addresses 4.3 billion to be precise. This number does sound huge until you realise that companies like Google, Microsoft, Facebook, US DoD and many, many more organisations hold tens of thousands IP addresses for business, cloud computing and just because they can which significantly shortens the pool that can be used by consumers. + +In order to combat this, NAT was introduced as a solution to provide a single entry and exit point for a network. This also allows us to bring additional connections online to the digital world which is rapidly becoming difficult to support. As the world becomes more connected and the IPv4 shortage gets worse more residential connections will move from 'Dynamic IPs to CG-NAT'. + +--- + +### Interim Technologies + +In order to stop the world falling apart, very smart individuals came up with the following solutions starting with the newest first. + +#### Dual Stack + +Dual Stack connections consist of providing both an IPv4 and IPv6 connection and helps encourage these large organisations to support the future technology (in principle, the more devices that support it the greater compatibility becomes). This is great middle-ground as it uses IPv6 first, then, if there is no IPv6 support implemented by a provider it can fall back to using a universal IPv4 address provided by your ISP (see CGNAT for more). + +Unfortunately progress towards a native IPv6 world is slow and DS will be around for a good few years to come before we can finally start to retire this dated address scheme. + +#### CG-NAT + +With CGNAT your ISP takes the concept of 'NAT' and applies it to their entire infrastructure. No longer do you have your own address provided for connecting out to the internet you instead utilise a unique private address pool to connect multiple routers to a central break out location (e.g. an internet exchange). With multiple people sharing the same public address this ultimately means no more residential port forwarding, an issue that that proves difficult for the home-hoster. + +#### Dynamic IPs + +Dynamic addresses allow your ISP to re-allocate your IP to another house waiting to get online in the event you turn off your router / lose power. It prevents idle connections claiming addresses when they're not being used so your ISP doesn't have to try and buy heavily overpriced IPs. + +For the average person this isn't the end of the world, you'll always be able to get online however if you decide to host services at home this can become a problem in the event your allocated IP changes. Anyone who connects to your service will need to be informed of the address changes and this can become a pain if you're on holiday but this can be mitigated with DDNS solutions such as [No-IP](https://noip.com). + +--- + +### The Future (IPv6) + +To every administrator's disappointment IPv6 is essential if we want to keep devices online. The address pool is significantly larger and there's enough of these IPs to allocate to every atom on the planet and we'd still have enough to repeat it 100 times over! Unfortunately with any new technology this won't become the norm overnight, IPv4 will be around for the next 30 years in one way shape or form. It is a huge learning curve for some and it will require many organisations to reconsider their current networking setups. + +The good news is adoption **IS** underway but there's still a lot of work to be done. A huge list of services that are not yet IPv6 native can be found [here](https://whynoipv6.com/), if you find a service you use on this list - give them a nudge and voice the need for change. + +### Cheat Sheets + +Avast have produces a nice summary cheat sheet which sums up everything listed above. + + diff --git a/folder/fr/src/content/docs/troubleshooting/java.mdx.mdx b/folder/fr/src/content/docs/troubleshooting/java.mdx.mdx new file mode 100644 index 0000000000..504825c30f --- /dev/null +++ b/folder/fr/src/content/docs/troubleshooting/java.mdx.mdx @@ -0,0 +1,87 @@ +--- +description: Understand and troubleshoot some of the most common issues with Java when setting up your Minecraft server. +slug: ts/java +title: Java +--- + +Sometimes you can have issues at the first hurdle, getting your server to boot. Some of these issues are to do with your Java deployment and we will cover some quick fixes to get you up and running. + +### Missing PATH variable + +Depending on the OS you're running there are multiple ways to set the ENV / PATH location to call upon the java executable. + +#### Windows + +If you're on windows this can be done entirely via the UI however some steps maybe slightly different depending on your Windows release. Below are steps based on Windows 11. + +
    +
  • Navigate to `c:\program files\java` and identify the JDK version folder name e.g. `jdk-19`
  • +
  • Open the bin folder within the JDK folder and copy the full folder path from file explorer
  • +
  • Select the Windows icon open the start menu and go to 'Settings'
  • +
  • Select the 'System' tab on the left hand side and go to the 'About' menu
  • +
  • Open 'Advanced System Settings'
  • +
  • Select the 'Advanced' tab
  • +
  • Select 'Environment Variables'
  • +
  • Under 'System Variables' scroll down until you see 'Path'
  • +
  • Select 'Edit'
  • +
  • Now select 'New' and paste in the file explorer path you copied earlier
  • +
  • Press 'OK' to save changes
  • +
+ +You can verify the above steps have worked as expected by running the following command in a command prompt window. + +`java --version` or `javac` + +#### MacOS + +If you're running MacOS there's two different commands you could possibly run, the first (bash) is more for older devices and the latter (zsh) is for anything running Catalina or newer. + +##### Bash Command + +```bash +... + +echo export "JAVA_HOME=\$(/usr/libexec/java_home)" >> ~/.bash_profile +exec bash -l + +... +``` + +##### ZSH Command + +```bash +... + +echo export "JAVA_HOME=\$(/usr/libexec/java_home)" >> ~/.zshrc +exec zsh -l + +... +``` + +--- + +### Memory allocation + +--- + +### Wrong version of Java installed + +When it comes to the 'wrong version installed' there's a few factors to consider. + +
    +
  • Bit edition (x86 or x64 or ARM etc)
  • +
  • Major LTS revision
  • +
+ +You can identify if you're having issues due to the bit version by lowering the start-up args from a value greater than `4` for -Xms and -Xmx. If your server boots without issues to the `Done in X seconds` line you will need to uninstall your java release and download the 64 bit edition as this doesn't have the 4GB RAM memory limitation. + +If your server still doesn't boot after decreasing the RAM it's most likely that your machine has the wrong edition of Java installed, certain major releases of Java dropped legacy builds as time has gone on. + +The most commonly adopted Java releases are as follows: + +
    +
  • Java 8 (LTS)
  • +
  • Java 11 (LTS)
  • +
  • Java 17 (LTS)
  • +
  • Java 19 (LTS)
  • +
diff --git a/folder/fr/src/content/docs/troubleshooting/latency.mdx.mdx b/folder/fr/src/content/docs/troubleshooting/latency.mdx.mdx new file mode 100644 index 0000000000..1a882157f1 --- /dev/null +++ b/folder/fr/src/content/docs/troubleshooting/latency.mdx.mdx @@ -0,0 +1,57 @@ +--- +description: Understand latency and how it can play a part in the user experience of your Minecraft server. +slug: ts/latency +title: Latency +lastUpdated: 2023-12-16 +--- + +If you've ever run a server, played on a server or you're Australian then the phrase "IT'S LAAAAAAAAAAAAAAAGING" probably sounds familiar. + + + +Unfortunately this isn't always something that's easily correctable, providing you've ensured the issue isn't related to your hardware the server runs on then you should consider the network and primarily latency. + +Latency related issues can normally be identified by one of these factors being true. + +
    +
  • Blocks don't automatically disappear after being mined
  • +
  • One bar of connectivity in the tab menu
  • +
  • You're located on the other side of the planet
  • +
+ +Technically speaking, the total duration of the request being sent from your machine, processed by the recipient and then sent back is measured in milliseconds 'ping' (latency). The longer it takes to process a request the more noticable and degraded your user experience becomes. + +:::note +If you've previously been able to join a Minecraft server without issues but you login the next day and it's unplayable then the latency should resolve with time. This is most likely due to maintenance in a datacentre somewhere on the planet that your requests utilise. + +
+Your ISP is unable to do anything about latency +::: + +### Tools to Help + +Unfortunately there is no single tool to fix your problem however if you're looking at hosting a Minecraft server for friends split across the globe we've got some advice and test locations you can use to estimate your ping. + +#### Testing Latency + +Before you purchase a server, you will want to test the location for it's ping. Vultr offer a wide range of locations that all support both IPv4 and IPv6 and respond to ICMP (ping), MTR and traceroute requests. + +We have selected 4 of their locations that represent the most common locations offered by service providers. You can use any of these locations to get an indication of what your ping would be like to any future server you buy, it could also be worth sending these links to your community memebers to ensure you find the best compromise for your entire playerbase. + +
    +
  • [https://lon-gb-ping.vultr.com](https://lon-gb-ping.vultr.com) - London, UK
  • +
  • [https://fra-de-ping.vultr.com](https://fra-de-ping.vultr.com) - Frankfurt, DE
  • +
  • [https://tor-ca-ping.vultr.com](https://tor-ca-ping.vultr.com) - Toronto, CA
  • +
  • [https://sgp-ping.vultr.com](https://sgp-ping.vultr.com) - Singapore, SG
  • +
+ +#### Ideal Ping + +Generally you can tollerate higher than normal ping within Minecraft compared to FPS titles due to the fact it's played at a slower pace. + +| Ping (MS) | Summary | +| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 0-10 | You're either hosting the server locally or the server is hosted within your city / country (providing you're an FTTP customer). | +| 11-50 | This is where most of your connections will reside, most often will also account for servers hosted in neighbouring countries / states. | +| 51-150 | This is where you _could_ start to see the occasional block break delay or quick movements might not work as expected. The avg Hypixel ping is roughly in this ball park. | +| 151 + | Most lag related complaints will occur from players in this category (mostly from Asia / Aus). If you have a large audience in this region it would be worth considering a second server here. | diff --git a/folder/nl/src/content/docs/about.mdx.mdx b/folder/nl/src/content/docs/about.mdx.mdx new file mode 100644 index 0000000000..02c898354a --- /dev/null +++ b/folder/nl/src/content/docs/about.mdx.mdx @@ -0,0 +1,65 @@ +--- +title: About Us +description: We're an administration wiki for Minecraft server administrators who are looking to enhance their server experience. +template: splash +--- + +We're building the ultimate Minecraft documentation project and if you're interested in making things even better this is the page for you. + +This page will be split up into three sections to help you get about: + +
    +
  • New Ideas
  • +
  • New Content
  • +
  • Improving Content
  • +
+ +:::caution + +If you don't already have a Github account you will be required to make one before proceeding, you can create one at https://github.com/signup. + +::: + +### Submitting Ideas + +If you're an administrator looking for docs that we don't currently have information on then this is probably the section for you, it will explain how to raise a new Github issue with the information required for us to get the ball rolling with your request. + +
    +
  • Head on over to the [setup.md Github repository](https://smd.gg/repoissue)
  • +
  • In the menu bar at the top select 'Issues'
  • +
  • Select 'New Issue'
  • +
  • Select 'Feature Request'
  • +
  • Complete the required sections on the provided form
  • +
+ +Ensure you fill out the form with as much information as you can as this will help us build better documentation + +--- + +### Writing Content + +If you're interested in writing content / migrating your own doc environment over to our wiki a Github PR is your best option. Please also ensure you have followed our [styling guide](https://contribute.setup.md) to ensure your PR doesn't get rejected for lack of continuity. + +#### Single Articles + +If you're going to write a single article you can do so with the following steps, before you consider uploading a document please ensure you are using a template from our [sister github repository](https://github.com/setupmd/templates/tree/main/Docs). + +
    +
  • Head on over to the [setup.md Github repository](https://smd.gg/pr)
  • +
  • In the menu bar at the top select 'Pull Requests'
  • +
  • Select 'New Pull Request'
  • +
  • Select the branch of your forked repo that you wish to commit as a PR
  • +
  • Select 'View Pull Request'
  • +
+ +The setup.md contributors will then verify the PR is good and will approve your content. + +#### Migrating Wikis + +If you already use docusaurus for your own project, adding your content here is super easy and should be a drag and drop migration. You'll need to [submit a PR](https://smd.gg/pr) but it's recommended you reach out to us on [Discord](https://smd.gg/discord) so we can setup some indexing for your future content. + +--- + +### Improving Content + +As Minecraft continues to grow so will our project and we hope that if you spot inconsistancies in our project you'll hit the 'Edit Page' link at the bottom to submit a PR request with any corrections you wish to make. diff --git a/folder/nl/src/content/docs/enhancements/Anti-X Tools/anticheat.mdx.mdx b/folder/nl/src/content/docs/enhancements/Anti-X Tools/anticheat.mdx.mdx new file mode 100644 index 0000000000..aebeeaef0b --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Anti-X Tools/anticheat.mdx.mdx @@ -0,0 +1,282 @@ +--- +description: A brief introduction to Anti-Cheats and the community recommended solutions. +slug: e/anti-x/ac +title: Anti-Cheats +lastUpdated: 2024-02-25 +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +:::info +Throughout this guide 'Anti-Cheat(s)' may be referred to as 'AC' or 'ACs' +::: + +ACs are an integral part of any public server and help with catching hackers, since Minecraft's built-in anti-cheat is practically useless, it's better to turn it off than to endure the constant false positives it spews out. + +You should change the following settings within the `server.properties` file. + +```yml +... + +allow-flight=true + +... +``` + +Within the `spigot.yml` file you should also set the following values. + +```yml +... + + moved-wrongly-threshold: 100000.0 + moved-too-quickly-multiplier: 100000.0 + +... +``` + +For the recommended anti-xray settings [click here](https://www.setup.md/e/anti-x/ax). + +:::warning +We highly discourage the usage of auto-bans as no anti-cheat is perfect. If you want to auto-ban, consider having something like AntiCheatReplay so that you can undo false bans. +::: + +### Common Anti-Cheats + +This list consists common ACs and some pros and cons of each AC. + +#### NoCheatPlus Spigot / Paper & forks only + +##### Pros + +
    +
  • Free and open-source
  • +
  • Good movement checks
  • +
+ +##### Cons + +
    +
  • Default configuration will spam false movement positives all over the place, you should buy a good config (eg. [MarkElf's](https://www.mc-market.org/resources/475/)) OR make your own
  • +
  • Mediocre combat checks
  • +
+ + + +--- + +#### Grim Spigot / Paper & forks only + +##### Pros + +
    +
  • Open-source
  • +
  • Great movement checks
  • +
  • Predictive technology
  • +
+ +##### Cons + +
    +
  • Currently WIP, not ready for production servers
  • +
  • Mediocre combat checks
  • +
  • Quite unoptimized
  • +
+ + + +--- + +#### Vulcan Spigot / Paper & forks only + +##### Pros + +
    +
  • Great movement and combat checks
  • +
  • Good default config
  • +
+ +##### Cons + +
    +
  • USD 20.00
  • +
  • Suboptimal performance when scaled to high player counts (>3% of ticks at 420 players)
  • +
+ + + +--- + +#### Spartan Spigot / Paper & forks only + +##### Pros + +
    +
  • 14-day money-back guarantee
  • +
  • Good Bedrock Checks
  • +
  • Decent movement checks
  • +
+ +##### Cons + +
    +
  • EUR 22.49
  • +
  • Relatively poor combat checks
  • +
  • Crashes on start up at times
  • +
  • Sub-par performance
  • +
+ + + +--- + +#### Matrix Spigot / Paper & forks only + +##### Pros + +
    +
  • Decent movement and combat checks
  • +
+ +##### Cons + +
    +
  • Bad default config, but there are some [good ones](https://github.com/QuantumSuite/MatrixChecks) out there
  • +
  • USD 20.00 (With 95% Checks) and USD 129.00 (All Checks)
  • +
  • Dedicated Server Limit
  • +
  • Terrible performance; Ate up >5% of the ticks at 135 players
  • +
+ + + +--- + +#### Themis Spigot / Paper & forks only + +##### Pros + +
    +
  • Free
  • +
  • Proper Geyser-Floodgate (Bedrock Players) checks (Only reason to use this anti-cheat)
  • +
+ +##### Cons + +
    +
  • Bad Combat & Mediocre Movement checks (Bad Elytra, Timer, KillAura Checks)
  • +
  • Lack of checks in general
  • +
+ + +
+ +:::note +This anti-cheat is optimised for bedrock players. +::: + +--- + +#### SoaromaSAC (Config 6) Spigot / Paper & forks only + +##### Pros + +
    +
  • Free
  • +
+ +##### Cons + +
    +
  • Bad Checks
  • +
  • Infinite False Positives
  • +
  • Fake Open Source Link. Leads to a Rick Roll
  • +
+ + + +--- + +#### Negativity v1 & v2 All major Java platforms + +##### Pros + +
    +
  • Free & Open Source
  • +
  • Paid Version (v2) is Open Source
  • +
  • v2 supports a lot of platforms (Minestom, Sponge, Fabric & more)
  • +
+ +##### Cons + +
    +
  • Lacks some important checks (No Elytra Checks, NoSlow Checks etc)
  • +
  • Poor movement and combat checks
  • +
+ + + +--- + +#### Polar + +##### Pros + +
    +
  • Great movement and combat checks
  • +
  • Works out-of-the-box on most servers
  • +
  • Cloud-based detections, which helps reducing stress on server resources
  • +
+ +##### Cons + +
    +
  • Subscription plans starting at EUR 15/month
  • +
  • Limitations on player count, server instances and dedicated servers based on subscription plan
  • +
+ + + +### Recommendations + +Both Astro and Vulcan offer a great price to performance ratio. However, Astro will be significantly lighter on system resources. +Also, Vulcan will support Bedrock in the near future. Astro already supports it. + +:::tip +Remember, no anti-cheat is perfect. Players will be able to bypass anti-cheats, so we recommend having a moderator or two online to keep an eye out for any cheaters. +::: diff --git a/folder/nl/src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx.mdx b/folder/nl/src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx.mdx new file mode 100644 index 0000000000..1ee39234bd --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx.mdx @@ -0,0 +1,47 @@ +--- +description: A brief introduction to Anti-Exploits and the community recommended solutions. +slug: e/anti-x/ae +title: Anti-Exploit +lastUpdated: 2024-02-25 +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +Anti-Exploit plugins resolve issues such as crashes, dupes, abusive NBT etc. + +:::info +Some of these plugins might only be useful if you are not using the latest version of Paper. +::: + +#### Panilla + +Panilla prevents abusive NBT and packets. Average or lenient modes recommended. Recently was found to be messing with items contained within shulkers, so test the plugin before you install it on production. + + + + + + +--- + +#### LPX + +Avoids NettyCrashers, slightly prevents Anti-Anti-Xrays, logs packets and limits them. + + + +--- + +#### BookExploitFix + +Improve the security of your Minecraft server by filtering illegal content from player created books. Although personally I would completely disable books because I don't trust them at all, you may use this plugin instead. + + + + + diff --git a/folder/nl/src/content/docs/enhancements/Anti-X Tools/antilag.mdx.mdx b/folder/nl/src/content/docs/enhancements/Anti-X Tools/antilag.mdx.mdx new file mode 100644 index 0000000000..511bac4815 --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Anti-X Tools/antilag.mdx.mdx @@ -0,0 +1,85 @@ +--- +description: A brief introduction to Anti-Lag and alternative performance management tools. +slug: e/anti-x/al +title: Anti-Lag +lastUpdated: 2024-02-25 +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +Below is a list of tools and optimisations you can use to identify and mitigate TPS (server) lag. + +:::caution +**Anti-lag plugins such as ClearLagg "don't work".** + +These plugins periodically clear dropped items at a set interval - this makes a negligible difference to lag and most anti-lag plugins have poor detection that can result in more lag. Aside from the fact any "gains" seen by such tools are just hiding performance issues under a thin veil rather than actually fixing them. +::: + +#### Guides to Optimisation + +We have published a couple of proven guides on optimisations below that should be reviewed first. + + + +--- + +#### Spark + +A modern performance profiler for 1.8+ servers on any platform - Forge, Spigot, Fabric, almost anything that isn't the vanilla server! This isn't an anti-lag plugin per se but it can help you find what's _causing_ lag on your server. + +It now comes built-in with the Purpur performance JAR and its forks. + + + + + + + +--- + +#### FarmControl + +This plugin allows you to manage certain properties of farms on your server. Among other things, the plugin acts as a farm limiter, can remove the ability of mobs in farms to collide and perform random movements, or can completely disable the AI of mobs in farms. These actions can be performed either passively or in response to the server's performance degrading. + + + + + + +--- + +#### EntityDetection + +This plugin lets you quickly find chunks with large quantities of mobs/animals & tile entities. Not an anti-lag plugin, but can be incredibly useful + + + + + + +--- + +#### CAProtect-Lite + +Prevents players from lagging the server with minecarts and boats. If you have FarmLimiter, consider configuring that plugin to do what CAProtect does instead, as CAProtect is a bit more intensive. Otherwise, consider using AjMac's fork. + + + + + + +--- + +#### RedstoneLimiter + +RedstoneLimiter is a plugin that limits how many times individual redstone contraptions can be activated in a customizable amount of time to fix lag machines. + + + + + diff --git a/folder/nl/src/content/docs/enhancements/Anti-X Tools/antixray.mdx.mdx b/folder/nl/src/content/docs/enhancements/Anti-X Tools/antixray.mdx.mdx new file mode 100644 index 0000000000..d18466f8b8 --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Anti-X Tools/antixray.mdx.mdx @@ -0,0 +1,50 @@ +--- +description: A brief introduction to Anti-Xray and the community recommended solutions. +slug: e/anti-x/ax +title: Anti-Xray +lastUpdated: 2024-02-25 +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +As the name suggests, Anti-Xray will prevent players from finding ores using Xray clients/resource packs. This is done by sending packets to the player where all of the ores are replaced by stone. The ores only appear if the player establishes direct visual contact with them/updates them. Two of the most common Anti-Xray plugins are shown below: + +#### PaperMC + +PaperMC (A fork of Spigot) comes with a built-in Anti-Xray. This Anti-Xray usually does the trick just fine. It is simple to setup and causes no lag for both the server and the client (unless you hide caves (air), which will be much laggier for the client). A great guide is shown [here](https://docs.papermc.io/paper/anti-xray). Again, make sure that you do NOT add `air` to `hidden-blocks`. + + + +--- + +#### Orebfuscator + +If you're stuck using Spigot for whatever reason, you should probably use Orebfuscator. It may also work well in junction with Paper's Anti-Xray, as it can also +hide containers better. + + +
+:::note +Orebfuscator does have a tendency to turn chests into dirt when server is laggy, this is a visual thing and doesn't delete the contents of said chests +::: + +--- + +### RayTraceAntiXray + +Paper plugin for server-side async multithreaded ray tracing to hide ores that are exposed to air using Paper Anti-Xray engine-mode 1. Might be worth using instead of engine-mode 2 as that can cause lag on slow devices. Only recommended if you have extra threads and don't mind using ProtocolLib. + + diff --git a/folder/nl/src/content/docs/enhancements/Anti-X Tools/intro.mdx.mdx b/folder/nl/src/content/docs/enhancements/Anti-X Tools/intro.mdx.mdx new file mode 100644 index 0000000000..5237647b53 --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Anti-X Tools/intro.mdx.mdx @@ -0,0 +1,22 @@ +--- +sidebar_position: 1 +slug: e/anti-x +description: Understand the types of 'preventative' tools that exist for Minecraft servers. +title: Introduction +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue'; +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +Minecraft is an open game by nature and as great as that is, it doesn't always work in every servers favour and sometimes they need to make changes in order to restrict certain aspects of gameplay for any number of multiple reasons. + +The most common types of plugins you'll see in this category are: + + + + + + + + +We will attempt to cover multiple examples of each where possible. diff --git a/folder/nl/src/content/docs/enhancements/Economy/chest.mdx.mdx b/folder/nl/src/content/docs/enhancements/Economy/chest.mdx.mdx new file mode 100644 index 0000000000..59dccbe225 --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Economy/chest.mdx.mdx @@ -0,0 +1,17 @@ +--- +description: A focus on traditional chest based plugins for your servers economy. +slug: e/eco/chest +title: Chest Based +--- + +A chest shop is a Minecraft resource buying - selling enhancement that is fully craftable in game using normally a standard chest and a wooden sign. These solutions normally bring a more player-to-player style interraction with players chosing to rent space in an admin market / build their own market. + +### Examples + +We have collated a small list of plugins you can use to get you started with on your Minecraft server below. + +
    +
  • [QuickShop](/e/pl/quickshop)
  • +
  • [ChestShop](/e/pl/chestshop)
  • +
  • [DukesMart](/e/pl/dukesmart)
  • +
diff --git a/folder/nl/src/content/docs/enhancements/Economy/gui.mdx.mdx b/folder/nl/src/content/docs/enhancements/Economy/gui.mdx.mdx new file mode 100644 index 0000000000..7844735528 --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Economy/gui.mdx.mdx @@ -0,0 +1,19 @@ +--- +description: A focus on GUI based plugins for your servers economy. +slug: e/eco/gui +title: GUI Based +lastUpdated: 2024-01-01 +--- + +A GUI based shop plugin allows users to buy and sell using an interface, normally that of chests and can sometimes be more accessible for your players. + +### Examples + +We have collated a small list of plugins you can use to get you started with on your Minecraft server below. + +
    +
  • [AuctionHouse](/e/pl/auctionhouse)
  • +
  • [PlayerAuctions](/e/pl/playerauctions)
  • +
  • [PlayerShops (BPS)](/e/pl/playershops)
  • +
  • [zAuctionHouse](/e/pl/zauctionhouse)
  • +
diff --git a/folder/nl/src/content/docs/enhancements/Economy/intro.mdx.mdx b/folder/nl/src/content/docs/enhancements/Economy/intro.mdx.mdx new file mode 100644 index 0000000000..0319535ab4 --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Economy/intro.mdx.mdx @@ -0,0 +1,26 @@ +--- +description: Recommended plugins to kick start your Minecraft server's economy. +slug: e/eco +title: What is an economy? +sidebar: + order: 1 +--- + +An economy is essential to your Minecraft server, it allows for players to buy and sell between one another or between your players and the server for in-game ranks / items etc. + +Economies within Minecraft, much like the real world, can dictate supply and demand with availabilities of resources to your players. For example if you were running admin shops it would be possible to run a discount on certain items and random points within the year or if you want to make a product more valuable then this can be achieved too. + +The goal with this section is to highlight some viable options for your server along with some example plugins that will allow you to build the framework for your own server's economy to take place. + +### Requirements + +Most, if not all plugins require your server to have an Economy API (such as [Vault](/e/pl/vault)) and an Economy Handler installed. + +Some example economy handlers are below: + +
    +
  • [EssentialsX](/e/pl/essentialsx)
  • +
  • [TheNewEconomy](/e/pl/theneweconomy) (Optional Vault Support)
  • +
  • [iConomy](/e/pl/iconomy)
  • +
  • [Gringott's Economy](/e/pl/gringottseco)
  • +
diff --git a/folder/nl/src/content/docs/enhancements/Economy/shop.mdx.mdx b/folder/nl/src/content/docs/enhancements/Economy/shop.mdx.mdx new file mode 100644 index 0000000000..9fd5bcd954 --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Economy/shop.mdx.mdx @@ -0,0 +1,44 @@ +--- +description: A focus on /shop based plugins for your servers economy. +slug: e/eco/shop +title: Command Based +--- + +### /shop Plugins + +/shop Plugins are server-sided shops, meaning that all items are bought and sold from and to the the server instead of a player. + +#### ShopGUI+ + +ShopGUI+ is probably the most well known /shop plugin out there. Kitted out with basically every feature you might need (other than a dynamically evolving economy), it is a pretty solid choice for most servers. +Too bad that it's 18 USD and performs poorly when scaled to higher player counts. Only worth buying if you want support for other plugins. + +
+Spigot +
+ +#### BossShopPro + +Solid /shop plugin with a lot of good features. I highly recommend that you find a fork to download instead of using the old SpigotMC version. + +
+Spigot +
+ +#### EconomyShopGUI + +Free, simple /shop plugin that just does the job. It also has a premium version for 12 USD. Free version is extremely limiting. + +
+Spigot +
+ +#### DeluxeMenus + +Now hear me out.. I know that DeluxeMenus isn't exactly a server-shop plugin, but it is nearly perfect for the job since it is EXTREMELY flexible. cj89898 has made a wonderful DeluxeMenus shop [here](https://github.com/cj89898/DeluxeMenus-DeluxeShop). + +You may also use a setup.md provided version [here](https://github.com/setupmd/templates/raw/main/Plugin%20Configurations/deluxemenusshop.zip). + +
+Spigot +
diff --git a/folder/nl/src/content/docs/enhancements/Permissions/breakdown.mdx.mdx b/folder/nl/src/content/docs/enhancements/Permissions/breakdown.mdx.mdx new file mode 100644 index 0000000000..467527519f --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Permissions/breakdown.mdx.mdx @@ -0,0 +1,28 @@ +--- +sidebar_position: 1 +slug: e/perms +title: How They Work +lastUpdated: 2024-01-01 +sidebar: + order: 4 + badge: + text: Important + variant: danger +--- + +When you're setting up a new server, a very important part of the process is managing permissions and **configuring them as you go**. + +Permissions are little pieces of text that indicate an action. When you grant a certain group of players this permission, the plugin will know that they are allowed to perform this action. They are usually laid out like `pluginname.permission`. + +An example is the `essentials.afk` permission. If you give this permission to a player, they will be able to perform the `/afk` command. + +:::note +You can use the wildcard (`*`) operator to indicate everything when supplying a permission. +Ex: `essentials.*` will give you every permission that starts with `essentials.`. +::: + +:::danger +It is a very bad idea to give someone (even yourself!) either the `*` or `*.*` permission(s). +::: + +So how does one grant permissions to their players? For this exact purpose people have created permission plugins. They allow you to create groups, usually associated with the term Rank. You can then give certain permissions to these groups, and assign players to these groups. diff --git a/folder/nl/src/content/docs/enhancements/Permissions/plugins.mdx.mdx b/folder/nl/src/content/docs/enhancements/Permissions/plugins.mdx.mdx new file mode 100644 index 0000000000..a8e5b6111d --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Permissions/plugins.mdx.mdx @@ -0,0 +1,17 @@ +--- +description: A focus on permission manager plugins for your server. +slug: e/perms/plugins +title: Plugins +lastUpdated: 2024-01-01 +--- + +Permission manager plugins allow you to define groups (ranks), and permission levels for all of your players on your server. + +### Examples + +We have collated a small list of plugins you can use to get you started with on your Minecraft server below. + +
    +
  • [LuckPerms](/e/pl/luckperms)
  • +
  • [PowerRanks](/e/pl/powerranks)
  • +
diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/AntiCrasher.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/AntiCrasher.mdx.mdx new file mode 100644 index 0000000000..83e03f9edb --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/AntiCrasher.mdx.mdx @@ -0,0 +1,12 @@ +--- +description: AntiCrasher fixes a crash exploit that affects every version, only fixed in very recent builds of paper/pufferfish/purpur for 1.20.2 and a backport for pufferfish 1.20.1 +slug: e/pl/anticrasher +title: AntiCrasher +--- + +Fixes a very popular and very used crash exploit that affects most versions of Minecraft + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/MiniMOTD.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/MiniMOTD.mdx.mdx new file mode 100644 index 0000000000..01da7628be --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/MiniMOTD.mdx.mdx @@ -0,0 +1,33 @@ +--- +description: MiniMOTD has the functionality to add an MOTD (Message Of The Day) to your server, which shows on the Multiplayer page of Minecraft before a player logs into your server. +slug: e/pl/minimotd +title: MiniMOTD +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Bungeecord, Waterfall & Velocity Spigot / Paper & forks only +
+MiniMOTD is a plugin of which allows you to **fully** customize your server's MOTD by: + +
    +
  • Adding multiple MOTD messages that can alternate between one another
  • +
  • Adding RGB gradients
  • +
  • Adding Placeholders
  • +
  • and much more...
  • +
+ +#### Note + +Whilst MiniMOTD can run on your backend server, if you are running a network via a proxy such as Bungeecord or Velocity, MiniMOTD will be ran on your proxy. Therefore, you should download MiniMOTD to your proxy rather than your individual servers. If you are just running one singular server, MiniMOTD will run directly on that server. + + + + + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/auctionhouse.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/auctionhouse.mdx.mdx new file mode 100644 index 0000000000..93b2115d67 --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/auctionhouse.mdx.mdx @@ -0,0 +1,24 @@ +--- +description: A GUI based player shop plugin to enhance your economy. +slug: e/pl/auctionhouse +title: AuctionHouse +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+A decent /ah plugin. Unfortunately, it does have it's fair share of issues. For example, it is one of the most laggiest plugins in every server and also has caused dupes here and there (rare but still possible). + +There are better options out there with far more customizability. + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/chestshop.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/chestshop.mdx.mdx new file mode 100644 index 0000000000..3befbc50a7 --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/chestshop.mdx.mdx @@ -0,0 +1,22 @@ +--- +description: A chest based player shop plugin to enhance your economy. +slug: e/pl/chestshop +title: ChestShop +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+A simple bare bones chest shop plugin, think 'QuickShop' without all the fancy bells and whistles. ChestShop makes a great plugin for anyone who just wants to get some simple buying and selling going in their server. + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/discordsrv.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/discordsrv.mdx.mdx new file mode 100644 index 0000000000..74e97937bb --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/discordsrv.mdx.mdx @@ -0,0 +1,22 @@ +--- +description: DiscordSRV acts as a bridge between a Discord server and your Minecraft server, allowing them to communicate. +slug: e/pl/discordsrv +title: DiscordSRV +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+DiscordSRV is a very commonly used plugin that acts as a bridge between your Minecraft and Discord servers, allowing them to communicate and for actions to be called via interactions in Discord and vice-versa. DiscordSRV also supports livechat functionality between your Minecraft and Discord server so players that aren't logged in can still chat. Moreover, DiscordSRV allows for linking a users Discord account to their Minecraft account on a per-instance basis. That said, the setup of DiscordSRV relies on the creation of an application and Bot on Discord's Developer Portal. + + + + + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/dukesmart.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/dukesmart.mdx.mdx new file mode 100644 index 0000000000..89c3e66970 --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/dukesmart.mdx.mdx @@ -0,0 +1,22 @@ +--- +description: A chest based player shop plugin to enhance your economy. +slug: e/pl/dukesmart +title: DukesMart +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+A plugin to watch as the light weight chest shop plugin was rumoured to be getting one final breath of life with a fork. + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/essentialsx.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/essentialsx.mdx.mdx new file mode 100644 index 0000000000..66130c749e --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/essentialsx.mdx.mdx @@ -0,0 +1,28 @@ +--- +description: EssentalsX introduces over 130 commands for servers of all sizes which will enhance the gameplay with QoL features for all. +slug: e/pl/essentialsx +title: EssentialsX +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +EssentialsX, formerly just Essentials is the core backbone to any Minecraft server, it introduces a wide range of utility commands (all of which are permission toggle controllable) that can be used to enhance the base gameplay over the vanilla commands. + + + + + + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/luckperms.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/luckperms.mdx.mdx new file mode 100644 index 0000000000..895140d4ef --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/luckperms.mdx.mdx @@ -0,0 +1,25 @@ +--- +description: Learn about the PowerRanks plugin and how to get a basic configuration up and running. +slug: e/pl/powerranks +title: PowerRanks +lastUpdated: 2024-01-01 +sidebar: + badge: + text: New + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+PowerRanks is an alternative to Luckperms, it's a Bukkit plugin that support Spigot and it's forks. PowerRanks does have support for NukkitX but has not been updated since Dec 2023. + + + + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/playerauctions.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/playerauctions.mdx.mdx new file mode 100644 index 0000000000..605c04b36d --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/playerauctions.mdx.mdx @@ -0,0 +1,24 @@ +--- +description: A GUI based player shop plugin to enhance your economy. +slug: e/pl/playerauctions +title: PlayerAuctions +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+It has great levels of customizability and flexibility, to the point where you can edit pretty much every aspect of every single menu. It also has compatibility with lots of other plugins and also an author who is always there to provide support. + +The plugin does however lack in the open source department. + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/playershops.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/playershops.mdx.mdx new file mode 100644 index 0000000000..15ce1dedb3 --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/playershops.mdx.mdx @@ -0,0 +1,23 @@ +--- +description: A GUI based player shop plugin to enhance your economy. +slug: e/pl/playershops +title: PlayerShops (BSP) +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +It allows every player to create their own shop GUI, similarly to BossShopPro. Players may sell their items in said shop. Might replacement for ChestShops. this plugin hasn't been updated in a while, though. + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/powerranks.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/powerranks.mdx.mdx new file mode 100644 index 0000000000..60165c89ee --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/powerranks.mdx.mdx @@ -0,0 +1,25 @@ +--- +description: Learn about the Luckperms plugin and how to get a basic configuration up and running. +slug: e/pl/luckperms +title: Luckperms +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Bungeecord, Waterfall & Velocity All major Java & Bedrock platforms +
+LuckPerms is probably the most feature-rich permissions plugin in existence currently. It supports many different kinds of servers, like Bukkit/Spigot or Sponge, but also all the major proxies like Velocity and Bungeecord. + + + + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/quickshop.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/quickshop.mdx.mdx new file mode 100644 index 0000000000..9380421371 --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/quickshop.mdx.mdx @@ -0,0 +1,33 @@ +--- +description: A chest based player shop plugin to enhance your economy. +slug: e/pl/quickshop +title: Quick Shop Remake +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+QuickShop Remake is a forked and maintained version of the long standing '[QuickShop](https://dev.bukkit.org/projects/quickshop)' plugin of the earlier Minecraft days. It allows players to buy and sell between one another and the 'admin store' using chests. + +### Features + +
    +
  • Full sign support
  • +
  • Full support for multi-currency
  • +
  • Supports Taxes
  • +
  • WorldGuard, Towny, PlotSquared and Factions support
  • +
+ +And so much more, the important links for this plugin can be found below. + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/ultimatetimber.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/ultimatetimber.mdx.mdx new file mode 100644 index 0000000000..96a97d627e --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/ultimatetimber.mdx.mdx @@ -0,0 +1,31 @@ +--- +description: A free plugin that freshens up the most basic task in Minecraft - cutting down a tree. +slug: e/pl/ultimatetimber +title: Ultimate Timber +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+Give your players a new and exciting way to cut down trees in Minecraft. + +### Features + +
    +
  • Auto pickup
  • +
  • Auto replant
  • +
  • Custom animations (inc block falling)
  • +
  • Custom item drops
  • +
  • Custom sounds
  • +
+ + + + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/vault.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/vault.mdx.mdx new file mode 100644 index 0000000000..1d8fc72841 --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/vault.mdx.mdx @@ -0,0 +1,29 @@ +--- +description: Vault API is a core framework for most economy, permission and chat plugins and has become a key dependency for many plugins. +slug: e/pl/vault +title: Vault API +lastUpdated: 2023-12-16 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +The Vault API is the longest standing, most reliable permissions, chat and economy API backbone for Minecraft. It's been around for about a decade at this point in time and with every update that passes reliability has always remained. + +Vault is a plugin that once added will rarely need updating and with a lot of plugins requiring it, you should make sure it's first on your download list! + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/worldedit.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/worldedit.mdx.mdx new file mode 100644 index 0000000000..038aa582bc --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/worldedit.mdx.mdx @@ -0,0 +1,28 @@ +--- +description: WorldEdit is a plugin that's been around for over a decade and can be used to help speed up large builds / world changes. +slug: e/pl/worldedit +title: WorldEdit +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+Worldedit is a no-brainer, this is a plugin that's been around for the entire lifespan of Minecraft multiplayer as we know it and it's not going anywhere fast. If you need to move large buildings in your world, export or import schematics this is the tool for you and your build team. Consider using WETS (WorldEdit Tick Spreader) OR AsyncWorldEdit OR FastAsyncWorldEdit, as they can perform tasks faster & prevent crashes. + +Ironically, FAWE performs far worse than WE at higher player counts while it is idle due to it unnecessarily listening to player interactions. If you want to squeeze every last drop of performance out of your server and are not actively using FAWE in any way, we recommend switching back to WE. AWE's idle performance is untested. + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/worldguard.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/worldguard.mdx.mdx new file mode 100644 index 0000000000..4cf011e9e5 --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/worldguard.mdx.mdx @@ -0,0 +1,26 @@ +--- +description: WorldGuard is one of the oldest forms of 'admin land claim' systems and has been a core plugin for many servers over the last decade or so. +slug: e/pl/worldguard +title: WorldGuard +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Essential + variant: success +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+If you're using WorldEdit then you've most likely already heard of WorldGuard but for those who haven't WorldGuard allows you to create 'admin land claims' which will prevent certain regions from being griefable. This is a perfect solution for building playershops, central landmarks in your server such as spawns and admin shops and more. Some plugins can even hook into the WorldGuard plugin and enhance it's capability offering a better overall experience to your players. + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Free/znpc.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Free/znpc.mdx.mdx new file mode 100644 index 0000000000..3c4475eaf0 --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Free/znpc.mdx.mdx @@ -0,0 +1,37 @@ +--- +description: An NPC plugin for your Minecraft server. +slug: e/pl/znpc +title: ZPNCs +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +### ZNPCs + +ZNPCs is another popular NPC plugin. Although it is better than Citizens from a performance perspective, it is quite janky and unpleasant to setup. + + + +--- + +### ZNPCsPlus + +ZNPCsPlus delivers great performance while also being easy to setup & edit. Recommended as long as you don't mind the lack of support in other plugins for it, V2 can be compiled from the Github page. + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Premium/citizens.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Premium/citizens.mdx.mdx new file mode 100644 index 0000000000..99924efc1c --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Premium/citizens.mdx.mdx @@ -0,0 +1,23 @@ +--- +description: An NPC plugin for your Minecraft server. +slug: e/pl/citizens +title: Citizens +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +Citizens is the most popular and widely supported NPC plugin in the market. It is purchasable on Spigot and open source as well. Free downloads can be found on it's Jenkins server. Not recommended for servers with high player counts as it can eat a lot of ticks. + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Premium/litebans.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Premium/litebans.mdx.mdx new file mode 100644 index 0000000000..8d226e9d8d --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Premium/litebans.mdx.mdx @@ -0,0 +1,37 @@ +--- +description: Litebans is a premium plugin that centralises ban management for 'networked' servers. +slug: e/pl/litebans +title: Litebans +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Recommended + variant: tip +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Bungeecord, Waterfall & Velocity Spigot / Paper & forks only +
+If you're looking for a method of syncing Minecraft bans between multiple Minecraft proxies, servers (or both) or perhaps you're looking for a way to give your end users some transparency over the punishments that are handed out within your community. If this sounds of interest then Litebans is the tool for you. + +This plugin allows for central management of all punishments via a database and provides you the ability to host a public punishment website for people to view additional details. + +### Features + +
    +
  • UUID based punishments (no username change ban evasions)
  • +
  • UI is fully customisable
  • +
  • Punishment templates
  • +
  • Punishment scope support (multi-server specific)
  • +
  • Web-UI included for free
  • +
+ + + + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/Premium/zauctionhouse.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/Premium/zauctionhouse.mdx.mdx new file mode 100644 index 0000000000..5e790f5a3e --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/Premium/zauctionhouse.mdx.mdx @@ -0,0 +1,25 @@ +--- +description: A GUI based player shop plugin to enhance your economy. +slug: e/pl/zauctionhouse +title: zAuctionHouse +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports + +
+Spigot / Paper & forks only +
+ +A premium version of Player Auctions. You may find greater performance in addition to a few extra features, notably the Shulker viewer and a Sell inventory but that's about it. + +Player Auctions listed in the comparison page says that several features, such as multi-currency support & custom inventories, are not in PA. This is not true as PA does have said features. + + diff --git a/folder/nl/src/content/docs/enhancements/Plugins/intro.mdx.mdx b/folder/nl/src/content/docs/enhancements/Plugins/intro.mdx.mdx new file mode 100644 index 0000000000..7b20e4764f --- /dev/null +++ b/folder/nl/src/content/docs/enhancements/Plugins/intro.mdx.mdx @@ -0,0 +1,16 @@ +--- +sidebar_position: 1 +slug: e/pl +title: Why Plugins +--- + +Our goal is to highlight some must have plugins for Minecraft, in order for them to make the list they have to meet the below criteria. + +
    +
  • Publish to reputable marketplaces
  • +
  • Premium plugins should be on Spigot marketplace
  • +
  • Provide a benefit to either server owners or it's players
  • +
  • Reputable development team
  • +
+ +This is not a definitive list and may change as we add more plugins diff --git a/folder/nl/src/content/docs/guides/Minecraft/Optimisation/advanced.mdx.mdx b/folder/nl/src/content/docs/guides/Minecraft/Optimisation/advanced.mdx.mdx new file mode 100644 index 0000000000..3c1d364a04 --- /dev/null +++ b/folder/nl/src/content/docs/guides/Minecraft/Optimisation/advanced.mdx.mdx @@ -0,0 +1,107 @@ +--- +slug: guides/optimisation/advanced +title: Advanced Checklist +description: A more focused approach on squeezing out every last drop of performance at scale. +sidebar: + order: 3 +--- + +This section covers plugins that you can modify/replace to improve performance. Only recommended at higher player counts. + +#### TAB + +The plugin author's optimisation guide is linked below.. The `anti-override` options are especially important as TAB's overriding is quite intensive. An additional config worth changing to false is `unlimited-nametag-mode`. + +Regarding anti-override, first make sure that none of your plugins mess with the tablist or scoreboard other than TAB itself. Some common culprits might be BetterTeams, eGlow, Paper's collision rules and CMI. + +You will have to remove eGlow in order to take full advantage of this optimisation. Once you're done modifying/removing such plugins, make sure `enable-player-collisions` in Paper's configuration is true. After you do that, you can disable player collisions in TAB's config by changing `scoreboard-teams.enable-collisions`. + +Finally, switch `anti-override` from true to false. If your tablist does not have proper order, an external plugin is probably still modifying the tablist. + +
+Guide +
+ +--- + +#### ProtocolLib & it's Dependants + +ProtocolLib is not very well optimised. Lots of plugins also abuse ProtocolLib a lot, causing even worse performance. Examples are DeluxeCombat (If ProtocolLib hook is enabled) and InteractiveChat. Removal has resulted in significantly better performance in all large servers. + +Consider finding alternatives to plugins that use ProtocolLib, or fork them to use PacketEvents. + +--- + +#### Citizens + +Citizens often eats up >5% of ticks on larger servers. It is recommended that you use ZNPCsPlus instead if you don't mind a smaller catalogue of supported plugins. Overall, ZNPCsPlus was using 0.03% of the ticks at 330 players according to a spark report. + +
+GitHub +
+ +--- + +#### ajLeaderboards + +Although ajLeaderboards has seen great optimization patches in recent times, it is still a tad laggier than it really should be. We recommend LeaderHeadsRevamped instead. Yes, LHR still works perfectly even though it hasn't seen an update in ages. + +If you insist on using ajLeaderboards, make sure `register-lp-contexts` is set to false. + +
+Spigot +
+ +--- + +#### AntiCheat + +Vulcan as an anti-cheat does not scale well at higher player counts, where every bit of performance matters. >1.6% ticks eaten at 350+ players is supoptimal. AstroAC on the other hand only eats 0.03% of ticks at 330 players while having checks that are almost as good as Vulcan's. + +Polar might also be worth it but we have yet to check it's performance at higher player counts + +Spartan (Both Java and Bedrock) is an absolute no-go for even medium-sized servers. Performance is extremely poor and checks are subpar. + +
+Astro +
+ +--- + +#### FastAsyncWorldEdit + +Although FAWE performs far better than WE when it's actually being used for building, it's performance is, rather ironically, significantly worse than standard WorldEdit's at idle due to FAWE listening to player interaction events. + +If you nor any of your plugins are actively using FAWE, consider switching to standard WorldEdit. + +--- + +#### Vanish Plugins + +It is recommended to use AdvancedVanish instead of plugins like SuperVanish and PremiumVanish as their performance is rather poor in comparison. + +
+Spigot +
+ +--- + +#### Geyser + +To offload Geyser's performance impact on your Spigot/Proxy server, you can use Geyser Standalone. Worth it for servers that have a lot of bedrock players. + +#### DiscordSRV + +If you are fine with losing a few features, consider replacing DiscordSRV with Essentials Discord as it isn't as bloated. + +#### Auction House Plugins + +zAuctionHouse is recommended as it runs the smoothest while also having the most features. PlayerAuctions is an alright alternative if you want a free plugin, but it's performance is marginally inferior. Consider enabling zAuctionHouse's cacheItems setting as well. + +#### Stacking Plugins + +Stacking plugins can be very detrimental to server performance depending on their implementations and configurations. RoseStacker is the best we've used thus far, but might end up lagging the server a bit more than if you didn't have it installed. + +#### WorldGuard + +WorldGuard allows you to prevent it from listening to certain events in it's configuration file. Could prove useful for very specific servers, but not something the average server should tinker with. diff --git a/folder/nl/src/content/docs/guides/Minecraft/Optimisation/intro.mdx.mdx b/folder/nl/src/content/docs/guides/Minecraft/Optimisation/intro.mdx.mdx new file mode 100644 index 0000000000..e5952e9a46 --- /dev/null +++ b/folder/nl/src/content/docs/guides/Minecraft/Optimisation/intro.mdx.mdx @@ -0,0 +1,29 @@ +--- +description: This section of setup.md goes in-depth for server optimisation +slug: guides/optimisation +title: Introduction +sidebar: + order: 1 +--- + +A section for optimising Minecraft servers. Optimising your server means to improve the performance of the server by implementing tweaks without heavily modifying desired mechanics. Advanced optimisation is only recommended for large servers suffering from poor performance. + +### Spark Profiler + +You should use the Spark Profiler for monitoring server performance e.g. vanilla mechanics, plugins, GC pauses and cycles, memory usage etc. + + + +### Server JAR + + is currently the fastest, most stable free Paper fork available. Another alternative would be [Purpur](https://purpurmc.org/downloads), which provides additional mechanics for players at the expense of rather negligible performance loss against Pufferfish. +As for proxies, [Velocity](https://papermc.io/software/velocity) is easily the best option. Although it doesn't have as many plugins as Bungeecord, it is far more stable and secure by default. Most popular plugins have already added support for Velocity. + +You may also want to take a look at [UniverseSpigot](https://polymart.org/resource/universespigot-1-20-1.4805). Highly recommended for servers with player counts exceeding 200 (and experiencing lag, of course). It's $70 price tag is certainly worth it. Do be careful with what settings you change as they can drastically affect gameplay. + +| Topic | Summary | +| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Basic Optimisation | Tweaks that will likely suffice for small to medium-sized servers (\< 100 Players) assuming that they have sufficient CPU & memory resources. | +| Advanced Optimisation | Tweaks made for larger servers with at least 150 players. | diff --git a/folder/nl/src/content/docs/guides/Minecraft/Plugins/luckperms.mdx.mdx b/folder/nl/src/content/docs/guides/Minecraft/Plugins/luckperms.mdx.mdx new file mode 100644 index 0000000000..eb154cf5c6 --- /dev/null +++ b/folder/nl/src/content/docs/guides/Minecraft/Plugins/luckperms.mdx.mdx @@ -0,0 +1,98 @@ +--- +description: Learn about the Luckperms plugin and how to get a basic configuration up and running. +slug: guides/luckperms +title: Luckperms +lastUpdated: 2024-01-01 +sidebar: + badge: + text: Advanced + variant: note +--- + +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +### The Basics + +LuckPerms embraces many concepts like "Inheritance" or " Contexts" that might be confusing for a beginner. Consider this section a breakdown of those. + +:::info +For a more in depth explanation of the plugin, one might use the [official wiki](https://luckperms.net/wiki). + +#### Permissions + +A permission is simply put just a piece of text that plugins use to determine what a player can do. They are usually split by periods (like `minecraft.command.kick` for the vanilla /kick command). A permission can have 3 states: + +- `true`: the player can then use the feature which is associated to the permission +- `false` the player is explicitly revoked access to this command or feature. +- undefined: this permission has not been set for this group and defaults to either `true` or `false`, depending how the plugin which uses the permission has determined. + +#### Groups + +A group (or a "rank" as some prefer to call it) is a collection of permissions and other kinds of data which can be given to a player. This simplifies management of, lets say, the staff team as you can simply create a group `admin` and grant it `*` (this permission automatically allows access to everything) which can then be given to your admins and they will all have the same permissions. In this example it might seem counter intuitive, but for ranks with 100s of different permissions, it will become useful. +::: + +One Group always exists: `default`. As its name implies, everybody is in this group, and it is used to give out permissions which every player should have. + +#### Inheritance + +Inheritance is very useful to minimise repeated work. Let us consider the following example: +You have a group `VIP` and a group `MVP`. The group `VIP` is only used to **add** features on top of the `MVP` group. Yet by setting the users group to `MVP`, they would have the permissions from `VIP` revoked. This is where inheritance comes into play. You can make `MVP` inherit `VIP`, so every permission that is granted to `VIP` is automatically reflected in the permissions of `MVP`. + +#### Contexts + +Contexts define the circumstances under which a permission or other data is applied. Still confused? + +Lets take the `gamemode` context as an example. Giving a permission to a player with the context `gamemode=creative` means that they player shall only have that permission if they are in game-mode creative. Quite simple, isn't it? Many plugins add their own contexts, such as EssentialsX' `vanished` pr `god`. + +--- + +### First Steps with LuckPerms + +#### Storage + +Your first step with LuckPerms will be choosing a storage solution. This is a very extensive topic, as each of the storage types come with their own advantages and disadvantages. +A good write up on this would be the [official article](https://luckperms.net/wiki/Storage-types) in the LuckPerms wiki. Essentially there are 3 types of storage: + +- Flat file (In-memory-databases, they work out-of-box) +- Text file (Slower than flat-file, but editable and readable in plain text) +- Database (fastest, readable, but requires an external Database Server) + +In case you run a multi-server setup (e.g. BungeeCord) your only option is a Database! + +#### Your First Commands! + +Once you have LuckPerms installed, you will notice that you do not have access to its primary command `/lp`. You could set it all up through your console, but for the sake of simplicity the command `lp user permission set * ` will give your player full access to every command to simplify the setup. + +Now that that's out of the way let's get started! + +Let's say we want the following architecture: + +![Ranks Example](https://smd.gg/d0bgqaa) + +This structure would allow us to use LuckPerms "promote" feature to, well, promote people. But for that to work, you have to setup "tracks" which the command should follow. Let's say for example you promote a `default` player. They should become a `VIP` and not an `Admin`! + +First we have to create all those groups. Which is simple enough. It's just `/lp creategroup `! + +LuckPerms has many features to edit in its groups and it might overwhelm you at the beginning. But really the only parts you need to know right now are `permission`, `parent`, `meta` and `setweight`. The rest are rather advanced or generally not needed. You already know how to add permissions, so go ahead, give out all the permissions you want your groups to have! In case you screw up somewhere, there always is `unset` to revoke it. +In order to setup the inheritance/promote feature, you simply have to use the `parent` subcommand like this: `/lp group admin parent add mod` or generically `/lp group parent add `. + +That's the entire magic! Your setup is now working! + +#### Prefixes and Rank Tags + +LuckPerms does include the ability to set prefixes and suffixes in its `meta` submenu. But it does not apply them on its own! For that you need other plugins. A general plugin you will need is [Vault](https://dev.bukkit.org/projects/vault). For now don't worry about what Vault on its own does, just know that it's important! + + This intro will be split into 2 parts: Chat and Nametags (Tablist or above the playerhead). + +##### Chat + +There is no end to the list of chat formatting plugins. Most of them offer support to customize your chat format, and as such your prefixes too. It really depends on the specific plugin, but most ones will have a placeholder which you can include in the chat format. + +#### Tablist and Nametag + +The entire story is a different one when we move to the Tablist part of this guide. There are only really 2 options: + + + + + diff --git a/folder/nl/src/content/docs/guides/Minecraft/Plugins/terra.mdx.mdx b/folder/nl/src/content/docs/guides/Minecraft/Plugins/terra.mdx.mdx new file mode 100644 index 0000000000..e20903f78d --- /dev/null +++ b/folder/nl/src/content/docs/guides/Minecraft/Plugins/terra.mdx.mdx @@ -0,0 +1,85 @@ +--- +description: Configure a Terra world gen world for use in both Single and Multiplayer environments. +slug: guides/terra +title: Terra World Generation +lastUpdated: 2024-03-04 +--- + +import MainStatusPill from '../../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +The setup.md wiki provides Terra worlds available for download monthly, the principle of this guide can be used in situations with / without our pre-provided files if you wish to generate things for yourself. + +Before continuing with configuring Terra we are assuming the following: + +
    +
  • You are using one of our provided world files
  • +
  • You are running atleast version 1.20.4
  • +
+ +Make sure you download one of our maps via our 'Additional Services' page. + + + +You will then need to scroll down to one of the following topic headers to complete setup. + +
    +
  • Paper & Forks
  • +
  • Fabric & Forge
  • +
+ +### Paper & Forks + +Download the latest `.jar` file from the Modrinth page using the link below and add it directly to your `/plugins/` folder inside the server directory. + + + +You will also need to append the following changes to the end of your `bukkit.yml` file **BEFORE** launching your server, this will ensure your server uses the Terra world gen plugin. + +``` +... + +worlds: + world: + generator: Terra:OVERWORLD + +... +``` + +Once this has been complete you can upload and unzip the World.XXXXXXX.zip folder into your server directory. This will automatically extract into a `world` folder and you should be ready to start your server. + +console logs + +Once the server is powered on, check for the three lines highlighted above. If these are displayed that means Terra is responsible for your world and chunk management / generation going forward. + +--- + +### Fabric & Forge + +Download the latest `.jar` file from the Modrinth page using the link below and add it directly to your `/mods/` folder inside the server directory. + + + +Add the following key to your `server.properties` file **BEFORE** launching your server, this will ensure your server uses the Terra world gen plugin. + +``` +... + +level-type=terra:overworld/overworld + +... +``` + +Once this has been complete you can upload and unzip the World.XXXXXXX.zip folder into your server directory. This will automatically extract into a `world` folder and you should be ready to start your server. diff --git a/folder/nl/src/content/docs/guides/Minecraft/Self-Host/Standalone (Java)/linux.mdx.mdx b/folder/nl/src/content/docs/guides/Minecraft/Self-Host/Standalone (Java)/linux.mdx.mdx new file mode 100644 index 0000000000..8e56d7ccf9 --- /dev/null +++ b/folder/nl/src/content/docs/guides/Minecraft/Self-Host/Standalone (Java)/linux.mdx.mdx @@ -0,0 +1,230 @@ +--- +description: If you're just looking to setup a Minecraft server within Linux on your own personal machine then this is the tutorial for you. +slug: guides/self-host/linux +title: Linux +--- + +If you're in the position where you want to host a Minecraft server but you don't want to learn or interface with the command line too frequently then Windows will most likely be your OS of choice either on your own PC or a spare machine you have around the house. + +This guide will not cover the basics of deploying Windows, securing your OS and patch automation as we have already covered those within our [lab](https://setup.md/guides/lab) series. + +### Installing Java + +The first thing you need to do is ensure you have installed the relevant Java JDK version for your desired Minecraft version. The latest release of Minecraft (1.20.1) currently uses Java 17 so that is the version we will be installing in this tutorial. + +Ubuntu uses the `APT` package manager, it's generally considered a good idea to run the following commands before trying to install an application for the first time. + +```bash +... + +sudo apt update +sudo apt upgrade -y + +... +``` + +Once you've ensured the package list has been updated and installed packaged upgraded you can proceed with installing java depending on which Minecraft version you're looking to install you may need to change this command slightly. + +To identify which versions of JRE are installable you can run the following command. + +```bash +... + +apt search "jre-headless" + +... +``` + +This should result in the following output. + +```bash +... + +Sorting... Done +Full Text Search... Done + +default-jre-headless/stable,stable 2:1.11-72 amd64 + Standard Java or Java compatible Runtime (headless) + +openjdk-11-jre-headless/stable,stable-security,stable,stable-security 11.0.14+9-1~deb11u1 amd64 + OpenJDK Java runtime, using Hotspot JIT (headless) + +openjdk-17-jre-headless/stable,stable-security,stable,stable-security 17.0.2+8-1~deb11u1 amd64 + OpenJDK Java runtime, using Hotspot JIT (headless) + +... +``` + +:::info +Java 16 was not an LTS release and therefore isn't present in the list. + +You can now run the following command changing the `version-number` to determine if you would like to install Java 8, Java 11 or Java 17. + +::: + +```bash +... + +sudo apt install "openjdk-17-jre-headless" -y + +... +``` + +The above command will install Java 17 and will allow for us to create a server using the latest builds. You can confirm this has installed successfully by running the following command. + +```java +... + +java --version + +... +``` + +The above command should print out the latest build number for the Java 17 release we have just installed. If you have any errors you can checkout the following guide [troubleshooting java](/ts/java). + +### Creating the Minecraft server + +We are nearing the end of this guide, only a few more things to do! + +Before we download anything, we should make a directory to put our server in. You can do this by typing the following commands. + +```bash +... + +mkdir minecraft-server-folder +cd minecraft-server-folder + +... +``` + +Now we can deploy the server jar we're wanting to use, this tutorial will reference [purpur](https://purpurmc.org) but there are plenty of other server platforms and [this page](/t/server-software) explains the pros and cons of the major ones. + +```bash +... + +wget https://jar.smd.gg/download/purpur/latest/latest --content-disposition + +... +``` + +By adding the `--content-disposition` we're preventing the downloaded file being an extension-less file called `download`. + +To confirm the file has downloaded correctly you can use the `ls -al` command to display the contents of the `minecraft-server-folder`. + +```bash +... + +-rw-r--r-- 1 root root 42329978 Jul 9 08:07 purpur-1.20.1-2058.jar + +... +``` + +In order to start our server we need to create a file that accepts the EULA for Mojang. This can be done with the following command. + +```bash +... + +bash -c 'echo "eula=true" > eula.txt' + +... +``` + +We can now run the following command from the console in order to start our server, this will start the server and create all of the files it needs to run as expected. + +```bash +... + +java -Xmx4G -Xms4G -jar purpur-1.20.1-2058.jar nogui + +... +``` + +Once you see the line `Done in (seconds)` you can press `shift + c` to end the session or type `stop` like a normal server. + +So now technically everything is setup and ready - If your newly created VPS was sitting in your house you would be able to play right now... but it's not - so we need to open the 25565 port to the internet. + +#### Making it accessible over the internet (Port Forwarding) + +While we're still connected via SSH it will save time later for us to configure the servers local firewall now. + +:::info +This tutorial uses Ubuntu and UFW. If you chose another another distro at the start of this guide you will most likely have a different wrapper, if this is the case you will need to consult the docs for how best to open ports 25565 for TCP and UDP traffic. +::: + +To open TCP and UDP traffic within Ubuntu we need to use the following commands. + +```bash +... + +sudo ufw allow 22/tcp #this will allow us to continue SSH access +sudo ufw allow 25565/tcp #this will open the tcp port 25565 (minecraft game) +sudo ufw allow 25565/udp #this will open the udp port 25565 (minecraft query) +sudo ufw enable + +... +``` + +You can check UFW has successfully deployed and enabled by typing the following command. + +```bash +... + +sudo ufw status + +... +``` + +Switching back to the server, you should now be able to start the server again using the same command we used previously. + +```bash +... + +java -Xmx4G -Xms4G -jar purpur-1.20.1-2058.jar nogui + +... +``` + +You are now technically complete, you should be able to join your newly created server using the IPv4 address of the Linux box you're hosting on... There's a couple of things to note in the below 'Optional Configuration' settings which will help you down the line. + +#### Optional Configuration + +The above steps will get you up and running with the basics, but some settings can be adjusted further to make life easier for yourself as an admin. + +##### Adjusting RAM Allocation + +We go over adjusting the RAM allocation in more depth [here](/t/flags). + +##### Installing 'Screen' + +Screen is an application that allows for you to run your server in the background even after you close your SSH session. + +To install screen run the following command. + +```bash +... + +sudo apt install screen -y + +... +``` + +Now screen has been installed you can run the following commands to launch your server within screen. + +```bash +... + +screen +java -Xmx4G -Xms4G -jar purpur-1.20.1-2058.jar nogui + +... +``` + +To exit the screen session you should press `CTRL + A + D`. You should now be able to close the command prompt window without the server crashing. If you need to return to your screen windows you can use the command `screen -r`. + +##### Installing Plugins + +We go over installing plugins in more depth [here](/e/pl). + +##### JVM Flags (Aikar) + +We go over adjusting the start-up flags in more depth [here](/t/flags). diff --git a/folder/nl/src/content/docs/guides/Minecraft/sftp.mdx.mdx b/folder/nl/src/content/docs/guides/Minecraft/sftp.mdx.mdx new file mode 100644 index 0000000000..636a76aeff --- /dev/null +++ b/folder/nl/src/content/docs/guides/Minecraft/sftp.mdx.mdx @@ -0,0 +1,84 @@ +--- +description: Learn how to upload files to Pterodactyl panels using SFTP. +slug: guides/using-sftp +title: Using SFTP +lastUpdated: 2024-08-10 +sidebar: + badge: + text: New + variant: success +--- + +import MainStatusPill from '../../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you're new to hosting a Minecraft server and you are looking to bring across a world file of your own or upload some plugins / mods to make your experience a little bit better, +this guide will focus on using SFTP in order to get around the 100MB file upload limit of the web-based file manager. + +### Requirements + +Depending on your computers operating system you will need to download one of the following SFTP tools, our tutorials will use FileZilla because this is cross platform. + +#### Windows + +The following clients are free for Windows users, there are alternatives however these are the most common and best supported solutions. + + + + + + +#### MacOS + +The Mac has a whole suite of paid SFTP products on the App Store however FileZilla is also Mac native and is the solution we recommend for this platform. + + + + + + +#### Linux (Deb) + +For simplicity we're also recommending FileZilla for Debian based distros. + + + +--- + +### Identifying your Credentials + +Once you have installed FileZilla the next step is for you to get connected to your Minecraft server. You can find the information within your provider panel, most providers are now using Pterodactyl so you need to find the following block of information below\*. + + +*Depending on your provider your panel will look different but they will all display this set of information +
+Copy the information from the `SFTP Address` and `Username` fields we will need this information within our FileZilla client. + +:::note + +Your SFTP password will be the same password you use to login to the panel, you can also configure SSH keys to use with SFTP but that is out of scope for this tutorial. +::: + +--- + +### Configuring FileZilla + +Once you have the information we're going to 'create a site' so we don't need to input this data everytime we want to file transfer, to do this select the site manager in the top left corner. + + + +Select 'New Site' and you can now fill in the section on the right hand side, you should change Protocol from FTP to SFTP else you will run into issues while connecting. + + + +Once you have copied this information over you should press 'Connect' and you will be presented with one final confirmation window, select 'Always trust this host' and then press 'Ok'. + + + +You will now be connected to your server via SFTP, you can upload/download, edit or delete files from the highlighted window below. + + diff --git a/folder/nl/src/content/docs/guides/OVH/Optional/Configuration/hardening.mdx.mdx b/folder/nl/src/content/docs/guides/OVH/Optional/Configuration/hardening.mdx.mdx new file mode 100644 index 0000000000..346dda5c95 --- /dev/null +++ b/folder/nl/src/content/docs/guides/OVH/Optional/Configuration/hardening.mdx.mdx @@ -0,0 +1,249 @@ +--- +description: Device hardening guide and and explantion of the tools used to complete such activities. +slug: guides/lab/hardening +title: Hardening +sidebar: + badge: + text: Recommended + variant: tip +--- + +This document is designed specifcally for those who want to tighten up windows and add some preventative measures to lock down their machine, it should be made known that the more you lock down a machine the less functionality it will have. + +You should find a balance for your own environment that works best for you by either disabling or enhancing the provided policies, this page breaks down the NCSC guidelines for systems hosting '[OFFICAL](https://smd.gg/jx9p7xw)' data. + +### Windows Home + +As home based editions of Windows cannot use Group Policy below are some things you should look into securing and enabling. + +#### Permissions + +When setting up a new environment it's easy to give anything and everything full admin credentials in order to get something up and running but STOP and take the time to do things right. You should consider implementing a [principle of least privilege](https://www.f5.com/labs/articles/education/what-is-the-principle-of-least-privilege-and-why-is-it-important) from the get-go as it: + +- Enables greater control over who can manage / change a system +- Reduces the level of damage compromised accounts can cause +- Reduces the attack surface (entry points) +- Reduces risk through error / negligence / internal malicious attacks + +While Home users can't use Group Policy for file permissions it can all be easily controlled via the Windows UI, as part of the least privilege principle this will assist in ensuring data access is only performed on a 'need to know' / 'required for function', you can find a good explanation for this [here](https://youtu.be/S-tTcRC5Q2A?t=123) + +#### Patching + +Patch Tuesday, the second Tuesday of every month is the most important Tuesday in the calendar for your computer. It's the day that Microsoft delivers important updates that will address potentially dangerous exploits that can give an attacker full complete access to your machine, unless the machine will never be connected to the internet again after being deployed you should enable 'Automatically check for Windows Updates' (in Windows 10/11 you shouldn't be able to disable this via the settings UI). + +#### Applications + +Firstly, every application on your system is a potential entry point for an attacker, if you're never going to use it then uninstall it! This includes Windows features too, it's recommended that you atleast uninstall the following Windows features: + +- Internet Explorer +- SMB 1.0 + +This can be done by going to 'Control Panel' > 'Uninstall a program' > 'Turn Windows features on or off' and removing the tickbox next to the above entries. + +:::tip +A reboot will be required after completing this step +::: + +#### Windows (Defender) Security + +The following settings are configured within 'Windows Security' application and _should_ be enabled by default but regardless it's important to check. + +- Reputation based scanning is configured under the 'App and Browser control' setting +- Core Isolation is configured under the 'Device security' setting + - Memory Integrity is also a feature enabled within this section but you will need to 'View details' before you can toggle this on +- Exploit protection is configured under the 'Device security' setting along side the below nested items for this category + - Control Flow Guard + - Data Execution Protection + - Mandatory ASLR + +#### Windows OS + +There are a couple of things that are recommended if you're not actively using these features, firstly disable bluetooth if you're not using it and secondly turn off auto play as it has previously been used to exploit systems. + +- Autoplay settings can be found under 'Settings' > 'Devices' > 'Autoplay' + +--- + +### Windows Pro / Enterprise + +You can download the Group Policy template files from [here](https://github.com/ukncsc/Device-Security-Guidance-Configuration-Packs/raw/main/Microsoft/Windows/GPO/NCSC_Windows_GPO.zip). + +#### App Guard Policies + +The Windows App Guard policy will make the following changes to your PC. + +- General hardening of Defender App Guard policies. + +#### App Locker Policies + +The Windows App Locker policy will make the following changes to your PC. + +- Allows only execution of Microsoft signed applications, dlls, installers, scripts and appx + +:::tip +Development machines should be excluded from this policy otherwise they may end up not being able to run the required tools. +::: + +#### Bitlocker Policies + +The Windows bitlocker policy will make the following changes to your PC. + +- Disables standby mode when sleeping +- Encrypts the drive with XTS-AES 128 +- Disables devices such as thunderbolt that have direct memory access while a device is sleeping +- TPM bitlocker settings are configured +- Deny write access to removable media for devices configured to work with another organisation + +#### Computer Policies + +The Windows computer policy will make the following changes to your PC. + +- Prevents login with personal Microsoft accounts +- Disables user trusted root CAs +- Disables the ability for users to trust certificates +- Defines trusted root CAs for the device to use +- Prevents lock screen camera +- Requires a domain admin to change network location +- Defines proxy values +- Prevents installation of devices that match X hardware IDs +- Prevents installation of devices that use drivers matching X setup classes +- Disables Windows 'PC-Phone' link +- Disables sign-in with picture login +- Disables clipboard history +- Disables clipboard sync across devices +- Disables upload and publishing of user activities +- Disables activity feed +- Blocks universal windows apps from launching with Windows runtime API +- Removes the display password button on login forms +- Disables telemetry gathering +- Disables diagnostic data viewer +- Disables windows-to-go +- Disables cortana +- Disables search the web in windows start menu +- Disables all store applications within the MS Store +- Disables the MS Store +- Disables syncronisation of windows settings +- Ensures defender is enabled +- Disables windows error reporting +- Ensures Windows Hello is enabled for TPM 2.0 and disables lower +- Removes access to 'pause windows updates' +- Disables preview builds of windows +- Ensures a semi-annual release channel is configured using Windows update for business +- Disables Edge data collection +- Disables further telemetry +- Removes local password reset questions +- Edge pre-loading tabs disabled +- Edge extension sideloading disabled +- Blocks non-admins from enterting the device into safe-mode + +#### Device Guard + +The Windows device guard policy will make the following changes to your PC. + +- Enables virtualisation based securty +- Ensures code integrity +- Ensures credential guard is configured +- Ensures secure boot and direct memory access protection is configured + +:::tip +When enabling this policy you will need to ensure the VMs are created with Nested support otherwise Credential guard will fail to deploy. Option B would be to disable the 'Turn on Virtualisation Based Security' policy located in 'Computer Configuration' > 'Policies' > 'Administrative Templates' > 'System' > 'Device Guard' +::: + +#### Device Health + +This policy can be considered optional unless the device is enrolled into SCCM or another MDM platform. + +- Enables Device Health monitoring and reporting services + +#### Firewall Settings + +You should add further rules here if additional services are required for the network otherwise additional device / group based policies should be created using the 'Duplicate' feature and adding additional policies. + +- Enables Windows firewall +- Blocks inbound connections (unless explicitly stated) +- Allows outbound connections +- For both 'Private' and 'Personal' network settings outbound connections are blocked +- Configures outbound rules for the following services + - DHCP + - DNS + - Kerbose + - LDAP + - NCSI Probe + +#### OneDrive Settings + +This policy is entirely optional for home / lab environments where Office 365 business / dev subscriptions are not present. + +- Prevents personal OneDrive accounts syncing + +#### User Settings + +This policy is entirely optional but recommended for laptops / busy environments. + +- Ensures screen lockout time is set to 600 seconds + +#### Windows Defender + +The Windows defender policy will make the following changes to your PC. + +- Enables block on first sight +- Enrolls device to Microsoft MAPs (requirement for 'block on first sight' to work) +- Send sample file analysis +- Ensures real-time protection is enabled +- Prevents app installation from sources outside of the Microsoft Store +- Ensures smart screen is configured for Windows +- Ensures smart screen is configured for Edge +- Prevents you from being able to bypass the smartscreen prompt + +#### Installation Guide + +For Active Directory deployments you should use `Group Policy Management Editor` to import the policies. + +For single machine deployments you should consider `Powershell` to import the policies, the below command may help. + +```powershell + +... + +import-gpo -BackupId {folder-name} -TargetName {gpo} -path {c:\full\path\to\folder} -CreateIfNeeded + +... +``` + +#### Closing Thoughts + +From using these settings within our own environment you will want to make some changes, most specifically in the following areas. + +- Windows Firewall (opening RDP will prevent you needing to use proxmox viewer) +- App Guard (you will want to add any core non-ms apps you use in this policy e.g. chrome, firefox, vscode... anything that isn't published by Microsoft Corporation) + +--- + +### Ubuntu Script + +You can download the post-deployment bash script from [here](https://github.com/ukncsc/Device-Security-Guidance-Configuration-Packs/tree/main/Linux/UbuntuLTS) and manually run it on the server. + +Ubuntu, unlike Microsoft, does not require a certain edition for the script to work, at the time of writing this script worked on the latest LTS build of Ubuntu. + +#### Script break down + +- Firstly the script must be run as 'sudo' +- Secondly it will fetch the admin user +- You will then need to select the administrator account that you created during installation +- You will confirm the app repositories +- The system will complete an update, upgrade and install app armour +- Grub password is configured +- Automatic updates are configured +- Prevents standard users executing as `super user` +- Protects home directories +- Modified shell access for other users on the machine except admin account specified +- Configures pw complexity +- Enables app armour +- Enables system audting +- Disables error reporting service +- Option to disable Bluetooth +- Configures 600s lock screen timer +- Modifies lockscreen behaviour +- Optional settings for location services, privacy and usb restrictions +- Fixes folder permissions +- Sets up UFW without any rules diff --git a/folder/nl/src/content/docs/guides/Services/domainpark.mdx.mdx b/folder/nl/src/content/docs/guides/Services/domainpark.mdx.mdx new file mode 100644 index 0000000000..bdc6eb1ca1 --- /dev/null +++ b/folder/nl/src/content/docs/guides/Services/domainpark.mdx.mdx @@ -0,0 +1,85 @@ +--- +description: Run a self hosted instance of domain-park.org for those extra domains you own but don't know what to do with. +slug: guides/domain-parking +title: Domain Parking +--- + +If you own multiple domains it may be worth looking into a service such as `domain-park` to ensure these domains remain secure while you're not using them. Thankfully domain-park is an open source project and implements the following features. + +- Best practices for SPF, DKIM, DMARC and MX compliance for parked domains +- Easy to deploy with no server configuration per domain +- Ability to configure DMARC reports + +If you do decide to run an instance (or two) of domain park you should aim for the following setup. + +- A domain you use for everything e.g. `servers.fun` +- A domain you want to park e.g. `urho.st` +- A VPS (or two) that have static (and public) IP addresses we can assign hostnames to +- A DNS management panel such as `Cloudflare DNS` + +:::danger +Cloudflare registry doesn't support using external name servers, if your domain you wish to park is registered with Cloudflare you will need to use an alternative solution. +::: + +--- + +### Creating a VPS + +If you're looking for a solid VPS provider, checkout Hetzner. You can use our affiliate link https://smd.gg/joinhetzner for €20 free credit and in return we'll also get a little bit back from Hetzner. + +If you're using Hetzner you should be able to get away with deploying x2 `CPX11 instances` with the latest LTS build of Ubuntu (Debian works too) which should set you back €9/mo. It's also recommended that you add an SSH key and avoid using password based authentication. + +--- + +### Setting up DNS (Active) + +So the first thing we will do is configure the DNS, this is because these _can_ take the longest to update in the background. + +- Login to your DNS provider and head to your DNS record section. +- Select 'Add' and create an `A Record` enter `one.ns` and point it to one of your VPS IPs + - **Optional**: If you have an IPv6 also add a `AAA Record` for the same hostname +- Repeat this but replace `one.ns` with `two.ns` + +:::tip + +If you're using Cloudflare for your "Active Domain" you should ensure the orange cloud is disabled. + +::: + +Once you have configured these addresses your DNS panel should look something like this. + +![IMG](https://uk.thot.cc/api/shares/U3NTk4N/files/7bb07f91-af5d-4741-bd3f-7cb20421e586?download=false) + +After a short while your records will have propagated and you should be able to check the A and AAA records for your hostname using a tool such as MXToolbox or the `dig` linux package. + +#### Dig Commands + +```bash +... + +dig one.ns.servers.fun A +dig one.ns.servers.fun AAA # Not configured in example + +dig two.ns.servers.fun A +dig two.ns.servers.fun AAA # Not configured in example + +... +``` + +Providing you replace `servers.fun` with your own domain you should see a response with the IP addresses you entered into your panel above. + +--- + +### Setting up DNS (Parked) + +On the domain you wish to park using your newly setup service you'll need to change your nameservers. You can do this within your domain's control panel (probably in a similar location to the DNS modification page). + +You should ensure you fill out the nameservers as per the screenshot below. Once these have been added correctly, save changes and await up-to 48 hours for this to complete. + +![IMG](https://uk.thot.cc/api/shares/Y2NjM0O/files/471bcb1d-42bf-4e52-a9b2-be56323eb3c5?download=false) + +When using these nameservers you will not be able to host **ANY** content via the domain as domain-park does not allow for it. We have configured our nameservers to redirect to this page when accessing any of our IPs / Hostnames directly. + +--- + +### Deploying Domain-Park diff --git a/folder/nl/src/content/docs/guides/Services/oracle.mdx.mdx b/folder/nl/src/content/docs/guides/Services/oracle.mdx.mdx new file mode 100644 index 0000000000..ad26338841 --- /dev/null +++ b/folder/nl/src/content/docs/guides/Services/oracle.mdx.mdx @@ -0,0 +1,330 @@ +--- +description: A modified version of the guide produced by u/Belaboy1095969 on the Admincraft reddit using Ubuntu LTS. +title: Oracle Cloud +slug: guides/oracle-cloud +--- + +:::note + +Due to the increased popularity of the Oracle free tier, services may not be available in your desired region at the time of creating your account. You can either use another region close to your playerbase, wait until free capacity becomes available within your desired region or migrate to a paid account. + +::: + +This guide originally comes from the Admincraft subreddit user [u/Belaboy1095969](https://www.reddit.com/r/admincraft/comments/qo78be/creating_a_minecraft_server_with_oracle_cloud/), with full prior permission we have re-uploaded this tutorial into our central repository. + +If you're looking to host a basic server that is kept online (for free, 24/7) that you and your friends can play on then this is the guide for you. This guide comes with the following expectations, further expansion on some of these points can be requested within the setup.md [discord server](https://discord.gg/pXaQgzneed) if required. + +### You Will Need + +- A ~~Java Minecraft Account~~ Minecraft license, as of 07 June 2022 these games are now [bundled together](https://www.minecraft.net/en-us/article/java---bedrock-edition-pc-out-june-7). +- A credit / debit card for oracle account verification (anti-bot process) + +--- + +### Getting Started + +This guide will assume you have already gone through the sign-up process for the [OCI console](https://signup.cloud.oracle.com/?sourceType=_ref_coc-asset-opcSignIn&language=en_US). Once this step has been completed you can follow the rest of this guide. + +#### Creating a Virtual Machine instance. + +Don't Panic! This part isn't as complicated as it sounds. Once you have finished setting up your account, click the "Create a VM instance" panel. + +![img1](https://preview.redd.it/lb6qbe1fd0y71.png?width=912&format=png&auto=webp&s=eb13c09a39b8c9b4d8e8d6a7de588d96a4847afe) + +Give your VM instance a name. Anything will work, but make it easily identifiable. You can leave the default (Root) compartment selected. + +![img2](https://preview.redd.it/z0fcocxpd0y71.png?width=792&format=png&auto=webp&s=99637b502a83ff60f5189a73a77cfb5a88304e7f) + +Now, Scroll down to the "Image and Shape" section. Make sure "Ubuntu LTS 22.04 (Or just the latest build)" Is selected. Then click "Change shape". Under "Shape series", Select "Ampere". Now set the amount of Ram and CPU Cores you would like. + +:::tip +You should allocate no less than 2 CPU Cores and 8GB of ram to the VPS. After you have finished selecting the shape, make sure the "Always free eligible" Tag is showing. + +![img3](https://preview.redd.it/32bkfk8te0y71.png?width=757&format=png&auto=webp&s=d7f50ceae622064c9590c9ef41f82afdce809fed) + +::: + +Next, we need to create a VCN (Or Virtual Cloud Network). If you already have a VCN, use that. If not, select "Create a Virtual Cloud Network" Copy the settings in the picture below! + +![img4](https://preview.redd.it/xtozv7u9f0y71.png?width=766&format=png&auto=webp&s=6d1c1643aa182fc52b418854d95763bc19996c90) + +We'll need an SSH Key pair to access the server remotely. To generate a keypair, tick the box that says "Generate a new keypair" and then download both the public and private keys. Don't lose these, or else you won't be able to connect to your server remotely! + +![img5](https://preview.redd.it/rzk6yq65g0y71.png?width=791&format=png&auto=webp&s=1fcc085a62f2235d9fd179bb9bff1625ed95055b) + +Leave the boot volume settings alone and hit "Create"! + +Once you hit "Create", you will be redirected to your VM details and your VM will be in a "Provisioning" state. Wait for it to be in a running state, which should take 30-60 seconds. Under the "Instance access", you should see an IP Address. Copy it. + +#### Connecting to your VM with SSH. + +There are multiple SSH clients out there from classics such as PuTTY and newer clients such as Termius. For simplicity and universal sake we will use a command prompt / terminal window. + +Open a command prompt / terminal window and type in the following command : + +```bash +... + +ssh root@ -i "path-to-ssh-private.key" + +... +``` + +As this is your first time connecting you'll need to 'accept' either by pressing `Y` or typing `Yes` in the confirmation box. You should then see a screen similar to the below. + +![img6](https://preview.redd.it/ix7ilvzyl0y71.png?width=970&format=png&auto=webp&s=580fa11dcbce68b0dc12bb9e2ddd8e3d832830fc) + +Our VM is now deployed and ready to configure with Java and our server. + +#### Installing Java + +Ubuntu uses the `APT` package manager, it's generally considered a good idea to run the following commands before trying to install an application for the first time. + +```bash +... + +sudo apt update +sudo apt upgrade -y + +... +``` + +Once you've ensured the package list has been updated and installed packaged upgraded you can proceed with installing java depending on which Minecraft version you're looking to install you may need to change this command slightly. + +To identify which versions of JRE are installable you can run the following command. + +```bash +... + +apt search "jre-headless" + +... +``` + +This should result in the following output. + +```bash +... + +Sorting... Done +Full Text Search... Done + +default-jre-headless/stable,stable 2:1.11-72 amd64 + Standard Java or Java compatible Runtime (headless) + +openjdk-11-jre-headless/stable,stable-security,stable,stable-security 11.0.14+9-1~deb11u1 amd64 + OpenJDK Java runtime, using Hotspot JIT (headless) + +openjdk-17-jre-headless/stable,stable-security,stable,stable-security 17.0.2+8-1~deb11u1 amd64 + OpenJDK Java runtime, using Hotspot JIT (headless) + +... +``` + +:::info +Java 16 was not an LTS release and therefore isn't present in the list. + +You can now run the following command changing the `version-number` to determine if you would like to install Java 8, Java 11 or Java 17. + +::: + +```bash +... + +sudo apt install "openjdk-17-jre-headless" -y + +... +``` + +The above command will install Java 17 and will allow for us to create a server using the latest builds. You can confirm this has installed successfully by running the following command. + +```bash +... + +java --version + +... +``` + +The above command should print out the latest build number for the Java 17 release we have just installed. If you have any errors you can checkout the following guide [troubleshooting java](/ts/java). + +### Creating the Minecraft server + +We are nearing the end of this guide, only a few more things to do! + +Before we download anything, we should make a directory to put our server in. You can do this by typing the following commands. + +```bash +... + +mkdir minecraft-server-folder +cd minecraft-server-folder + +... +``` + +Now we can deploy the server jar we're wanting to use, this tutorial will reference [purpur](https://purpurmc.org) but there are plenty of other server platforms and [this page](/t/server-software) explains the pros and cons of the major ones. + +```bash +... + +wget https://jar.smd.gg/download/purpur/latest/latest --content-disposition +# You can replace 'purpur' for 'paper' if you prefer. +wget https://jar.smd.gg/download/purpur/latest/latest --content-disposition + +... +``` + +By adding the `--content-disposition` we're preventing the downloaded file being an extension-less file called `download`. + +To confirm the file has downloaded correctly you can use the `ls -al` command to display the contents of the `minecraft-server-folder`. + +```bash +... + +root@vps:~/minecraft-server-folder# ls -al +total 41348 +drwxr-xr-x 2 root root 4096 Jul 9 16:59 . +drwx------ 7 root root 4096 Jul 9 16:59 .. +-rw-r--r-- 1 root root 42329978 Jul 9 08:07 purpur-1.19-1708.jar + +... +``` + +In order to start our server we need to create a file that accepts the EULA for Mojang. This can be done with the following command. + +```bash +... + +bash -c 'echo "eula=true" > eula.txt' + +... +``` + +We can now run the following command from the console in order to start our server, this will start the server and create all of the files it needs to run as expected. + +```bash +... + +java -Xmx6G -Xms6G -jar purpur-1.19-1708.jar nogui + +... +``` + +Once you see the line `Done in (seconds)` you can press `shift + c` to end the session or type `stop` like a normal server. + +So now technically everything is setup and ready - If your newly created VPS was sitting in your house you would be able to play right now... but it's not - so we need to open the 25565 port to the internet. + +#### Making it accessible over the internet (Port Forwarding) + +While we're still connected via SSH it will save time later for us to configure the servers local firewall now. + +:::info +This tutorial uses Ubuntu and UFW. If you chose another another distro at the start of this guide you will most likely have a different wrapper, if this is the case you will need to consult the docs for how best to open ports 25565 for TCP and UDP traffic. +::: + +To open TCP and UDP traffic within Ubuntu we need to use the following commands. + +```bash +... + +sudo ufw allow 22/tcp #this will allow us to continue SSH access +sudo ufw allow 25565/tcp #this will open the tcp port 25565 (minecraft game) +sudo ufw allow 25565/udp #this will open the udp port 25565 (minecraft query) +sudo ufw enable + +... +``` + +You can check UFW has successfully deployed and enabled by typing the following command. + +```bash +... + +sudo ufw status + +... +``` + +The next steps are to do the same things within the Oracle Cloud interface. You will need to look for the category "Primary VNIC". Click the "Public Subnet" link. + +![img7](https://preview.redd.it/puhdgco6s0y71.png?width=724&format=png&auto=webp&s=62c56c8262c55129000a90726e05aa4de4039d19) + +Then click the "Default Security list" link. + +![img8](https://preview.redd.it/2poaepmcs0y71.png?width=537&format=png&auto=webp&s=3fa87f551aa084e5fb23699c670dab2a4d6c4d8a) + +And Add an "Ingress Rule". Copy the configuration shown here ,Then create another ingress rule with the same configuration, but change the "IP Protocol" to TCP, as shown below. + +![img9](https://preview.redd.it/23cjw70hs0y71.png?width=756&format=png&auto=webp&s=e33b04dab55c625d3fc68fd15c1d6adc7871c78c) + +Switching back to the server, you should now be able to start the server again using the same command we used previously. + +```bash +... + +java -Xmx6G -Xms6G -jar purpur-1.19-1708.jar nogui + +... +``` + +You are now technically complete, you should be able to join your newly created server and share the IP with your friends... There's a couple of things to note in the below 'Optional Configuration' settings which will help you down the line. + +#### Optional Configuration + +The above steps will get you up and running with the basics, but some settings can be adjusted further to make life easier for yourself as an admin. + +##### Adjusting RAM Allocation + +We go over adjusting the RAM allocation in more depth [here](/t/flags). + +##### Installing 'Screen' + +Screen is an application that allows for you to run your server in the background even after you close your SSH session. + +To install screen run the following command. + +```bash +... + +sudo apt install screen -y + +... +``` + +Now screen has been installed you can run the following commands to launch your server within screen. + +```bash +... + +screen +java -Xmx6G -Xms6G -jar purpur-1.19-1708.jar nogui + +... +``` + +To exit the screen session you should press `CTRL + A + D`. You should now be able to close the command prompt window without the server crashing. If you need to return to your screen windows you can use the command `screen -r`. + +##### Installing Plugins + +We go over installing plugins in more depth [here](/e/pl). + +##### JVM Flags (Aikar) + +We go over adjusting the start-up flags in more depth [here](/t/flags). + +--- + +### **Disclaimer** + +This guide has been modified slightly to cater for the needs of this project, setup.md has adjusted the following from the original article. + +- Moved from Oracle Linux to Ubuntu LTS +- Moved some Optional Configuration topics to either their own pages within our KB / hyperlinked to existing documents (this prevents topic duplication). +- Ordering / Combining of steps in relation to EULA and port forwarding. + +--- + +### Additional Note + +While Oracle cloud is great, ARM CPUs will fall short in high-demand workloads when it comes to Minecraft servers. If you find yourself outgrowing the Oracle instance you can check out the following [hosting guide](/h/types). diff --git a/folder/nl/src/content/docs/hosting/bad-rep-providers.mdx.mdx b/folder/nl/src/content/docs/hosting/bad-rep-providers.mdx.mdx new file mode 100644 index 0000000000..353bc7ff76 --- /dev/null +++ b/folder/nl/src/content/docs/hosting/bad-rep-providers.mdx.mdx @@ -0,0 +1,6 @@ +--- +title: Bad Rep Hosts +description: A list of hosting providers that are considered 'summerhosts', reckless and just outright something you should avoid. +template: splash +slug: /h/bad-rep-providers +--- diff --git a/folder/nl/src/content/docs/hosting/hardware.mdx.mdx b/folder/nl/src/content/docs/hosting/hardware.mdx.mdx new file mode 100644 index 0000000000..5481009452 --- /dev/null +++ b/folder/nl/src/content/docs/hosting/hardware.mdx.mdx @@ -0,0 +1,52 @@ +--- +description: Picking the right hardware is the most important thing when it comes to hosting as it will determine how far you can push your ideas before you have to throttle back or risk destroying the user experience. +slug: h/hardware +title: Hardware +--- + +If you haven't identified the type of hosting you wish to go for it's highly recommended to read our [types of hosting](types) document first. + +:::note +The first point we want to stress is **do not go out and buy the latest flagship CPU for a single Minecraft server**. This is a complete waste of money and you will not be able to utilise the full CPU, you should however find a hosting provider that offers the desired CPU line up and use 'shared hosting'. +::: + +### CPU + +When it comes to finding a CPU (for Minecraft) the most important factor is the [IC](https://www.bbc.co.uk/bitesize/guides/z2342hv/revision/5), this consists of a fetch, decode, read and execute cycle all taking place to complete a single cycle. + +Depending on your workload, CPU Cache & Instruction Sets should also be considered as one CPU might be better at a particular set than another (it's important to complete your own research based on your needs). + +The myth of clock speed being the sole performance factor has been disproven many times over, Apple being the most famous example that often compared a lower clock speed PowerPC to the newer Pentium 3/4 line ups from IBM and similar. + +At its core Minecraft's main logic loop is a single thread this is a fundamental issue that dictates how it runs. Consequently, Minecraft is primarily concerned with single core performance. You still need at least two cores however, the second is to offload things like Garbage Collection and non core logic threads (networking, io) to so they don't steal time from the main loop. + +--- + +### RAM + +RAM is not nearly as important as people think, fast RAM is as important ([it's benefits only go as far as your chosen CPU](https://premiumbuilds.com/features/ryzen-ram-speed-benchmark-analysis/)) as the capacity and over capacity of RAM can hurt your performance (this is because the JVM garbage collector has more to collect and therefore this intensive CPU task takes longer causing lag spikes). + +The general consensus as of late 2022 is to start with using 4GB / 6GB but use no more than 12GB per individual server. + +Memory allocation and Java Flags go hand in hand with one another and some flags (specifically Aikar's) have some values that change based on the total RAM allocation to your server. + +If you're running in Docker consider overhead for the JVM, this should be about 1/2GB that you will need to compensate for (sometimes the host will take care of this step for you). + +--- + +### Storage + +For your server's live application data it's the current consensus to at least be using some form of flash storage as the random read/write speeds can help massively when it comes to users spawning in chunks all over the map. + +For backups you are still more than welcome to use spinning disks as this data hopefully isn't used as often - it's also possible to configure archival s3 based storage (cold-site) which could end up cheaper than buying and protecting your own disks. + +--- + +### Recommended Specs + +If you're looking for specific specs we'd recommend using the below as a baseline. + +| SKU | CPU | RAM | DISK | +| ---------- | --------------------------------------------------- | ---------- | ------------------------------- | +| Budget | Intel 9th - 12th Gen / Ryzen 9 3000 - Ryzen 7 5800X | 4GB - 6GB | 30GB (NVMe) | +| Enthusiast | Intel 13th & 14th Gen / Ryzen 9 5900X & 7000 Series | 8GB - 12GB | 75GB+ (NVMe) | diff --git a/folder/nl/src/content/docs/hosting/intro.mdx.mdx b/folder/nl/src/content/docs/hosting/intro.mdx.mdx new file mode 100644 index 0000000000..acbee77d6a --- /dev/null +++ b/folder/nl/src/content/docs/hosting/intro.mdx.mdx @@ -0,0 +1,22 @@ +--- +sidebar_position: 1 +description: The entry point for those looking to host a Minecraft server but don't know where to start. +slug: h +title: Where To Start +--- + +If you're looking to run a Minecraft server of your own there are multiple things you should consider. + +
    +
  • Where do you want to host it?
  • +
  • How do you want to host it?
  • +
  • Do you want the ability to be able to host more than Minecraft?
  • +
+ +Our goal is to cover all of this and offer our own recommendations on providers you can use for all possibilities, some key articles can be found below. + +| Topic | KB Article | Summary | +| ----------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| Service Offerings | [Types](types) | Identify what different types of hosting exist, what should be used and when. | +| Hardware | [Hardware](hardware) | The second most important decision is determining how powerful you need the hardware to be for the work you're wanting to push on it. | +| Providers | [CSPs](providers) | Non-biased recommendations for hosting providers based on previous experience and their industry position. | diff --git a/folder/nl/src/content/docs/hosting/os.mdx.mdx b/folder/nl/src/content/docs/hosting/os.mdx.mdx new file mode 100644 index 0000000000..f82b1b4301 --- /dev/null +++ b/folder/nl/src/content/docs/hosting/os.mdx.mdx @@ -0,0 +1,30 @@ +--- +description: Let's discuss the major operating systems that you will come across when hosting a Minecraft server. +slug: h/os +title: Operating Systems +--- + +When running a Minecraft server on [bare metal](/h/types/#bare-metal--vds), or a [VPS](/h/types#virtual-private-servers) you'll need to install a base operating system before you can get started. Unless you're running an apple device your options are Windows / Windows Server or Linux and the abundance of distros that come along with it. + +This page will explain the common choices available. + +
    +
  • Windows (Desktop and Server)
  • +
  • Ubuntu LTS
  • +
+ +### Windows + +If you're looking to host a server for your friends then the easiest option for self-hosting is Windows, you're already using it and if you're going to use a cloud provider for a server they will include a monthly fee for Windows Server. At their core both OSes are 'the same' and for Minecraft running a personal server within Windows 10/11 from your home PC will be fine. + +Moving to Windows Server will give you a couple of advantages, primarily longer OS support - these tend to follow a N+10 policy when discussing depreciation which is normally a good few years more than standard desktop releases. + +Windows Server OS is lighter out of the box and includes nothing but the core files needed to get Windows functional which compared to the desktop OS could see a perf gain with less resource wastage and can slightly reduce your attack surface by ensuring there are no little to none un-patched applications installed / configured. + +--- + +### Ubuntu LTS + +Unofficially you can also throw the base 'Debian' into this argument too however with Ubuntu Pro now becoming a free feature (for up to 5 devices) it's a huge win for the home lab. Ubuntu Pro offers 10 years of LTS patches so now follows a Windows Server like support plan which will save a lot of hassle needing to move your Instance from one release to another. + +If you want to get into the more professional side of hosting, Linux is the way to go - it's further optimised and will let you get the absolute most performance out of the hardware as possible. Day-to-day you will be interfacing with this OS through a command line but unlike Windows Server if you go to a CSP you won't be charged for these, web-based game management portals do exist for those on Linux who don't want to manage everything via the CLI. diff --git a/folder/nl/src/content/docs/hosting/panels.mdx.mdx b/folder/nl/src/content/docs/hosting/panels.mdx.mdx new file mode 100644 index 0000000000..a818326256 --- /dev/null +++ b/folder/nl/src/content/docs/hosting/panels.mdx.mdx @@ -0,0 +1,137 @@ +--- +description: You don't always want to be using the CLI to manage your server, consider a web panel and share the responsibility with your other administrators. +slug: h/ui +title: Panels +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you're running a Minecraft server the chances are you'll want an easier method of management, this is where panels come into play. Every [shared hosting](types#shared-hosting) provider will come with a control panel, this is how you'll interface with your server normally at a URL similar to https://panel.mydomain.com. Depending on how long the provider has been in business they'll either be using Multicraft or Pterodactyl (newer hosts using the latter). + +While Multicraft and Pterodactyl became the widely adopted platforms for Minecraft hosting this doesn't mean they're the only players in the game and with a VPS / Bare Metal you can install any one of a number of different solutions. We could write this article for the next six months documenting every single different panel and why it should be used but we're going to focus on a couple. + +The top 4 shortlisted panels this article will be covering are. + +
    +
  • AMP
  • +
  • Moonlight
  • +
  • Pterodactyl
  • +
  • PufferPanel
  • +
+ +### AMP Windows & Linux only + +AMP is a licensed panel produced by CubeCoders which supports both Windows and Linux including Ubuntu, Debian, Arch, Cent OS and more. CubeCrafters are by no means new to the hosting game, their previous product McMyAdmin launched all the way back in 2013. + +At this time there is **NO** Apple builds so for legacy McMyAdmin2 users this product may not be suitable for you unless you're running boot camp or run your servers on a different machine. + +#### Pros + +
    +
  • Community backed game contributions
  • +
  • Migration path for McMyAdmin2 users
  • +
  • One click/line installers
  • +
  • Proactive support
  • +
  • Support for many popular titles
  • +
+ +#### Cons + +
    +
  • Licensed
  • +
  • Multiple security requirements before installable (principle isn't a con but it's a pain)
  • +
  • Not open-source
  • +
+ + + + + + +--- + +### Moonlight Linux only + +Moonlight is an up and coming panel solution that is aimed towards those looking to replace Pterodactyl. The project is still in it's early phase and we've been pleased with the outcome so far in small scale testing and has therefore made our list as a one to watch. + +#### Pros + +
    +
  • Automatic plugin installer
  • +
  • Automatic SRV record creator
  • +
  • One click/line installers
  • +
  • Migration guide for Pterodactyl installs
  • +
  • Support for pterodactyl eggs (kind of)
  • +
  • Many more features constantly being added
  • +
+#### Cons +
    +
  • No billing support at this time
  • +
  • Lack of third party modifications
  • +
+ + + + + + +--- + +### Pterodactyl Linux only + +Multicraft had to die for Pterodactyl to breathe, an open source panel in active development and great support behind it. For those who like the sound of pterodactyl but not the self-hosting setup process you can look at the SaaS version [WISP](https://wisp.gg) which will cost you around $5 a month for the community plan. + +Pterodactyl boasts a two part setup, a web-server and a docker agent (wings) that only has official support for Linux. WSL has no official support same with Mac OS, you may find better luck utilising their 'panel-in-docker' and 'wings-in-docker' if you wish to attempt an install on either of these platforms. + +#### Pros + +
    +
  • ARM instruction set support
  • +
  • Billing integration for WHMCS / Blesta
  • +
  • Industry standard tool
  • +
  • Marketplaces for third party panel enhancements
  • +
+#### Cons +
    +
  • Complex multi-stage setup process
  • +
  • Setup support can be hit or miss (you're normally told to RTFM)
  • +
+ + + + + + + +--- + +### PufferPanel Linux only + +PufferPanel could have been the Pterodactyl industry standard tool today, a panel formerly developed by a Pterodactyl team member prior to a clashing of heads and a splitting of the product, however PufferPanel remains open source and in active development by the original founder and an long-time dev. + +The situation is the same for PufferPanel as it is for Pterodactyl, only has official support for Linux, however Windows builds are available (if unsupported). + +#### Pros + +
    +
  • One click/line installers via APT/YUM
  • +
  • ARM instruction set support
  • +
+ +#### Cons + +
    +
  • Lack of industry adoption / third party support
  • +
  • No billing modules
  • +
+ +:::note +PufferPanel (OSS Project) should not be confused with the proprietary puffer panel used by https://pufferfish.host, **these are two separate entities**. +::: + + + + + + diff --git a/folder/nl/src/content/docs/hosting/providers.mdx.mdx b/folder/nl/src/content/docs/hosting/providers.mdx.mdx new file mode 100644 index 0000000000..fbc621c431 --- /dev/null +++ b/folder/nl/src/content/docs/hosting/providers.mdx.mdx @@ -0,0 +1,207 @@ +--- +description: This page should be used as a reference to hosting providers and is not a substitute for their trustpilot and / or other clients real world experiences. +slug: h/providers +title: Providers +--- + +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +With the game becoming as big as it has done over the last decade there have been hundreds of hosting providers of past and present that either deliver high-quality services or awful services that someone could pay you enough to use daily. The goal with this page is to highlight a few trustworthy names in the Industry that meet the following criteria. + +
    +
  • Deliver to audiences at scale
  • +
  • Developed an overall positive reputation
  • +
  • Modernises hardware when required
  • +
  • Respectable end product for the price paid
  • +
+ +It should be made clear that none of the references below are sponsored. + +:::tip +If you don't know what kind of hosting you need, it's recommended to checkout the following article here to understand the different available platforms. +::: + +### Bloom.host + +Unparalleled price to performance with dedicated resources on high-end AMD Ryzen hardware and a bespoke customised version of the Pterodactyl panel. Bloom is also now a provider in the VPS and managed server solutions space across multiple regions. + +
    +
  • Locations: Ashburn, Dallas, Los Angeles, Miami, Falkenstein, Singapore (Performance+ plans only)
  • +
+ +#### Pricing + +
    +
  • Essentials MC 4GB: $10/month
  • +
  • Performance MC 8GB: $18/month
  • +
  • Performance+ MC 8GB: $24/month
  • +
+ + + +--- + +### EnviroMC + +EnviroMC is a quality Minecraft service provider that focuses on both the budget and high-end requirements of their customers, as of Sept. 19th 2022 URHOST clients will be absorbed into EnviroMC as part of a takeover agreement. EnviroMC also provides a VPS solution across the US, Europe and Asia. + +
    +
  • Locations: Falkenstein, New York, Singapore, Warsaw (VPS Only)
  • +
+ +#### Pricing + +
    +
  • Budget: $1/GB/month
  • +
  • Premium: $2.50/GB/month
  • +
  • Dedicated: See website for pricing
  • +
+ + + +--- + +### Hetzner GMBH + +It would be impossible to create a provider list and not include Hetzner, they currently stand as the German kings when it comes to high-end hardware at an ultra affordable price point. If you're running a large enough solution and just looking for the bare metal to run it on they should be food for thought. + +
    +
  • Locations: Ashburn (VPS Only), Falkenstein, Helsinki, Nuremberg (VPS Only), Vint Hill (VPS Only)
  • +
+ +#### Pricing + +
    +
  • Cloud Starting: €3.79/month
  • +
  • Dedicated Starting: €37/month
  • +
+ + + +--- + +### OVHCloud + +OVH, much like Hetzner, is a compute only provider meaning they specialise in Cloud services and Metal (the platform we use for Labs) + +
    +
  • Locations: Beauharnois, Frankfurt, Gravelines, London, Roubaix, Singapore, Strasbourg, Sydney, Vint Hill, Warsaw
  • +
+ +#### Pricing + +
    +
  • Cloud Starting: $3.50/month
  • +
  • Dedicated Starting: $56/month
  • +
+ + + +--- + +### MCHO.ST + +MCHO.ST is a hosting provider with both a free tier and a premium product, the latter using the Ryzen 8700G CPUs offering great price to performance with a brand new panel. + +
    +
  • Location: Nuremberg
  • +
+ +#### Pricing + +
    +
  • Free Tier: Free
  • +
  • 8700G Premium: £6.25/month
  • +
+ + + +--- + +### Pebblehost + +A long standing hosting provider that has modernised with the times offering a great budget service tier as well as offering tiers with additional performance those that require it. + +
    +
  • Locations: Coventry, Gravelines, Hillsboro, Montreal, Roubaix, Sydney
  • +
+ +#### Pricing + +
    +
  • Budget: $1/GB/month
  • +
  • Premium: $2.25/GB/month
  • +
  • Extreme: $2/GB/month (Min Order 6GB / 3 Threads)
  • +
+ + + +--- + +### WitherHosting + +A budget hosting provider with a global reach and an entry price point of 1$/GB utilising a range of both Ryzen and Xeon grade processors. + +
    +
  • Locations: Chicago, Dallas, Frankfurt, London, Los Angeles, Miami, New York, Singapore, Sydney
  • +
+ +#### Pricing + +
    +
  • Budget: $1/GB/month
  • +
  • Premium: $2/GB/month
  • +
+ + + +--- + +### Other Providers + +Yes, there are other great providers that haven't made our list for one reason or another - if you do decide to venture out and search for other providers some things we'd recommend you looking out for are + +#### Avoid These Things + +
    +
  • Don't use a host that makes you pay with a 'per-player slot' model - This is awfully dated and you should focus on resource based pricing instead
  • +
  • Don't use Mojang (Microsoft) Realms - This is an Azure backed platform designed for bedrock but also has Java presence, in the long run you will not have an enjoyable experience
  • +
  • Don't use a host that appears on a 'drama site' / forum - Hosts that make these lists tend to be awfully run and you'll have a bad time with them
  • +
+ +#### Look For These Things + +
    +
  • Do your own research, check the companies TrustPilot reviews etc to get an understanding of how the customers feel
  • +
  • Look for hosts that advertise hardware components and don't make you dig through pages of docs to get the information
  • +
  • Check the providers status page for a better understanding of reliability
  • +
+We'd also recommend you ensure your chosen provider hasn't ended up on our list of 'Summerhosts' + +
+ If in doubt ASK! Measure twice and cut once. diff --git a/folder/nl/src/content/docs/hosting/self.mdx.mdx b/folder/nl/src/content/docs/hosting/self.mdx.mdx new file mode 100644 index 0000000000..961a9fca34 --- /dev/null +++ b/folder/nl/src/content/docs/hosting/self.mdx.mdx @@ -0,0 +1,31 @@ +--- +description: So you want to host a Minecraft server yourself? Checkout your options and find the solution that suits your requirements. +slug: h/self +title: Self Hosting +--- + +When it comes to running everything yourself you have two options + +
    +
  • Rent hardware / compute in the 'cloud'
  • +
  • Provide your own hardware and run at a data centre / your house
  • +
+ +### Option 1 + +If you can afford it, this is your better option. While this is the most expensive option your monthly bill does include hardware, electricity, internet and in some cases ddos protection. A mid-range to high end service will cost you anywhere from 100$ per month in this regards so may not be suitable for those who don't already have an established community, we discuss this option a in a bit more depth [here](/h/types#bare-metal--vds). + +--- + +### Option 2 + +The cheapest option but is does require some additional thought however for one or two people this option may still make the most sense. + +
    +
  • Do you have a suitable internet connection? Firstly run a speed test, this will give you an idea of where your current connection sits. A 50mbps connection for both upload and download should be sufficient for your regular household activities **and** your Minecraft server, remember your connection is shared between all devices so downloading something on your internet e.g. steam games will reduce the available connection to Minecraft.
  • +
  • Do you have proper IPv4 addresses? Yes, Minecraft *can* support IPv6 but it requires all parties involved to also support V6 connectivity. You also need to consider if you have a [static IPv4 address](/ts/ip).
  • +
  • Have you considered the overhead to security, power utilisation, heat generated, noise produced and cost of hardware? Protecting the rest of your network can cost you either in man-hours or hardware if you need to purchase additional tools to get operational. This should all be considered before you commit to running things from home.
  • +
  • 24/7 Availability? If you're not prepared to run a server 24/7 from your home are you players happy with the fact a server will only be online for a few hours a day.
  • +
+ +If you do want to host things yourself we have documentation on how to do such things [here](/guides/self-host). diff --git a/folder/nl/src/content/docs/hosting/summerhosts.mdx.mdx b/folder/nl/src/content/docs/hosting/summerhosts.mdx.mdx new file mode 100644 index 0000000000..7e1d45292a --- /dev/null +++ b/folder/nl/src/content/docs/hosting/summerhosts.mdx.mdx @@ -0,0 +1,70 @@ +--- +title: Summerhosts +description: Summerhost - A service provider that is poorly ran and/or operating illegally which should be avoided. +slug: h/summerhosts +--- + +The term "Summerhost" is used for service providers that are poorly ran and/or operating illegally which should be avoided, below is a list of characteristics that will end you up on our avoid list. + +:::note + +For hosting providers that meet the requirements below but are not already on the list you can [submit an issue on GitHub](https://smd.gg/summerhost-addition). Providers that no longer meet the criteria defined below can request removal using [this link](https://smd.gg/summerhost-removal) + +Disclaimer: Information was accurate at the time of publication and may not reflect any recent changes we've not been made aware of. The list of providers below should be used as a reference point. This page mostly relies on publicly available information published by listed providers (and information that is not public will be displayed on this page). +::: + +### Avoid providers that feature the following: + +
    +
  • Businesses that do not contain contact details (ex. email & phone)
  • +
  • Website with false or missing information
  • +
  • Improper billing (discord checkout etc)
  • +
  • No Terms of Service or Privacy Policy
  • +
  • No SLA ("Service Level Agreement")
  • +
  • Oversold servers
  • +
  • Deceptive sales
  • +
  • Rigged reviews (ex. review rewards)
  • +
  • Obstructive Terms of Service that disallows doing basic stuff within the server (ex. pregenning)
  • +
  • Lack of basic features such as databases and backups
  • +
  • Pirating software used on the provider (ex. "nulled" WHMCS and other software)
  • +
  • Violating other project's rights (ex. selling licensed software without authorization)
  • +
  • GSP (Game Server Providers) that sell preconfigured FiveM servers (excluding Zap Hosting)
  • +
+ +#### Sources & Useful Tools: + +
    +
  • FiveM Documentation: https://docs.fivem.net/docs/support/ban-faq/#unauthorized-game-server-provider-gsp
  • +
  • FiveM Terms of Service: https://fivem.net/terms (5.8. Authorized & Unauthorized Services)
  • +
  • WHMCS License Checker: https://www.whmcs.com/members/verifydomain.php/verifydomain.php
  • +
  • Blesta License Checker: https://account.blesta.com/client/plugin/license_verify
  • +
+ +### Here is a list of providers that you should avoid with reasoning: + +| Provider | Reason | +| -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [ThunderNodes](https://thundernodes.cloud) | Improper (discord) checkout | +| [Luxe Hosting](https://my.luxe-hosting.nl) | No publicly available Terms of Service, Privacy Policy and SLA, missing publicly available information (regarding hardware), unauthorized GSP selling FiveM servers | +| [Proxynode](https://proxynode.pro) | No publicly available SLA | +| [Vellias Hosting](https://velliashosting.online) | No publicly available SLA & Privacy Policy, unauthorized GSP selling FiveM servers | +| [Lunes Hosting](https://lunes.host) | No publicly available SLA, missing publicly available information (regarding hardware), Terms of Service is a template (termly.io) | +| [Foxomy](https://foxomy.com) | Terms of Service that requires you to `"Identify as Black, Indigenous, Latino, Hispanic, Asian, Pacific Islander, or a Person of Color."` | +| [Crystallized Hosting](https://crystallized.host) | Missing publicly available information (regarding hardware) | +| [The Minecraft Hosting](https://theminecrafthosting.com) | Missing publicly available information (regarding hardware), no publicly available Privacy Policy & SLA | +| [Evix Datacenter](https://evix-datacenter.online) | No publicly available Privacy Policy & SLA, official account threatening to DDoS people ([1](https://smd.gg/lkn5vtl), [2](https://smd.gg/54owa1o), [3](https://smd.gg/flsgxnu), [4](https://smd.gg/x0omgfm), [5](https://smd.gg/mdp5sul)), official discord account using slurs ([1](https://smd.gg/fenwcql), [2](https://smd.gg/7p9co2m)) | +| [Skytale Hosting](https://billing.skytalehosting.net) | No publicly available Terms of Service, Privacy Policy & SLA, unauthorized GSP selling FiveM servers | +| [BlackNode](https://blacknode.pro) | [Bulletproof](https://www.urbandictionary.com/define.php?term=Bulletproof%20hosting) provider that promotes themselves for spoofed & bulletproof servers and botnets & DDoS tools | +| [Boundless Hosting](https://boundlesshosting.xyz) | No publicly available Privacy Policy, unauthorized GSP selling FiveM servers | +| [SpaceNode Hosting](https://spacenodehosting.com) | No publicly available Terms of Service, Privacy Policy & SLA, missing publicly available information (regarding hardware), unauthorized GSP selling FiveM servers | +| [PSB Hosting](https://psb.hosting) | [Bulletproof](https://www.urbandictionary.com/define.php?term=Bulletproof%20hosting) provider that promotes themselves for DMCA ignorant & bulletproof servers | +| [Realms Hosting](https://realmshosting.com) | Unauthorized GSP selling FiveM servers | +| [RAPIDHost](https://rapidhosting.cloud) | Unauthorized GSP selling FiveM & RedM servers, hardware information is unspecific (different processors in the "Xeon E-series" can have noticeable performance difference) | +| [proxied.host](https://proxied.host) | No publicly available Privacy Policy & SLA | +| [Nyxiality Hosting](https://nyxialityhosting.com) | No publicly available Terms of Service, Privacy Policy & SLA, missing publicly available information (regarding hardware) | +| [EmpireNodes Hosting](https://www.empirenodes.com/) | [Rigged reviews](https://www.trustpilot.com/review/empirenodes.com), no Privacy Policy | +| [Cosmic Hosting](https://cosmichosting.xyz) | No publicly available Terms of Service, Privacy Policy & SLA, unauthorized GSP selling FiveM servers | +| [HostSpace](http://hostspace.co.il/) | Improper (discord) checkout, missing publicly available information (regarding hardware) | +| [Tegra Hosting](https://tegra.gg/) | Fallback company made by ZTX, the companies lost data several times had their nodes suspended. | +| [Springracks](https://springracks.com) | Obstructive Terms of Service that disallows `running any task that will completely cap out the CPU limit set on your service` (What if there's just high load on your Minecraft server? Who knows!) | +| [EmpireNodes](https://empirenodes.com) | No Privacy Policy, Terms of Service that disallows `"Saying we are using fake ram"`, `Beg for new nodes` | diff --git a/folder/nl/src/content/docs/hosting/tls.mdx.mdx b/folder/nl/src/content/docs/hosting/tls.mdx.mdx new file mode 100644 index 0000000000..5111d1254a --- /dev/null +++ b/folder/nl/src/content/docs/hosting/tls.mdx.mdx @@ -0,0 +1,52 @@ +--- +sidebar_position: 2 +description: Identifiy the different tools available that can be used to help you deploy SSL certificates. +slug: h/ssl +title: TLS +lastUpdated: 2024-01-01 +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you're hosting more than just your Minecraft server, maybe you're using a Map service / forum / server store an SSL / TLS certificate is an absolute must. + +### Web Services + +If you're accessing the service via a web-browser then this part of the page will be for you, this will not cover successful deployment tutorials - we may decide to include this at a later time. + +#### Cloudflare + +This is the easiest solution to adding TLS capabilities to your website as Cloudflare can operate as a reverse proxy for the traffic allowing the SSL to terminate at their edge network and transit back to your origin server over HTTP (full SSL to origin is also supported). + + + +#### Caddy + +A self-hosted solution similar to Cloudflare but without the additional DDoS protection. Caddy supports automatic SSL deployment from any ACME provider on the market and is our provider of choice in conjunction with ZeroSSL. + + + +--- + +### Linux + +This is for tools suitable for generating certificates but perhaps might not be solely for web-servers. + +#### Certbot + +Certbot is a tool that can be deployed either as a Snap package or a Python module and is designed purely for generating valid Let's Encrypt certificates. The certificates generated from Certbot do not need to solely be used in a Web-Server and can be used system wide. + + diff --git a/folder/nl/src/content/docs/hosting/types.mdx.mdx b/folder/nl/src/content/docs/hosting/types.mdx.mdx new file mode 100644 index 0000000000..b5b659bff1 --- /dev/null +++ b/folder/nl/src/content/docs/hosting/types.mdx.mdx @@ -0,0 +1,60 @@ +--- +description: Understand the different types of hosting services available and what may be the best fit for your project. +slug: h/types +title: Types of Hosting +--- + +When you start looking at hosting your server online you'll see many different answers of which none are wrong, but they're not always suited to your needs. This page has a goal of helping you identify when you may need each type of hosting. + +The three most common types you'll find in forum responses are: + +
    +
  • Shared Hosting
  • +
  • Virtual Private Servers (VPS)
  • +
  • Dedicated Servers (Bare Metal / VDS)
  • +
+ +### Shared Hosting + +The most common type you'll find is 'Shared Hosting', this is where a hosting provider will own a physical server and partition the resources out to clients and you will connect to / manage your server via a [web panel](/h/ui) and SFTP. If you select this style of hosting you should be careful and note that some providers will oversell the resources. Overselling allows for them to provide cheaper monthly plans but may come at a performance hit due to this over allocation. Others will provide a dedicated quota that is only allocated to yourself, this will be slightly more expensive but you will have the entire quota to your disposal whenever you need it (plus it will still be cheaper than a VPS / Bare Metal). + +Traditionally this space was dominated by the likes of Nitrado, MCProHosting, Shockbyte etc... but in recent years players like [Bloom](https://bloom.host), [DedicatedMC](https://dedicatedmc.io) & [EnviroMC](https://enviromc.host) have dominated in this space offering Ryzen based solutions instead of the old school Xeons used by the legacy giants. + +--- + +### Virtual Private Servers + +The other common response you'll see people mention is 'grab yourself a VPS from Digital Ocean or Linode'. While you certainly can, it won't be much better than using [oracle cloud](/guides/oracle-cloud) on ARM (which is free). + +VPS instances have some differences to shared hosting, the core differences are. + +
    +
  • Linux knowledge is required for setup
  • +
  • Patching becomes your responsibility
  • +
  • Shell access which allows you to run more than just Minecraft servers
  • +
  • Slower but higher core count CPUs
  • +
  • You get a Dedicated IP address rather than a Shared one
  • +
  • You can install a custom panel such as [Pterodactyl](/h/ui#pterodactyl)
  • +
+There are times when a VPS can make sense, a prime example is using a VPS provider that uses consumer 'Gaming Grade' CPUs (Intel Core i9 / AMD Ryzen 7 / 9). These would provide the same experience for Minecraft as using a regular 'shared hosting' provider and it would allow you to host say a web / database server, a discord bot or anything else you could imagine. + +--- + +### Bare Metal / VDS + +The final common type of hosting you'll see people mention is, "go all out and own your hardware". While yes, this has some advantages for a novice the prospect of having no one around for support can be unsettling. Bare metal gives you full, dedicated, system normally in 32 / 64 or 128 GB RAM configurations with 256 / 512 or multi-TB disk configs. Bare metal can either be built yourself and shipped to a data centre for a monthly fee or you can rent from providers such as Hetzner, OVH or ReliableSite for a monthly fee. This option can set you back multiple hundreds of dollars per month and would only be recommended for larger scale deployments. + +Bare metal has a few advantages over the other types of solutions such as. + +
    +
  • Complete ownership of the server data
  • +
  • Complete ownership of physical and networking resources
  • +
  • Some providers will offer a managed solution for an additional fee
  • +
+Bare metal also carries the same differences to shared hosting as a VPS. + +:::tip + +If you don't already know what level of hardware you should be looking at then please consider reading our [hardware guide](hardware) first, then once you know what hardware and solution you're looking for head on over to our [recommendation page](providers) for vendors that can deliver what you're looking for. + +::: diff --git a/folder/nl/src/content/docs/index.mdx.mdx b/folder/nl/src/content/docs/index.mdx.mdx new file mode 100644 index 0000000000..be7147a922 --- /dev/null +++ b/folder/nl/src/content/docs/index.mdx.mdx @@ -0,0 +1,34 @@ +--- +title: Minecraft Admin Wiki +description: We're setup.md, the Minecraft administration wiki, written by enthusiasts and targeted to the novice. +template: splash +hero: + tagline: Your home of good information written by enthusiasts for the novice Minecraft server owner. + image: + file: ../../assets/houston.webp + actions: + - text: View the docs + link: /docs + icon: right-arrow + variant: primary + - text: Visit us on Github! + link: https://smd.gg/repo + icon: external +--- + +import { Card, CardGrid } from '@astrojs/starlight/components'; + + + + Behind the scenes our wiki has lost some weight as is built on the fastest framework to date! + + + Version 3 of the wiki launches with a focus on improving contribution requirements. + + + With V3 we now have the functionality to implement translations following the i18n standard. **SOON!** + + + We're still backed by the amazing members of the [Admincraft](https://smd.gg/acdiscord) community. + + diff --git a/folder/nl/src/content/docs/information/discord.mdx.mdx b/folder/nl/src/content/docs/information/discord.mdx.mdx new file mode 100644 index 0000000000..b9b210e8cc --- /dev/null +++ b/folder/nl/src/content/docs/information/discord.mdx.mdx @@ -0,0 +1,36 @@ +--- +description: We have a Discord server, check out the basics here. +title: Discord Server +slug: discord +--- + +All project contributors are volunteers and will carry the `project contributor` role within our server. + +Those that carry the `project lead` role are the core representatives of the project and should be the ones who are consulted on any issues within. + +A permanent invite to our server can be found here. + +### Ground Rules + +As with any public server, there are some rules that need to be followed. + +
    +
  • Be kind to one another
  • +
  • Don't be an ass, no one is paid to deal with your poor behaviour
  • +
  • Don't post any NSFW content
  • +
  • Follow the Discord community guidelines
  • +
  • Follow the Discord terms of service
  • +
+ +--- + +### Server Roles + +A brief overview of important roles within our server and how they are obtained. + +| Roles | Description | +| :------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Project Lead | This is a role that is reserved for first-party members of the project. | +| Project Contributors | Anyone who has submitted work for the Github repository is eligible for this role, you should have your Github account linked to your Discord account and publicly visible. | +| Community Nerds | People who have shown significant knowledge in areas and support the community without being a wiki contributor. | +| Sponsors | This role is automatically assigned to anyone who sponsors the project. (This role is not currently obtainable) | diff --git a/folder/nl/src/content/docs/information/eula.mdx.mdx b/folder/nl/src/content/docs/information/eula.mdx.mdx new file mode 100644 index 0000000000..42484d52c5 --- /dev/null +++ b/folder/nl/src/content/docs/information/eula.mdx.mdx @@ -0,0 +1,29 @@ +--- +description: Helping you navigate through the latest changes to Mojang's EULA. +slug: eula +title: Minecraft EULA +lastUpdated: 2023-08-02 +sidebar: + order: 4 + badge: + text: Important + variant: danger +--- + +If you're new to hosting a Minecraft server you should probably become familiar with what the EULA and CUG actually are. In short they're a scope of principles Mojang would like your server to adhere to at all times if you don't want it blacklisted at auth server level, these policies can change at any time and more often than not aren't published to Mojang's official channels e.g. Twitter. + +### Changes + +The following additional changes have been made which will affect the most amount of servers since the huge enforcements in 2014. + +
    +
  • All servers are now required to be suitable for all ages
  • +
  • All servers are now required to disclose their non-affiliation with Mojang and/or Microsoft
  • +
  • All servers are now required to implement their own ToS before a player is allowed to play
  • +
  • All players are now required to check back to the EULA on their own accord and players will not be updated of the change
  • +
  • Anything from non-commercial blogs, servers, community forums, fan sites, fan clubs, news groups, events, and gatherings are now deemed as commercial and must follow the CUG even if it will never make money
  • +
  • Mojang now has complete control over all forms of Minecraft content on online platforms
  • +
  • Mojang now has control over the term 'Minecraft' in creative content (YouTube, Twitch etc.) which may result in content removal
  • +
  • Mojang has the authority to grant or revoke permissions and consents at their discretion if they deem it appropriate or dislike what players are doing
  • +
  • Mojang has now outlawed the use of out-of-game mechanics to limit access to your Minecraft server e.g. queue based platforms in addition to gatekept content
  • +
diff --git a/folder/nl/src/content/docs/information/releases.mdx.mdx b/folder/nl/src/content/docs/information/releases.mdx.mdx new file mode 100644 index 0000000000..9bb709cfbc --- /dev/null +++ b/folder/nl/src/content/docs/information/releases.mdx.mdx @@ -0,0 +1,26 @@ +--- +description: Every major Minecraft release, it's required Java version and noticable changes. +slug: release +title: Release Tracker +lastUpdated: 2023-12-10 +sidebar: + order: 3 +--- + +This page aims to cover the latest information for Java tracking the required Java builds and fork compatibility. + +| Major Release | Revision Version | Java Support | PaperMC Build | Purpur Build | +| ------------- | ---------------- | ---------------- | ------------- | ------------ | +| 1.21 | 0 | Java 21 | ✔ | ✔ | + +If you come back to this page at a later date in time and you cannot see a build for the newest release check one of the following links for updates: PaperMC Github or PurpurMC Github + +### Notable Changes + +
    +
  • Added new structures
  • +
  • Added new mobs
  • +
  • Added new weapon
  • +
+ +A full change log can be found here: https://www.minecraft.net/en-us/article/minecraft-java-edition-1-21 diff --git a/folder/nl/src/content/docs/information/services.mdx.mdx b/folder/nl/src/content/docs/information/services.mdx.mdx new file mode 100644 index 0000000000..0a50ac405d --- /dev/null +++ b/folder/nl/src/content/docs/information/services.mdx.mdx @@ -0,0 +1,57 @@ +--- +description: Additional resources that are hosted by the setup.md team. +title: Additional Services +slug: services +lastUpdated: 2024-04-01 +sidebar: + order: 2 +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +As time has progressed we've continued to identify ways we can help server owners get up and running, setup.md has launched some additional services to help make your life easier. + +### Asset Hosting + +We launched a file sharing platform that can be used to share assets quickly with your communities, host resource packs for your server and even create 'link-in-bio' style pages to help bring your community together. + +#### Features + +
    +
  • 100MB file upload limit
  • +
  • Custom domain support premium
  • +
  • URL Shortener
  • +
+ + + + + + +--- + +### Server Jar API + +We took a cool idea produced by PenguiLoader on Github and we fixed some bugs then made it faster by distributing the workload to Cloudflare workers and running it on their amazing edge network. + +#### Quickstart + +The base domain is `https://jar.smd.gg` + +The subsequent URL that follows is syntaxed as below. + +`/download/{SOFTWARE}/{VERSION}/{BUILD}` + +To grab the latest paper .jar download. + +`GET https://jar.smd.gg/download/paper/latest/latest` + +To grab the latest vanilla server.jar download link. (no build parameter required) + +`GET https://jar.smd.gg/download/vanilla/latest` + + + + + diff --git a/folder/nl/src/content/docs/jarapi.mdx.mdx b/folder/nl/src/content/docs/jarapi.mdx.mdx new file mode 100644 index 0000000000..c82306823e --- /dev/null +++ b/folder/nl/src/content/docs/jarapi.mdx.mdx @@ -0,0 +1,18 @@ +--- +title: JAR API +description: An API to easily grab popular Minecraft server software. +template: splash +slug: service/jar-api +hero: + tagline: An API to easily grab popular Minecraft server software. + image: + file: ../../assets/javaicon.png + actions: + - text: Source Code + link: https://smd.gg/api + icon: github + variant: primary +--- + +import MainStatusPill from '../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; diff --git a/folder/nl/src/content/docs/mchost.mdx.mdx b/folder/nl/src/content/docs/mchost.mdx.mdx new file mode 100644 index 0000000000..aa93e9225f --- /dev/null +++ b/folder/nl/src/content/docs/mchost.mdx.mdx @@ -0,0 +1,21 @@ +--- +title: MCHO.ST +description: The free Minecraft hosting solution, sponsored (in-part) by the setup.md wiki. +template: splash +slug: service/mcho.st +hero: + tagline: The free Minecraft hosting solution, sponsored (in-part) by the setup.md wiki. + image: + file: ../../assets/mchost.webp + actions: + - text: Game Panel + link: https://my.mcho.st + icon: external + variant: primary + - text: Join our Discord! + link: https://mcho.st/discord + icon: discord +--- + +import MainStatusPill from '../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; diff --git a/folder/nl/src/content/docs/tools/database.mdx.mdx b/folder/nl/src/content/docs/tools/database.mdx.mdx new file mode 100644 index 0000000000..d3b23510f2 --- /dev/null +++ b/folder/nl/src/content/docs/tools/database.mdx.mdx @@ -0,0 +1,41 @@ +--- +description: This page covers centralised plugin data storage using databases. +slug: t/database +title: Databases +--- + +Before you go and implement a database you should first understand what a database can help to achieve, this will ensure that you're not burning time unnecessarily deploying things you don't need. + +### Why use databases + +Databases are used for centralised storage with unrestricted limitations to read, write new data and modify existing data. Storing data in a database can also be efficient, decreases time for looking up data that you can export into another application / format without significant difficulty. + +--- + +### Common database types + +If you're hosting a server the most common types of databases you'll be interacting with are 'SQL' based. This will most likely be one of the following solutions: + +
    +
  • MySQL (Legacy project)
  • +
  • MariaDB (Modern MySQL fork)
  • +
  • MSSQL (The Microsoft edition of MySQL)
  • +
+From an end user perspective all database types will produce a `.sql` file when exported and can be maintained through a common interface like phpMyAdmin, Adminer or MySQL Workbench. + +:::tip + +You should also be able to move your databases between all three without any major difficulties but this may depend on implementation +::: + +--- + +### When to use a database + +In a Minecraft environment you're most likely going to come across databases in a 'Network' environment e.g. when you're using a tool such as ['Velocity'](/t/server-software#velocity), or ['Bungee'](/t/server-software#bungeecord), this will allow you to share information between your backend servers and have one consistent dataset e.g. economy balances, synced ranks and permissions etc just to name a few examples. + +If you're running a server with a hosting provider they too will most likely give you the ability to create databases for your plugin data, if you're limited on local disk space using SQL for plugin data may off-lift some local capacity constraints. + +:::note +If you're looking to deploy your own Private SQL instance, you can follow a tutorial such as the one on the [Digital Ocean community forums](https://www.digitalocean.com/community/tutorials/how-to-install-mysql-on-ubuntu-22-04) that covers installation, configuration and securing your instance. +::: diff --git a/folder/nl/src/content/docs/tools/offline-mode.mdx.mdx b/folder/nl/src/content/docs/tools/offline-mode.mdx.mdx new file mode 100644 index 0000000000..87deae162d --- /dev/null +++ b/folder/nl/src/content/docs/tools/offline-mode.mdx.mdx @@ -0,0 +1,40 @@ +--- +slug: t/offline +description: What is offline mode and what are the implications? +title: Offline Mode +--- + +Offline mode is a legacy feature of Minecraft servers that disables the requirement for Mojang user authentication, allowing cracked Minecraft clients such as TLauncher et al. to join. +It can be set by either passing the `--singleplayer` flag to the server jar or setting `online-mode=false` in server.properties. However, there are several risks, legal and especially security, which will be covered on this page. + +### Reasons not to use offline mode + +#### Security Risks + +Due to the lack of authentication required on an offline mode server, anyone can use any username to log in - this especially comes into play when players join as certain names to either gain operator permissions or to relentlessly evade bans. + +AuthMe is a plugin for Bukkit servers that coats an insecure offline mode server with a thin veil of 'authentication', which partially mitigates these vulnerabilities at most - however, other plugins or mods still may provide operator access. +Such authentication plugins may prove an annoyance to players, an incentive to use weak passwords which then can be hacked into by malicious players - completely destroying the objective of these plugins. + +#### Software Issues + +Using offline mode on your server may also cause plugins that rely on UUID lookup to break - each 'account' has its own unique UUID, which can cause issues breaking many mods or plugins. + +When switching between modes, this becomes even more of an issue - plugins will have stored data in one format, and changing from online to offline or vice-versa will make them default to the respective format and effectively break all existing user data + +#### Legal Implications + +Offline mode (cracked) servers are commonly a breeding ground for piracy of Minecraft, which may constitute a violation of their EULA, specially their [One Major Rule](https://www.minecraft.net/eula#one-major-rule). +This may prove a problem for larger servers, as Mojang may blacklist clients from connecting to them for common EULA violations such as pay-to-win mechanics et al. + +--- + +### Valid Use Cases + +However, there are a few valid use cases in which offline mode can be used without such implications. They will be listed below: + +
    +
  • Proxies such as BungeeCord and Velocity which require backend servers to have online mode disabled - the proxy must have online mode enabled for this to count
  • +
  • Offline local-hosted environments which lack internet access, assuming everyone owns a Minecraft account otherwise
  • +
  • Local-hosted development servers for testing plugins and mods
  • +
diff --git a/folder/nl/src/content/docs/tools/server-software.mdx.mdx b/folder/nl/src/content/docs/tools/server-software.mdx.mdx new file mode 100644 index 0000000000..c5ca3c19db --- /dev/null +++ b/folder/nl/src/content/docs/tools/server-software.mdx.mdx @@ -0,0 +1,189 @@ +--- +slug: t/server-software +description: This page covers a list of well known server.jars. +title: Server Software +lastUpdated: 2024-03-27 +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +When creating a server there are multiple different names you will come across. Each server software has its own uses. + +Server Software is very often referred to as "Server Jar(s)". + +:::note +A "Fork" is a modified version of server software. These often share the same codebase and will sometimes patch in their own changes on top of the previous projects' code. An example of "forks" is something such as "Bukkit > CraftBukkit > Spigot > Paper > Purpur". +::: + +### Backend Servers + +There are hundreds (if not thousands) of different forks. This document will only include the recommended, stable, widely-used ones. + +#### Vanilla No Plugin Support + +As the name suggests, it is a completely Vanilla server from Mojang itself without any modifications. Great for those who want to host a small server for a couple of friends without altering any mechanics, but definitely not good for large servers. + + + +#### Paper Recommended + +Paper is the most widely-used Server Jar nowadays. A fork of Spigot with its own API, numerous optimizations alongside tons of glitch/dupe fixes make Paper the main choice for most server owners. + + + +#### Purpur + +A fork of Paper which provides numerous gameplay-enhancing features without having to download/create plugins. These include being able to adjust gameplay behaviors not seen in Paper, mob health, and more. Only has a couple of optimization options, but it does allow you to toggle some dupes. + + + +#### Pufferfish + +A fork of Paper which greatly improves performance without causing any noticeable impact to gameplay. Includes hopper, entity, map rendering and many other optimizations. Highly recommended for most servers. + + + +#### Folia + +A fork of Paper which groups nearby loaded chunks to form an "independent region." Each independent region has its own tick loop, which is ticked at the regular Minecraft tickrate (20TPS). The tick loops are executed on a thread pool in parallel. There is no main thread anymore, as each region effectively has its own "main thread" that executes the entire tick loop. + +:::caution + +#### Yes, Folia is relatively usable. + +Do you need to use it? Highly unlikely. Can you use it? Probably. Will a good chunk of your plugins break? Definitely. It's currently only recommended for very large servers that are vanilla/semi-vanilla, have a beefy enough CPU and enough threads as well. If you do end up using it, make sure to test it thoroughly. If you can, consider implementing some patches from Pufferfish and other jars as well. + +**Every command and feature should be tested.** +::: + + + +#### Legacy 1.8 Jars + +It is highly recommended that you do not use 1.8 or any of its other releases. However, if it's a requirement for whatever reason these are the better jars to use. + + + + + + + + + +#### Forge + +Forge is a modding API and server jar. It is most commonly used for servers with large modpacks. However, it is not very optimized and can suffer from poor performance. + + + +#### NeoForge + +NeoForge is a fork of the Forge project with almost all of the original team [excluding LexManos](https://neoforged.net/news/theproject/), made to fix its community issues and to provide better support to modders and later versions of Minecraft. + + + +#### Fabric + +Fabric is another modding API and server jar. Fabric mods are able to change practically any mechanics of the game, is more lightweight compared to Forge, and generally performs better than vanilla thanks to the wide range of optimization mods avaliable such as Lithium, Starlight, ModernFix etc. Take a look at [this list](https://github.com/NordicGamerFE/usefulmods). + + + +--- + +### Proxies + +Proxies are used to connect multiple regular servers (such as Paper servers) together. These are what power "networks" and are used by servers which have multiple gamemodes separated in their own subservers. I.E. Survival, Minigames, Prison, etc. all in one "server". + +#### Velocity + +A more recent project, now run by the Paper developers. Velocity uses its own API, meaning it does not work with Bungeecord / Waterfall (Unless you use [SNAP!](https://forums.papermc.io/threads/snap-run-bungeecord-plugins-on-velocity.31/), which allows you to use Bungeecord plugins on Velocity. Not recommended, though.) + +Velocity is a superior solution compared to Bungeecord / Waterfall unless you're hosting older than 1.13 servers but many developers haven't added Velocity support to their plugins. + + + +#### Waterfall + +A fork of Bungeecord run by the Paper developers, Waterfall supports most if not all Bungeecord plugins. It also comes with a couple of networking optimizations. + + + +:::caution +The PaperMC team have announced that Waterfall has now reached end of life in favour of Velocity. You can read the full announcement here - https://smd.gg/waterfall-eol. We will remove this option from our wiki in the coming months. +::: + +--- + +### Geyser Standalone + +Functioning almost exactly like the Geyser plugin, Geyser Standalone allows you to take load off of your main proxy/backend instance. It also supports auto-updating on Pterodactyl (assuming that you're using the Geyser Standalone egg). Recommended for servers that have higher player counts. + +If you're using Pterodactyl, consider using the [Geyser Standalone Egg](https://github.com/GeyserMC/pterodactyl-stuff). After installation, simply set "remote" in the config.yml of Geyser Standalone to the IP of the proxy/backend server & add Floodgate-Spigot & Floodgate-Velocity/Bungeecord to the spigot and proxy instances respectively. + +Geyser Standalone also allows you to connect to servers that you do not own. However, this is not recommended as it will more than likely lead to a swift ban from the anti-cheat. + + + +--- + +### Interesting Projects + +There are sometimes cool spin-offs that we feel are worthy of mentioning their existance, please note they may no longer be in active development at the time you're viewing this article. + + + + + + +:::danger + +#### Avoid any Jar that combines Plugins & Mods + +Do not use any hybrid server software such as Magma or Mohist. These are generally unstable. [Mohist also replaces EssentialsX jars with modified jars](https://essentialsx.net/do-not-use-mohist.html), which might not be safe. + +::: diff --git a/folder/nl/src/content/docs/tools/signed-chat.mdx.mdx b/folder/nl/src/content/docs/tools/signed-chat.mdx.mdx new file mode 100644 index 0000000000..6374dafbd1 --- /dev/null +++ b/folder/nl/src/content/docs/tools/signed-chat.mdx.mdx @@ -0,0 +1,147 @@ +--- +description: 1.19.1 overhauled the current reporting features and therefore caused a lot of panic, this page is written to cut through the misinformation and provide the facts. +title: Signed Chat +slug: t/signed-chat +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard } from '@astrojs/starlight/components'; + +First things first, it's important to set the story straight. Mojang had always had a reporting toolset for anyone who wished to use it however with the introduction of 1.19.1 changes were made to this system that a reasonable portion of the community didn't like. + +This patch specially introduces a couple of new features being: + +
    +
  • In-Game UI reporting
  • +
  • Cryptography and signing
  • +
+ +The purpose of this page serves as an advisory for those who wish to understand further what this means and what options are available to them. + +--- + +### How does it work + +This is accurate to the best of our abilities, if there is someone with a better understanding of cryptography that can help improve this page please submit a PR. + +#### Technical aspects + +These new keys are stored in .json format under the '%appdata%/.minecraft/profilekeys' folder on your PC. + +:::note +These keys are regenerated after 48 hours +::: + +The 'process' now works as follows: + +
    +
  • User opens up their Minecraft client
  • +
  • Check for keys / generation of new keys occurs if required
  • +
  • User launches Game
  • +
  • User joins their desired Minecraft server
  • +
      +
    • On join the client also makes it's public key available to the server
    • +
    +
  • User sends a message in chat
  • +
      +
    • Client signs the message using the private key providing a level of authenticity
    • +
    • Signed message is sent to the server
    • +
    • Server can validate the message came from your client using your public key
    • +
    • Server displays the chat messages
    • +
    +
+ +Every time a message is sent in chat the last 2 steps are repeated. +
+ + +#### User Reports + +When a user is reported via the new in-game screen ui the following process occurs: + +
    +
  • User selects the offending user and messages they wish to report
  • +
  • The message in question and surrounding message are also sent to Microsoft for review
  • +
+ +Once a report is sent, it is reviewed by Mojang's moderation team who will gauge an appropriate punishment for the offender(s). Any Microsoft punishment is in-line with it's current community guidelines and effect your entire account not just the single Minecraft server, these punishments can result in removal of your Multiplayer access. + +#### In-depth Review + +The best current source of data for the chat reporting is on Github created by KennyTV. A link to the document can be found [here](https://gist.github.com/kennytv/ed783dd244ca0321bbd882c347892874#file-readme-md) + +Below is a list of ways server owners and players can effectively disable the new chat reporting feature, by using one or more of these features you may limit either your own or your communities functionality. + +--- + +### Options + +#### Client Side + +Option one is disabling 'chat-signing' within your client, this will prevent you from joining any server where this setting is enforced. + +#### Server Side + +If you're running your own server there are a few options that can be used depending if you're running vanilla, modded or a plugin based server, these are as follows. + +##### Edit server.properties file Global + +You can edit the following switch to 'false' which will disable the requirement for users to use chat-signing. + +```yaml +... + +enforce-secure-profile = false + +... +``` + +##### No Chat Reports Modded Only + +No Chat Reports is a Minecraft mod created by Aizistral that works on both the client and server sides. It strips cryptographic signatures from player chat messages, effectively converting them to system messages, thus making them non-reportable. + +:::note +Joining a server with `enforce-secure-profile=true` on a client with No Chat Reports installed will display a prompt warning the user that chat will be signed if they agree to it. +::: + + + +##### FreedomChat Spigot / Paper & forks only + +FreedomChat effectively serves the same purpose as No Chat Reports would on a modded server, it converts player chat messages to system messages at the packet level, making them once again non-reportable by players. + + + +##### AntiPopup Spigot / Paper & forks only + +While this plugin works, manual setup is required - the command `/antipopup setup` must be ran in console unless `enforce-secure-profile` is set to `false` already. + + + +##### UnSignedVelocity Velocity only + +This plugin works by removing signed information from commands and messages sent by clients 1.19.1 or higher, allowing plugins that cancel proxy messages to work again. Requires VPacketEvents + + + +:::caution + +All of the above plugins could give you issues with the recent EULA changes as of Aug 2023, the above plugins are no-longer considered endorsed by setup.md. + +::: diff --git a/folder/nl/src/content/docs/tools/startup.mdx.mdx b/folder/nl/src/content/docs/tools/startup.mdx.mdx new file mode 100644 index 0000000000..e8b76f62f7 --- /dev/null +++ b/folder/nl/src/content/docs/tools/startup.mdx.mdx @@ -0,0 +1,117 @@ +--- +description: Understand the startup file used when hosting a server. +slug: t/flags +title: Startup Scripts +--- + +### Basics + +This is how your most bare-bones startup script looks like. + +```bash +... + +java -XmxG -XmsG -jar .jar nogui + +... +``` + +`-Xmx` sets the maximum amount of memory the Java Virtual Machine is allowed to reserve. Don't set this over the amount of memory you have on your machine/given to you by the hosting provider. + +`-Xms` sets the minimum amount of memory the JVM is allowed to reserve. It should always be below or equal to the `-Xmx` value. + +The JVM only uses memory in its heap space - an area of memory that is reserved for the Java application (in our case, the server) - and the flags `-Xms` and `-Xmx` determine the possible bounds of this area. The heap size may be dynamically changed depending on how much memory the application actually needs, but it will always stay within those bounds. + +For example, `-Xmx3G -Xms1G` would set the maximum heap size to 3 gigabytes and the minimum to 1 gigabyte. You can also use the letters M and K - megabytes and kilobytes (though the latter is not usually used) to set the value more precisely, e.t `-Xmx512M`. + +Setting them both to be the same usually improves performance as no calculations need to be done regarding the heap size, but this may take away memory from other programs on your host machine (if any) in case the server does not always need to allocate the full `-Xmx`. + +You should set your RAM allocation according to your average server load - allocating more memory than your server needs is likely to cause GC lag spikes. For example, if you are a starting out server with 0-2 players most of the time, you'll be fine with 2 GB, but if you have 5-10 players online at once, you'll need 4-5 GB. + +`nogui` hides the Minecraft server GUI panel, only leaving the console visible. Remove the flag if you choose to use the panel. It has basic features like a player list, performance metrics and console output. + +`-jar .jar` points to the server .jar - see [Server Software](https://www.setup.md/t/server-software). + +--- + +### Java flags + +Java flags are used to improve server performance and client stuttering by tuning Java's Garbage Collection and adding other optimizations. + +JVM flags go **before** the `-jar` flag. + +#### Aikar flags + +Aikar's flags, while very well optimized for older Java versions, have not been updated since its creation and are severely out of date for modern Java versions. If you are running a 1.17+ Minecraft Java server (and use java 16+), it is recommended to use more up-to-date flags. + +#### Hilltty flags + +These flags are a more up to date version of Aikar's flags designed for modern versions of Java (16 and 17) which should perform better. You can check the startup scripts [here](https://github.com/hilltty/hilltty-flags/blob/main/english-lang.md). + +--- + +### Advanced JVM flags and optimizations + +The JVM can be further tweaked to optimize server and client stutters relating to Java. See [Minecraft Performance Flags](https://github.com/Mukul1127/Minecraft-Performance-Flags-Benchmarks), a up-to-date guide for Java flags, Garbage Collectors, Java runtimes (GraalVM), and other performance tips such as Large Pages and optimized Linux Distributions. + +--- + +### Minecraft server flags + +Minecraft also has quite a few startup options that directly affects the server in some way. Those go _after_ `-jar` in the startup script. +The following information is from [the wiki](https://minecraft.wiki/w/Tutorials/Setting_up_a_server#Minecraft_options). + +#### Minecraft options + +- `--bonusChest` + +If a bonus chest should be generated, when the world is first generated. + +- `--demo` + +If the server is in demo mode. (Shows the players a demo pop-up, and players cannot break or place blocks or eat if the demo time has expired) +Equivalent to playing minecraft without a account, you have about 5 in-game days before your trial ends. + +- `--eraseCache` + +Erases the lighting caches, etc. Same option as when optimizing single player worlds. + +- `--forceUpgrade` + +Forces upgrade on all the chunks, such that the data version of all chunks matches the current server version (same as with sp worlds). +This option significantly increases the time needed to start the server. + +- `--initSettings` + +Loads the settings from 'server.properties' and 'eula.txt', then quits. + +- `--jfrprofile` + +Initializes the Java Flight Recorder on the server. Only available on 1.18+. + +- `--port ` + +Which port to listen on, overrides the server.properties value. (default: -1, read from server.properties) + +See Server.properties for restrictions on this value. + +- `--safeMode` + +Loads level with vanilla datapack only. + +- `--serverId ` + +Gives an ID to the server. (??) +Seemingly no effect ?? + +- `--singleplayer` + +Runs the server in offline mode. + +- `--universe ` + +The folder in which to look for world folders. (default: .) + +- `--world ` + +The name of the world folder in which the level.dat resides. diff --git a/folder/nl/src/content/docs/tools/textures.mdx.mdx b/folder/nl/src/content/docs/tools/textures.mdx.mdx new file mode 100644 index 0000000000..0fbc5f6eca --- /dev/null +++ b/folder/nl/src/content/docs/tools/textures.mdx.mdx @@ -0,0 +1,63 @@ +--- +description: Hosting texture packs for your server. +slug: t/textures +title: Resource Pack Hosting +--- + +If you're looking to host your texture pack for your Minecraft community you can use a third party file hosting service to deliver your pack to Minecraft clients. + +We (setup.md) have an official sharing site that can be used (for free) providing your packs are under 250MB in size. + +--- + +### Using our uploader + +Firstly, open a browser and navigate to https://smd.gg/upload. + +Sign in using one of our SSO options / create a 'traditional' account using a username and password. + + + +Select the 'Getting Started' free tier to finish setting up your account. + + + +You will now be brought to the dashboard page, on the left hand side select 'File link' + + + +By pressing the 'New Link' button in the top right hand side you will be shown a file uploader + + + +Select where your texture pack is on the system and upload the .zip file. + + + +Select 'create new file URL' and await for the upload to be completed + + + +You will then be presented with additional customisation options as well as the URL that needs to be added to your server.properties content. + + + +Go into your `server.properties` file and where it has resource-pack paste in the URL provided from the website like so. + + + +--- + +#### Compliance Reporting + +This service is operated out of the United Kingdom and is distributed globally via the Cloudflare CDN. + +--- + +### Reporting Content + +If you notice content that shouldn't be on our platform, please inform us via a Github issue and we will complete a take-down request. + +:::note + +Content reviewed by our admins and will be dealt with accordingly, we will not respond directly with a list of actions taken. As required by law any CSAM reports will be directed to local authorities and the NCMEC. diff --git a/folder/nl/src/content/docs/tools/tunnels.mdx.mdx b/folder/nl/src/content/docs/tools/tunnels.mdx.mdx new file mode 100644 index 0000000000..b4d12da944 --- /dev/null +++ b/folder/nl/src/content/docs/tools/tunnels.mdx.mdx @@ -0,0 +1,183 @@ +--- +slug: t/tunnels +description: Using tunnels to host without port forwarding +title: Tunnels +--- + +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you want to host a Minecraft server that others can access but don't want to or cannot forward ports due to reasons such as security implications or restrictions imposed by your host or Internet service provider, look no further than using tunnels. + +Simply put, these are proxies that run on your host and connect your server to a public network without opening a port on your router/firewall. + +This page aims to look at a variety of software used to open tunnels, their pros and cons and a bottom line: + +--- + +### Ngrok + +A single-binary application that exposes local TCP ports to the internet through secure tunnelling: to set up ngrok on your server... + +
    +
  • Create an ngrok.com account
  • +
  • Download the ngrok binary for your system
  • +
  • Copy and paste your authtoken command into the terminal, typically
  • +
+```bash +... + +/path/to/ngrok config set-authtoken + +... + +```` +
    +
  • Run the ngrok agent to expose a port
  • +
+```bash +... + +/path/to/ngrok tcp 25565 # or the port you want to expose + +... +```` + +#### Pros + +
    +
  • Relatively quick to set up (single binary)
  • +
  • Open-source integrations
  • +
+ +#### Cons + +The free version of Ngrok is very limited: + +
    +
  • Server address changes every time the ngrok agent is restarted (static URLs are only available for HTTP sites)
  • +
  • Extremely limited bandwidth (1GB/month)
  • +
+ +Additionally, ngrok does not support UDP tunnelling and therefore Geyser cannot be tunnelled for Bedrock Edition players + +#### Bottom Line + +Ngrok is best suited to development servers that should be able to be accessed from anywhere, as well as smaller servers run by those who cannot forward ports on their network equipment. + + + +--- + +### Playit + +A global proxy that exposes your game server to the Internet, securely tunneled through Playit's servers. To set up Playit on your Minecraft server... (assuming you use Bukkit or a fork) + +
    +
  • Create an account on [playit.gg](https://playit.gg) and verify your email address
  • +
  • Download the Playit agent plugin from [here](https://playit.gg/download/plugins) to your server's plugins folder
  • +
  • Restart your server
  • +
  • Click on the URL that the plugin outputs to the console or chat and log in to Playit
  • +
  • Add the agent to your account and wait for the tunnel to be created
  • +
+Your tunnel should then be active! Share the address given by Playit with your players and you should be good to go! + +#### Pros + +
    +
  • Generous free plan (4 TCP and 4 UDP ports, 6 firewall rules to block IPs and ranges etc.)
  • +
  • Premium plan only $3 per month, offers good upgrades such as extra ports and firewall rules, up to 6 external domains and even 3 dedicated IPv6 addresses (provided your network uses IPv6)
  • +
  • Static domain name for servers
  • +
  • Server plugin allows integration with Playit without running the agent as a separate process
  • +
+#### Cons +
    +
  • Playit only allows for external domains to be used on its premium plan: the free plan assigns a randomly-generated subdomain in the format `name.ply.gg`
  • +
+ +#### Bottom Line + +Playit is the most common and recommended option when it comes to Minecraft server tunnelling, with a vast community on its forums and Discord server and knowledgebase for common guides and issues. + + + +--- + +### Connect + +Minekube's Connect is a plugin that links Minecraft servers to a global network in a similar practice to [Minehut](https://minehut.com) + +#### Pros + +
    +
  • Plug and play: just drop the plugin into your server's plugins directory and copy the generated address
  • +
  • Brandable with free custom domains / sub-domains
  • +
  • Passive advertising on the Connect network allows for extra player traffic
  • +
+ +#### Cons + +
    +
  • A paid plan is required to provide an ad-free experience
  • +
+ +#### Bottom Line + +Out of the options listed on this page, Connect has the easiest setup: just install the plugin and Connect will generate a domain for you! +This option is best suited for public server owners who want simple setup with organic growth from other players joining from the Connect global network. + +:::caution +Players joining your server through the Connect network will not be able to join if secure chat is enforced. To disable this: + +- On your backend server(s), make sure `enforce-secure-profile` is set to `false` in `server.properties` +- If using BungeeCord, set `enforce_secure_profile` to `false` in `config.yml` +- If using Velocity, set `force-key-authentication` to `false` in `velocity.toml` + +This can be a downside for those who want [signed chat](/t/signed-chat) to be enforced on their servers but want to advertise and grow their playerbase on the network. +::: + + + +--- + +### Cloudflared + +Cloudflared is a server-side daemon that allows the tunnelling of network traffic through Cloudflare's secure network + +Here are some resources on how to run and tunnel Minecraft servers using cloudflared: + + + + + + +#### Pros + +
    +
  • Traffic is proxied through Cloudflare's network, renowned for its terabit-capacity DDoS mitigation.
  • +
+ +#### Cons + +
    +
  • Setup is very complicated
  • +
  • Individual tunnels must be created using cloudflared for each port that you wish to be open
  • +
  • All players must have cloudflared installed and running on their computers to access the server
  • +
+ +#### Bottom Line + +This option is best for server owners and players who are willing to take on the more complicated setup and requirements, allowing for rock-solid security without the need for DDoS protected proxy + + diff --git a/folder/nl/src/content/docs/troubleshooting/connectivity.mdx.mdx b/folder/nl/src/content/docs/troubleshooting/connectivity.mdx.mdx new file mode 100644 index 0000000000..bb7a0c308f --- /dev/null +++ b/folder/nl/src/content/docs/troubleshooting/connectivity.mdx.mdx @@ -0,0 +1,170 @@ +--- +description: A foundation for checking connectivity issues with your Minecraft server. +slug: ts/connection +title: Connectivity +lastUpdated: 2023-12-16 +--- + +import MainStatusPill from '../../../components/MainStatusPill.vue' +import { LinkCard, CardGrid } from '@astrojs/starlight/components'; + +If you're having trouble connecting to your Minecraft server there's a process you should follow in order to try and understand where the issue lies. If you're running on a third party hosting provider it's recommended to reach out to them directly or check their status page. + +### Server Binding to Port + +The first thing to check is that your server binds to the right port when you start it up, firstly you should see some errors in the console. This error will normally come from having two server processes running at the same time or you run an application on the same port as your Minecraft server. + +```bash +... + +**** FAILED TO BIND PORT! **** +The exception was: java.net.BindException: Address already in use +Perhaps a server is already running on that port? + +... +``` + +You can fix this by going to the `server.properties` file and look for the `server-port` variable and increase the number by 1. When you restart the server you should see the server start up without issues. + +If you don't see the above error message you can check using Powershell or Bash that your server is listening. + +#### Windows + +If you're running on windows please use the following command within a Powershell prompt. + +```powershell +... + +netstat -ano | find "{SERVER-PORT}" | find "LISTEN" + +... +``` + +#### Linux + +If you're running a linux distribution please use the following command within your active shell session. + +```bash +... + +netstat -anpe | grep "{SERVER-PORT}" |grep "LISTEN" + +... +``` + +Regardless of the operating system being used you should see one entry bound to 0.0.0.0, if you don't go back and ensure the `server-port` variable has been set properly. + +:::tip +If you're still having issues try deleting the server.properties file and then restart the server to recreate the file. One the file is deleted you can try again. +::: + +--- + +### OS Firewalls + +Now we know that the server is running on the right port you should check that the connection is allowed to break out past 'localhost' (the pc the server is running on). You can run the following command(s) depending on your OS to ensure the local firewall is configured. + +#### Windows + +If you're running on windows please use the following command within a Powershell prompt. + +```bash +... + +netsh advfirewall firewall add rule name= "Open Port 25565" dir=in action=allow protocol=TCP localport=25565 + +... +``` + +#### Linux + +If you're running a linux distribution please use the following command within your active shell session. + +```bash +... + +sudo iptables -I INPUT -p tcp -m tcp --dport 25565 -j ACCEPT + +... +``` + +To ensure things are all working locally within your network, attempt to connect from another device in your house to the internal LAN address. e.g. `192.168.1.58:25565` + +You can find your host devices internal LAN address by running `ipconfig` within command prompt or `ip addr` / `ifconfig` will work on Linux within the shell session. + +--- + +### External Port Forwarding + +Providing you can connect internally to your server, the issue most likely falls with either your router and port forwarding or your ISP and their use of CGNAT. + +The first thing we need to check is port forwarding is configured correctly. + +:::note +You will need to slightly adjust the below steps as the wording on every router model / firewall is different. +::: + +
    +
  • Login to the admin interface (normally on http(s)://192.168.1.254 or http(s)://192.168.1.1)
  • +
      +
    • Admin username and password is normally on the bottom but a Google search may also help
    • +
    +
  • Look for a 'Port Forwarding / NAT folder'
  • +
  • You may need to go into any 'Advanced Settings' tab first
  • +
  • You should ensure the rule has been configured as expected
  • +
      +
    • Service Name - 'Minecraft'
    • +
    • Protocol - 'TCP'
    • +
    • Internal IP - 'Internal LAN IP of Host Device'
    • +
    • Internal Port - 'Match server.properties file'
    • +
    • External Port - 'Match server.properties file'
    • +
    +
  • Save changes
  • +
+ +:::note +It might not be possible to reach your external IP from inside your own network so a tool like Can You See Me can check the port 25565 from an external source. +::: + +If all has been successful you should see OPEN but if you still see CLOSED it could be possible you're running behind CGNAT. + +You can find a great explanation on CGNAT below. + + + +--- + +### SRV Troubleshooting + +Since release 1.3 Minecraft supports a method of connectivity called 'SRV' Record, in principle they allow you to bind a hostname such as `play.mycoolserver.net` to an ip and a random port. The difference when using an SRV record over an A record is if you have a non standard port e.g. 25570 for your Minecraft server an A record would require you to type `play.mycoolserver.net:25570` into your client. + +In using an SRV record you bind the hostname and the service you're running (a Minecraft server) to the specific port so when you go to your client you would only have to type `play.mycoolserver.net` into your client and the SRV record would tell your client "hey use this port". + +:::note +Sometimes an end user may be using a DNS provider that doesn't support SRV records, any issues they have with connectivity can be resolved by changing their local DNS servers to a free public resolver such as one below. + +
    +
  • Quad9: 9.9.9.9
  • +
  • Cloudflare: 1.1.1.1
  • +
  • Google: 8.8.8.8
  • +
+::: + +When you create the record you should ensure it's configured as follows: + +`_minecraft._tcp. IN SRV 1 1 ` + +
    +
  • Host - this should be your current providers connection hostname
  • +
  • TTL - set this to auto if using Cloudflare DNS or 3600 in any other dns providers panel
  • +
  • Port - this should be the port you're currently using to connect to your server with
  • +
  • Subdomain - this should represent what you want your players to connect with
  • +
+ +An example of a functional SRV record has been provided below, this was created in Cloudflare's DNS manager so if Cloudflare is not your DNS solution then you may have a slightly different interface. + + diff --git a/folder/nl/src/content/docs/troubleshooting/ip.mdx.mdx b/folder/nl/src/content/docs/troubleshooting/ip.mdx.mdx new file mode 100644 index 0000000000..6829c4967a --- /dev/null +++ b/folder/nl/src/content/docs/troubleshooting/ip.mdx.mdx @@ -0,0 +1,58 @@ +--- +description: One of the core fundamentals of networking, this page outlines the types of addresses you will come across and how you can work around them. +slug: ts/ip +title: IP Addresses +lastUpdated: 2023-12-16 +--- + +Every connected device has an IP address, similar to how every mobile phone also has a mobile number and we use this number to reference "hey, this is me... you can find me here". Similarly to phone numbers, when it comes to IP addresses we have two different types for internal (private networks) and external (public networks) usage. + +Within your house every laptop, desktop, phone etc has what we call an 'internal' IP, this will normally be represented as 192.168.0.(insert number here). If you run either `ipconfig /all`, `ip addr` or `ifconfig` command you will see your devices individual address. + +Private networks are great because we can reuse these address pools in every household without using any of our global quotas for addresses, when your local device makes a request this is sent to your device's `default gateway` address and requests information on how to proceed. + +If the request is for another local address it sends it where it needs to go and adds this address to it's "table of contents" however if you're trying to reach something outside of your network e.g. youtube.com or netflix.com your router makes a note of the original requesting device and uses it's `external address` to make that request on your behalf. + +We call this technology 'NAT', to understand why NAT exists you need to understand the challenges of IPv4 addresses. + +### Why NAT Exists + +With v4 addresses we have a limited supply of uniquely available addresses 4.3 billion to be precise. This number does sound huge until you realise that companies like Google, Microsoft, Facebook, US DoD and many, many more organisations hold tens of thousands IP addresses for business, cloud computing and just because they can which significantly shortens the pool that can be used by consumers. + +In order to combat this, NAT was introduced as a solution to provide a single entry and exit point for a network. This also allows us to bring additional connections online to the digital world which is rapidly becoming difficult to support. As the world becomes more connected and the IPv4 shortage gets worse more residential connections will move from 'Dynamic IPs to CG-NAT'. + +--- + +### Interim Technologies + +In order to stop the world falling apart, very smart individuals came up with the following solutions starting with the newest first. + +#### Dual Stack + +Dual Stack connections consist of providing both an IPv4 and IPv6 connection and helps encourage these large organisations to support the future technology (in principle, the more devices that support it the greater compatibility becomes). This is great middle-ground as it uses IPv6 first, then, if there is no IPv6 support implemented by a provider it can fall back to using a universal IPv4 address provided by your ISP (see CGNAT for more). + +Unfortunately progress towards a native IPv6 world is slow and DS will be around for a good few years to come before we can finally start to retire this dated address scheme. + +#### CG-NAT + +With CGNAT your ISP takes the concept of 'NAT' and applies it to their entire infrastructure. No longer do you have your own address provided for connecting out to the internet you instead utilise a unique private address pool to connect multiple routers to a central break out location (e.g. an internet exchange). With multiple people sharing the same public address this ultimately means no more residential port forwarding, an issue that that proves difficult for the home-hoster. + +#### Dynamic IPs + +Dynamic addresses allow your ISP to re-allocate your IP to another house waiting to get online in the event you turn off your router / lose power. It prevents idle connections claiming addresses when they're not being used so your ISP doesn't have to try and buy heavily overpriced IPs. + +For the average person this isn't the end of the world, you'll always be able to get online however if you decide to host services at home this can become a problem in the event your allocated IP changes. Anyone who connects to your service will need to be informed of the address changes and this can become a pain if you're on holiday but this can be mitigated with DDNS solutions such as [No-IP](https://noip.com). + +--- + +### The Future (IPv6) + +To every administrator's disappointment IPv6 is essential if we want to keep devices online. The address pool is significantly larger and there's enough of these IPs to allocate to every atom on the planet and we'd still have enough to repeat it 100 times over! Unfortunately with any new technology this won't become the norm overnight, IPv4 will be around for the next 30 years in one way shape or form. It is a huge learning curve for some and it will require many organisations to reconsider their current networking setups. + +The good news is adoption **IS** underway but there's still a lot of work to be done. A huge list of services that are not yet IPv6 native can be found [here](https://whynoipv6.com/), if you find a service you use on this list - give them a nudge and voice the need for change. + +### Cheat Sheets + +Avast have produces a nice summary cheat sheet which sums up everything listed above. + + diff --git a/folder/nl/src/content/docs/troubleshooting/java.mdx.mdx b/folder/nl/src/content/docs/troubleshooting/java.mdx.mdx new file mode 100644 index 0000000000..504825c30f --- /dev/null +++ b/folder/nl/src/content/docs/troubleshooting/java.mdx.mdx @@ -0,0 +1,87 @@ +--- +description: Understand and troubleshoot some of the most common issues with Java when setting up your Minecraft server. +slug: ts/java +title: Java +--- + +Sometimes you can have issues at the first hurdle, getting your server to boot. Some of these issues are to do with your Java deployment and we will cover some quick fixes to get you up and running. + +### Missing PATH variable + +Depending on the OS you're running there are multiple ways to set the ENV / PATH location to call upon the java executable. + +#### Windows + +If you're on windows this can be done entirely via the UI however some steps maybe slightly different depending on your Windows release. Below are steps based on Windows 11. + +
    +
  • Navigate to `c:\program files\java` and identify the JDK version folder name e.g. `jdk-19`
  • +
  • Open the bin folder within the JDK folder and copy the full folder path from file explorer
  • +
  • Select the Windows icon open the start menu and go to 'Settings'
  • +
  • Select the 'System' tab on the left hand side and go to the 'About' menu
  • +
  • Open 'Advanced System Settings'
  • +
  • Select the 'Advanced' tab
  • +
  • Select 'Environment Variables'
  • +
  • Under 'System Variables' scroll down until you see 'Path'
  • +
  • Select 'Edit'
  • +
  • Now select 'New' and paste in the file explorer path you copied earlier
  • +
  • Press 'OK' to save changes
  • +
+ +You can verify the above steps have worked as expected by running the following command in a command prompt window. + +`java --version` or `javac` + +#### MacOS + +If you're running MacOS there's two different commands you could possibly run, the first (bash) is more for older devices and the latter (zsh) is for anything running Catalina or newer. + +##### Bash Command + +```bash +... + +echo export "JAVA_HOME=\$(/usr/libexec/java_home)" >> ~/.bash_profile +exec bash -l + +... +``` + +##### ZSH Command + +```bash +... + +echo export "JAVA_HOME=\$(/usr/libexec/java_home)" >> ~/.zshrc +exec zsh -l + +... +``` + +--- + +### Memory allocation + +--- + +### Wrong version of Java installed + +When it comes to the 'wrong version installed' there's a few factors to consider. + +
    +
  • Bit edition (x86 or x64 or ARM etc)
  • +
  • Major LTS revision
  • +
+ +You can identify if you're having issues due to the bit version by lowering the start-up args from a value greater than `4` for -Xms and -Xmx. If your server boots without issues to the `Done in X seconds` line you will need to uninstall your java release and download the 64 bit edition as this doesn't have the 4GB RAM memory limitation. + +If your server still doesn't boot after decreasing the RAM it's most likely that your machine has the wrong edition of Java installed, certain major releases of Java dropped legacy builds as time has gone on. + +The most commonly adopted Java releases are as follows: + +
    +
  • Java 8 (LTS)
  • +
  • Java 11 (LTS)
  • +
  • Java 17 (LTS)
  • +
  • Java 19 (LTS)
  • +
diff --git a/folder/nl/src/content/docs/troubleshooting/latency.mdx.mdx b/folder/nl/src/content/docs/troubleshooting/latency.mdx.mdx new file mode 100644 index 0000000000..1a882157f1 --- /dev/null +++ b/folder/nl/src/content/docs/troubleshooting/latency.mdx.mdx @@ -0,0 +1,57 @@ +--- +description: Understand latency and how it can play a part in the user experience of your Minecraft server. +slug: ts/latency +title: Latency +lastUpdated: 2023-12-16 +--- + +If you've ever run a server, played on a server or you're Australian then the phrase "IT'S LAAAAAAAAAAAAAAAGING" probably sounds familiar. + + + +Unfortunately this isn't always something that's easily correctable, providing you've ensured the issue isn't related to your hardware the server runs on then you should consider the network and primarily latency. + +Latency related issues can normally be identified by one of these factors being true. + +
    +
  • Blocks don't automatically disappear after being mined
  • +
  • One bar of connectivity in the tab menu
  • +
  • You're located on the other side of the planet
  • +
+ +Technically speaking, the total duration of the request being sent from your machine, processed by the recipient and then sent back is measured in milliseconds 'ping' (latency). The longer it takes to process a request the more noticable and degraded your user experience becomes. + +:::note +If you've previously been able to join a Minecraft server without issues but you login the next day and it's unplayable then the latency should resolve with time. This is most likely due to maintenance in a datacentre somewhere on the planet that your requests utilise. + +
+Your ISP is unable to do anything about latency +::: + +### Tools to Help + +Unfortunately there is no single tool to fix your problem however if you're looking at hosting a Minecraft server for friends split across the globe we've got some advice and test locations you can use to estimate your ping. + +#### Testing Latency + +Before you purchase a server, you will want to test the location for it's ping. Vultr offer a wide range of locations that all support both IPv4 and IPv6 and respond to ICMP (ping), MTR and traceroute requests. + +We have selected 4 of their locations that represent the most common locations offered by service providers. You can use any of these locations to get an indication of what your ping would be like to any future server you buy, it could also be worth sending these links to your community memebers to ensure you find the best compromise for your entire playerbase. + +
    +
  • [https://lon-gb-ping.vultr.com](https://lon-gb-ping.vultr.com) - London, UK
  • +
  • [https://fra-de-ping.vultr.com](https://fra-de-ping.vultr.com) - Frankfurt, DE
  • +
  • [https://tor-ca-ping.vultr.com](https://tor-ca-ping.vultr.com) - Toronto, CA
  • +
  • [https://sgp-ping.vultr.com](https://sgp-ping.vultr.com) - Singapore, SG
  • +
+ +#### Ideal Ping + +Generally you can tollerate higher than normal ping within Minecraft compared to FPS titles due to the fact it's played at a slower pace. + +| Ping (MS) | Summary | +| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 0-10 | You're either hosting the server locally or the server is hosted within your city / country (providing you're an FTTP customer). | +| 11-50 | This is where most of your connections will reside, most often will also account for servers hosted in neighbouring countries / states. | +| 51-150 | This is where you _could_ start to see the occasional block break delay or quick movements might not work as expected. The avg Hypixel ping is roughly in this ball park. | +| 151 + | Most lag related complaints will occur from players in this category (mostly from Asia / Aus). If you have a large audience in this region it would be worth considering a second server here. |