User:CounterPillow/Quartz64 Minecraft Server Guide - Revision history

CounterPillow at 17:33, 15 September 2023

2023-09-15T17:33:18Z

← Older revision		Revision as of 17:33, 15 September 2023
Line 12:		Line 12:
	TL;DR: Don't shit up my guide. I put a lot of time into it, and it's opinionated for a reason.		TL;DR: Don't shit up my guide. I put a lot of time into it, and it's opinionated for a reason.
	-->		-->
	This guide details how to build and set up a small Minecraft (Java Edition) server on a [[Quartz64]] Model B single board computer. The guide is intended to cover the basics in detail so that inexperienced users can follow it.		This guide details how to build and set up a small Minecraft (Java Edition) server on a [[Quartz64]] Model B single board computer. The guide is intended to cover the basics in detail so that inexperienced users can follow it. You require no preexisting Linux knowledge whatsoever.

	{{Info\|If you have a 12+ year old child interested in computers and have some experience yourself, this could be a great guide to work through with them.}}		{{Info\|If you have a 12+ year old child interested in computers and have some experience yourself, this could be a great guide to work through with them.}}
Line 352:		Line 352:
	=== Permissions ===		=== Permissions ===

	On Unix-like systems like Linux, files and directories are owned by one user and one group. Additionally, there are read/write/execute permissions applying for each file or directory for either the user, the group or everyone else.		On Unix-like systems like Linux, files and directories are owned by one user and one group. Additionally, there are read/write/execute permissions applying for each file or directory for either the user, the group or everyone else. A user may be part of multiple groups at the same time.

	We can view these permissions with <code>ls -al</code> in the first column. You'll see something like:		We can view these permissions with <code>ls -al</code> in the first column. You'll see something like:
