Skip to content

Commit 3a43a65

Browse files
andystevensnameleslitagordita
authored andcommitted
[New] Deploy a Minecraft Server with One-Click Apps (#2428)
* initial commit * First Draft * Vale and spelling fixes * Tech Edits * Add term to vale dictionary * Minor copy edit * Fix typo
1 parent 91db286 commit 3a43a65

File tree

4 files changed

+127
-0
lines changed

4 files changed

+127
-0
lines changed

ci/vale/dictionary.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ bashrc
8787
bc
8888
berkshelf
8989
binlog
90+
biomes
9091
bitbucket
9192
bitrate
9293
blocklists
@@ -407,6 +408,7 @@ fstab
407408
galera
408409
gamemode
409410
gamepad
411+
gamepedia
410412
gameplay
411413
gandi
412414
gatsby
@@ -654,6 +656,7 @@ kubernetes
654656
kubespray
655657
lambdabunker
656658
laravel
659+
largebiomes
657660
launchd
658661
lbmethod
659662
lda
@@ -766,6 +769,7 @@ microservices
766769
microsystems
767770
microweb
768771
minecraft
772+
mineshafts
769773
miniconda
770774
miniconda3
771775
minification
@@ -780,6 +784,7 @@ mitigations
780784
mkdir
781785
mnesia
782786
moby
787+
moddable
783788
modsecurity
784789
mongodb
785790
monit
@@ -1085,6 +1090,7 @@ resharding
10851090
resilvering
10861091
resolv
10871092
resolvconf
1093+
respawn
10881094
resque
10891095
restapi
10901096
retpoline
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
---
2+
author:
3+
name: Linode Community
4+
email: docs@linode.com
5+
description: 'Deploy a Minecraft server on Linode using One-Click Apps.'
6+
keywords: ['minecraft','one-click', 'server']
7+
license: '[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0)'
8+
published: 2019-04-01
9+
modified: 2019-04-01
10+
modified_by:
11+
name: Linode
12+
title: "Deploy a Minecraft Server with One-Click Apps"
13+
contributor:
14+
name: Linode
15+
external_resources:
16+
- '[Minecraft Wiki](https://minecraft.gamepedia.com/Minecraft_Wiki)'
17+
---
18+
19+
## Minecraft One-Click App
20+
21+
With over 100 million users around the world, [Minecraft](https://www.minecraft.net/en-us/) is the most popular online game of all time. You and other players are free to build and explore in a 3D generated world made up of millions of mineable blocks. Collect resources by leveling mountains, taming forests, and venturing out to sea. Choose a home from the varied list of biomes like ice worlds, flower plains, and jungles. Build ancient castles or modern mega cities, and fill them with redstone circuit contraptions and villagers. Fight off nightly invasions of Skeletons, Zombies, and explosive Creepers, or adventure to the End and the Nether to summon the fabled End Dragon and the chaotic Wither. If that is not enough, Minecraft is also highly moddable and customizable. You decide the rules when hosting your own Minecraft server for you and your friends to play together in this highly addictive game.
22+
23+
### Deploy a Minecraft Server One-Click App
24+
25+
{{< content "deploy-one-click-apps">}}
26+
27+
The [Minecraft Options](#minecraft-options) section of this guide provides details on all available configuration options for this app.
28+
29+
### Minecraft Options
30+
31+
You can configure your Minecraft Server App by providing values for the following fields:
32+
33+
| **Field**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | **Description** |
34+
|:--------------|:------------|
35+
| **SSH Key** | Your SSH [public key](/docs/security/authentication/use-public-key-authentication-with-ssh/). The public key will be stored in the `/root/.ssh/authorized_keys` file on your Linode, and you will be able to use it to login as root over SSH. *Advanced Configuration*. |
36+
| **World Name** | The world name and it's corresponding file name. *Advanced Configuration*. |
37+
| **Message of the Day** | Text that is displayed whenever a player logs on to the server. *Advanced Configuration*. |
38+
| **Flight Enabled** | Allows flight if there is a mod installed that supports flying. This configuration has no effect on creative mode flight. *Advanced Configuration*. |
39+
| **Nether World Enabled** | Enables the Nether world. *Advanced Configuration*. |
40+
| **Player Achievements Enabled** | Whenever a player unlocks an achievement, it is broadcast to all logged in players. *Advanced Configuration*. |
41+
| **Maximum Players** | Maximum amount of players allowed on the server. *Advanced Configuration*. |
42+
| **Player Idle Timeout Limit** | If not set to *disabled*, the amount of time in minutes a player can be idle before being kicked off of the server. *Advanced Configuration*. |
43+
| **Difficulty Level** | The game difficulty. *Advanced Configuration*. |
44+
| **Hardcore Mode Enabled** | If set to `true`, the difficulty will be set to *Hard*. Additionally, on death the player won't respawn and will be limited to *spectator* mode. *Advanced Configuration*. |
45+
| **PvP Enabled** | Enables player versus player combat on the server. *Advanced Configuration*. |
46+
| **Force Game Mode Enabled** | Forces players to join the server's default game mode. `false` allows players to join with their previous game mode. `true` forces the default game mode.
47+
| **World Type** | Type of world to generate. *Default* = standard, *flat* = featureless and flat, *largebiomes* = larger biomes, *amplified* = larger height limit. *Advanced Configuration*. |
48+
| **World Seed** | A random value used by Minecraft's world generation algorithm to create a unique world. For example: `qazwsx123`. See [Minecraft's Gamepedia](https://minecraft.gamepedia.com/Seed_(level_generation)) entry on seeds for more information. *Advanced Configuration*. |
49+
| **Spawn Animals Enabled** | Determines if animals (sheep, chickens, squid, etc.) will spawn. *Advanced Configuration*. |
50+
| **Spawn Monsters Enabled** | Determines if monsters (creepers, skeletons, spiders, etc.) will spawn. *Advanced Configuration*. |
51+
| **Spawn NPCs Enabled** | Determines if villagers will spawn. *Advanced Configuration*. |
52+
| **Game Mode** | The game mode of the server. *Survival* is the default game mode, *creative* allows for flight and unlimited resources, *adventure* prevents players from destroying blocks, and *spectator* will grant the ability to fly, but will prevent any player interaction on the server. *Advanced Configuration*. |
53+
| **Structure Generation Enabled** | Enables the ability to generate structures like villages and mineshafts. *Advanced Configuration*. |
54+
| **Maximum Build Height** | Maximum height at which players can place blocks. World generation may exceed this limit. *Advanced Configuration*. |
55+
| **Maximum World Size** | Maximum radius of the world, in blocks. *Advanced Configuration*. |
56+
| **View Distance** | The distance a player can see, measured in chunks (16 block cubes). For example, `10` will enable the user to see 10 chunks in any direction. |
57+
| **Command Block Enabled** | Enables the placement of command blocks through the `/give` command. *Advanced Configuration*. |
58+
| **Querying Enabled** | Enables GameSpy4. Used to obtain information about the server. *Advanced Configuration*. |
59+
| **Enable RCON** | Enable remote access (RCON) to the Minecraft server to run commands. *Advanced Configuration*. |
60+
| **RCON Password** | The RCON password. *Advanced Configuration*. |
61+
| **RCON Port** | The port used for RCON. *Advanced Configuration*. |
62+
| **Maximum Tick Time** | The maximum amount of milliseconds a single tick can take before the server considers itself frozen or crashed and will shut down. *Advanced Configuration*. |
63+
| **Network Compression Threshold** | The threshold at which bytes are compressed. *Advanced Configuration*. |
64+
| **Op-permission Level** | Sets the permission level for operators (ops) when using the `/op` command. *Advanced Configuration*. |
65+
| **Port Number** | The server's listening port number. *Advanced Configuration*. |
66+
| **Snooper Enabled** | Determines if the server sends stats to [https://snoop.minecraft.net](https://snoop.minecraft.net). *Advanced Configuration*. |
67+
| **Use Native Transport Enabled** | Improve server performance by optimizing sent and received packets. *Advanced Configuration*. |
68+
69+
70+
### Linode Options
71+
72+
After providing the app specific options, provide configurations for your Linode server:
73+
74+
| **Configuration** | **Description** |
75+
|:--------------|:------------|
76+
| **Select an Image** | Debian 9 is currently the only image supported by Minecraft One-Click Apps, and it is pre-selected on the Linode creation page. *Required*. |
77+
| **Region** | The region where you would like your Linode to reside. In general, it's best to choose a location that's closest to you. For more information on choosing a DC, review the [How to Choose a Data Center](/docs/platform/how-to-choose-a-data-center) guide. You can also generate [MTR reports](/docs/networking/diagnostics/diagnosing-network-issues-with-mtr/) for a deeper look at the network routes between you and each of our data centers. *Required*. |
78+
| **Linode Plan** | Your Linode's [hardware resources](/docs/platform/how-to-choose-a-linode-plan/#hardware-resource-definitions). Your MineCraft App should be sized based on the amount of traffic you expect to see on your server. We recommend 1GB of RAM for every 15 players maximum on your server. For example, If you are expecting a small group of players (between 1-15), you should be okay with a Nanode. Up to 30 players, a 2GB Linode, and so on. *Required*. |
79+
| **Linode Label** | The name for your Linode, which must be unique between all of the Linodes on your account. This name will be how you identify your server in the Cloud Manager’s Dashboard. *Required*. |
80+
| **Root Password** | The primary administrative password for your Linode instance. This password must be provided when you log in to your Linode via SSH. It must be at least 6 characters long and contain characters from two of the following categories: lowercase and uppercase case letters, numbers, and punctuation characters. Your root password can be used to perform any action on your server, so make it long, complex, and unique. *Required*. |
81+
82+
When you've provided all required Linode Options, click on the **Create** button. **MineCraft should install between 5-10 minutes after your Linode has successfully provisioned**.
83+
84+
## Getting Started after Deployment
85+
86+
Ensure that you have [installed Minecraft](https://my.minecraft.net/store/minecraft/) on your personal computer and created a Minecraft user account before getting started with this section.
87+
88+
After Minecraft has finished installing on your Linode, you will be able to access your Minecraft server by copying your Linode's IPv4 address and entering it in the Multiplayer menu on your personal computer's Minecraft installation. To find your Linode's IPv4 address:
89+
90+
1. Click on the **Linodes** link in the sidebar. You will see a list of all your Linodes.
91+
92+
1. Find the Linode you just created when deploying your app and select it.
93+
94+
1. Navigate to the **Networking** tab.
95+
96+
1. Under the **IPv4** heading, you will find your IPv4 address listed under the **Address** column. Copy your IPv4 address.
97+
98+
1. Open Minecraft on your computer and click on **Multiplayer**, then click **Add Server**.
99+
100+
1. Enter a name for your server in the **Server Name** box. This name will show up on the *Play Multiplayer* server selection screen.
101+
102+
1. Paste your IP address in the **Server Address** field and click **Done**:
103+
104+
![Paste your IP address in the Server Address field.](minecraft-one-click-edit-server-info.png)
105+
106+
1. Once your server is ready to play on, the status indicator will show a series of green bars.
107+
108+
![A Minecraft server that is ready to accept connections](minecraft-one-click-server-selection-screen.png)
109+
110+
If there is a red *X* over the status bars, or it says *old*, then your Linode has not finished installing Minecraft. Wait a few minutes, then hit **Refresh**.
111+
112+
### Software Included
113+
114+
The Minecraft One-Click App will install the following required software on your Linode:
115+
116+
| **Software** | **Description** |
117+
|:--------------|:------------|
118+
| [**Minecraft 1.13**](https://www.minecraft.net/en-us/) | Game server. |
119+
| [**LinuxGSM**](https://linuxgsm.com) | A command line tool for the deployment and management of Linux game servers. |
120+
| [**UFW**](https://wiki.ubuntu.com/UncomplicatedFirewall) | Firewall utility. Port 25575 will allow outgoing and incoming traffic. |
121+
| [**Fail2ban**](https://www.fail2ban.org/wiki/index.php/Main_Page) | Fail2Ban is an intrusion prevention software framework that protects computer servers from brute-force attacks. |
171 KB
Loading
186 KB
Loading

0 commit comments

Comments
 (0)