Line 504:		Line 504:

	{{hint\|'''Further Explanation:''' You can find a (somewhat lacking) documentation for firewalld on [https://firewalld.org/documentation/ the official firewalld website]. A better resource is, as always, <code>man firewall-cmd</code>.}}		{{hint\|'''Further Explanation:''' You can find a (somewhat lacking) documentation for firewalld on [https://firewalld.org/documentation/ the official firewalld website]. A better resource is, as always, <code>man firewall-cmd</code>.}}

			{{hint\|'''For Expert Users:''' Experienced users might at this point run <code>sudo iptables -L</code> to look at the actual filtering rules that firewalld has added, and they would be shocked to see some completely empty chains with an ACCEPT policy. Fear not, the firewall is working, but the iptables utility isn't. Modern kernels all use nftables, which confuses the legacy iptables specific tools when something like firewalld makes full use of nftables. Use <code>sudo nft list table inet firewalld</code> to get a listing of the filtering rules.}}

	== Formatting The NVMe Drive ==		== Formatting The NVMe Drive ==

CounterPillow at 15:50, 15 September 2023

2023-09-15T15:50:30Z

@@ Line 457: / Line 457: @@
 === Configuring A Firewall ===
-{{note|'''TODO:''' Explain how to set up a persistent firewall that allows ports 22/tcp from LAN and 25565/tcp from anywhere.}}
+Even in a home network that is behind a router's NAT (more on that later), it's good practice to have your individual devices protected by firewalls as well. A firewall can work in many ways, but the simplest and most common method of operation is that it drops all incoming connection attempts originating from globally routed IPs and only allows those on network ports the administrator has explicitly allowed. This prevents locally running services that accidentally listen to incoming connections from all IPs from being accessible to any surprise guests.
 == Formatting The NVMe Drive ==

CounterPillow at 13:53, 15 September 2023

2023-09-15T13:53:19Z

@@ Line 352: / Line 352: @@
 === Permissions ===
-{{note|'''TODO:''' Write a section explaining file ownership and permissions.}}
+On Unix-like systems like Linux, files and directories are owned by one user and one group. Additionally, there are read/write/execute permissions applying for each file or directory for either the user, the group or everyone else.
 == Setting Up The Network ==

CounterPillow at 16:09, 14 September 2023

2023-09-14T16:09:26Z

Show changes

CounterPillow at 10:20, 14 September 2023

2023-09-14T10:20:07Z

@@ Line 2: / Line 2: @@
 {{hint|'''For prospective editors:''' This guide was authored by [[User:CounterPillow]]. Please read the lengthy comment at the top of the article in the edit window before trying to contribute to it in any way.}}
 <!--FOR EDITORS PLEASE READ AND RESPECT
-This guide makes a lot of deliberately chosen recommendations, and does not suggest "alternatives". This is on purpose. The author weighed the options against each other, and chose one they felt was the best fit for the situation to streamline the guide. This helps avoid needlessly bloating an already lengthy guide, and reducing user confusion. For this reason, the guide will remain in CounterPillow's user namespace.
+This guide makes a lot of deliberately chosen recommendations, and generally does not suggest "alternatives" at every step. This is on purpose. The author weighed the options against each other, and chose one they felt was the best fit for the situation to streamline the guide, or of the best educational value. This helps avoid needlessly bloating an already lengthy guide, and reduces potential for user confusion or decision paralysis. For this reason, the guide will remain in CounterPillow's user namespace.
 Please respect that this is the work of an individual and you should not tamper with their author voice. In particular:
@@ Line 352: / Line 352: @@
 === Permissions ===
-{{hint|'''TODO:''' Write a section explaining file ownership and permissions.}}
+{{note|'''TODO:''' Write a section explaining file ownership and permissions.}}
 == Setting Up The Network ==
@@ Line 434: / Line 434: @@
 {{note|'''TODO:'''
 # Add a minecraft system user with a minecraft group that has write permissions to the minecraft directory on NVMe, add minecraft to supplemental groups for user.
 # Install Java, download PaperMC to the Minecraft directory, symlink it to paper.jar, run it once, accept the EULA.
@@ Line 441: / Line 440: @@
 # Add player to whitelist and ops through rcon.
 # Connect to the server for the first time!}}
 == Making The Server Accessible From Outside Your Home Network ==

CounterPillow at 18:05, 11 September 2023

2023-09-11T18:05:41Z

@@ Line 1: / Line 1: @@
 {{warning|'''This article is a work-in-progress and incomplete, if you came here from a search engine, turn back.'''}}
 This guide details how to build and set up a small Minecraft (Java Edition) server on a [[Quartz64]] Model B single board computer. The guide is intended to cover the basics in detail so that inexperienced users can follow it.
@@ Line 338: / Line 349: @@
 A more advanced option is <code>vim</code>. You can run a lengthy interactive guide to using vim with the command <code>vimtutor</code>. Learning vim is a whole can of worms in of itself, so it's best to stick to nano if you're unsure.
 == Setting Up The Network ==
-{{note|'''TODO:''' Explain how to either use reserved DHCP leases or configure a static IP with NetworkManager, and how to set up a persistent firewall that allows ports 22/tcp and 25565/tcp.}}
+=== Configuring A Fixed LAN IP Address ===
 == Formatting The NVMe Drive ==
-{{note|'''TODO:''' Explain how to wipefs + fdisk + format the NVMe drive, make a mountpoint and put it in fstab.}}
+{{note|'''TODO:''' Explain how to wipefs + fdisk + format the NVMe drive, make a mount point and put it in fstab.}}
 == Setting Up The Minecraft Java Edition Server ==

CounterPillow at 14:49, 11 September 2023

2023-09-11T14:49:53Z

← Older revision		Revision as of 14:49, 11 September 2023
Line 338:		Line 338:

	A more advanced option is <code>vim</code>. You can run a lengthy interactive guide to using vim with the command <code>vimtutor</code>. Learning vim is a whole can of worms in of itself, so it's best to stick to nano if you're unsure.		A more advanced option is <code>vim</code>. You can run a lengthy interactive guide to using vim with the command <code>vimtutor</code>. Learning vim is a whole can of worms in of itself, so it's best to stick to nano if you're unsure.

			== Setting Up The Network ==

			{{note\|'''TODO:''' Explain how to either use reserved DHCP leases or configure a static IP with NetworkManager, and how to set up a persistent firewall that allows ports 22/tcp and 25565/tcp.}}

			== Formatting The NVMe Drive ==

			{{note\|'''TODO:''' Explain how to wipefs + fdisk + format the NVMe drive, make a mountpoint and put it in fstab.}}

			== Setting Up The Minecraft Java Edition Server ==

			{{note\|'''TODO:'''
			# Install build-essential and git, download https://github.com/Tiiffi/mcrcon and build and install it.
			# Add a minecraft system user with a minecraft group that has write permissions to the minecraft directory on NVMe, add minecraft to supplemental groups for user.
			# Install Java, download PaperMC to the Minecraft directory, symlink it to paper.jar, run it once, accept the EULA.
			# Edit server.properties, enable rcon with a password, enable whitelist, edit motd and set difficulty.
			# Add the systemd unit to /etc/systemd/system/, set it to auto-start, then start it.
			# Add player to whitelist and ops through rcon.
			# Connect to the server for the first time!}}

			== Making The Server Accessible From Outside Your Home Network ==

			{{note\|'''TODO:'''
			# Explain what a dynamic IP is, set up ddclient with DuckDNS, have a systemd timer for that.
			# Explain what port forwarding is, why it's needed, and why this depends on your router. Warn not to forward port 22/tcp, only port 25565/tcp.}}

			== Maintaining Your Server ==

			{{note\|'''TODO:'''
			# Explain how to start, stop, restart the Minecraft server with systemctl.
			# Explain how to access server logs with journalctl.
			# Explain how to keep PaperMC updated (including changing the symlink).
			# Explain apt update and apt upgrade. Recommend unattended-upgrades.
			# Explain Debian major releases and to keep an eye out for them.
			# Recommend htop to see how CPU and RAM usage is looking.
			# Recommend some backup solutions; rsync to flash drive, short mention of borg/borgmatic over the network.
			# Explain how to transfer files to/from server: sftp, rsync, winscp, etc.}}

			== Security Advice ==

			{{note\|'''TODO:'''
			* Using SSH pubkey auth and disabling password login.
			* On the dangers of Minecraft server mods/plugins.
			* Do not rely on obscurity in the age of whole IPv4 scanning.
			* Not using it anymore and can't be bothered to maintain it? Turn it off.
			* On kernel updates and why they need a reboot here.
			* Why not Docker: on software supply chains and understanding how to maintain your setup.
			}}

	== Troubleshooting ==		== Troubleshooting ==

CounterPillow at 13:04, 11 September 2023

2023-09-11T13:04:27Z

← Older revision		Revision as of 13:04, 11 September 2023
Line 376:		Line 376:
	screen /dev/ttyUSB<var>n</var> 1500000 cs8 -cstop		screen /dev/ttyUSB<var>n</var> 1500000 cs8 -cstop

	You can quit screen by hitting Ctrl+a, then hit ~~backspace~~ (<code>\</code>) and confirm with y.		You can quit screen by hitting Ctrl+a, then hit backslash (<code>\</code>) and confirm with y.

	For minicom, (replacing <var>n</var> with the number of your serial adapter) use:		For minicom, (replacing <var>n</var> with the number of your serial adapter) use:
Line 404:		Line 404:
	screen /dev/tty.usbserial-<var>foo</var> 1500000 cs8 -cstop		screen /dev/tty.usbserial-<var>foo</var> 1500000 cs8 -cstop

	You can quit screen by hitting Ctrl+a, then hit ~~backspace~~ (<code>\</code>) and confirm with y.		You can quit screen by hitting Ctrl+a, then hit backslash (<code>\</code>) and confirm with y.

	==== Using The Serial Console ====		==== Using The Serial Console ====

CounterPillow at 12:54, 11 September 2023

2023-09-11T12:54:57Z

@@ Line 113: / Line 113: @@
 Once you see the heartbeat pattern, you may now connect to the board over the network, using SSH.
 === Using SSH on Windows ===
@@ Line 343: / Line 345: @@
 === Connecting UART ===
-{{note|'''TODO:''' Write this.}}
+To hook up UART serial debug, connect your Woodpecker, ideally with a decent USB extension cord, to your computer's USB port. Make sure the yellow jumper is set to 3.3V.
 === Installing OpenSSH On Windows ===
 On Windows 11, open the start menu, go to Settings > Apps > Optional features. If "OpenSSH Client" doesn't show up in your installed features, click on "View features" in "Add an optional feature" and search for "OpenSSH Client" and check it, then hit "Next" and "Install".

CounterPillow at 05:40, 10 September 2023

2023-09-10T05:40:33Z

← Older revision		Revision as of 05:40, 10 September 2023
Line 322:		Line 322:
	** '''Example:''' <code>man ls</code> shows the manual page for the <code>ls</code> command.		** '''Example:''' <code>man ls</code> shows the manual page for the <code>ls</code> command.
	** Use this whenever you're not sure about a command's invocation. It'll be more accurate to your situation than what an internet search will tell you, and a lot less annoying to use.		** Use this whenever you're not sure about a command's invocation. It'll be more accurate to your situation than what an internet search will tell you, and a lot less annoying to use.
			* <code>wget</code>: Download a file from the internet
			** '''Example:''' <code>wget https://plebian.org/img/plebian-logo-white.svg</code> downloads Plebian's logo from its website.

	{{hint\|'''Useful Reminder:''' You can tab-complete a lot of things! For example, if you don't want to type out a whole directory name, hit tab once to complete it as far as possible, and hit tab twice to show the remaining options with how far you've completed it so far. Try typing <code>ls /u</code> and hitting tab, and you should have it complete to <code>ls /usr/</code>.}}		{{hint\|'''Useful Reminder:''' You can tab-complete a lot of things! For example, if you don't want to type out a whole directory name, hit tab once to complete it as far as possible, and hit tab twice to show the remaining options with how far you've completed it so far. Try typing <code>ls /u</code> and hitting tab, and you should have it complete to <code>ls /usr/</code>.}}

			=== Editing Text Files ===

			For the rest of the guide, we'll be spending significant amounts of time editing text files. That's why it's good to familiarise yourself with a terminal text editor. The simplest to use of these is <code>nano</code>.

			nano <var>foo</var>.txt

			opens up nano, writing to the file <var>foo</var>.txt. We can save to the file with Ctrl+o, and quit nano with Ctrl+x.

			A more advanced option is <code>vim</code>. You can run a lengthy interactive guide to using vim with the command <code>vimtutor</code>. Learning vim is a whole can of worms in of itself, so it's best to stick to nano if you're unsure.

	== Troubleshooting ==		== Troubleshooting ==