Install Minecraft Server in a Truenas Jail

Steps

Create the jail from the UI

Install minecraft-server Ports

1. Open in a shell into the running Jail either from the webui with > Shell button or with ssh sudo iocage console minecraft2

   

   

2. Get the Ports repository locally portsnap fetch extract will unpack in /usr/ports

3. echo "LICENSES_ACCEPTED+= minecraft" >> /etc/make.conf

4. cd /usr/ports/games/minecraft-server

5. Setup pkg pkg update

6. make install-missing-packages This step didn’t work for me, pkg complaining about kyua and py-wheel044 not found

   root@minecraft2:/usr/ports/games/minecraft-server # make install-missing-packages
   Updating FreeBSD repository catalogue...
   FreeBSD repository is up to date.
   All repositories are up to date.
   Updating database digests format: 100%
   pkg-static: No packages available to install matching 'devel/kyua' have been found in the repositories
   pkg-static: No packages available to install matching 'devel/py-wheel044' have been found in the repositories
   *** Error code 1
   
   Stop.
   make: stopped in /usr/ports/games/minecraft-server
   

7. So I installed the 3 dependencies required manually with pkg install portconfig tmux openjdk21

8. env USE_PACKAGE_DEPENDS_ONLY=yes make install Here the important part is USE_PACKAGE_DEPENDS_ONLY=yes making and installing with pkg dependencies and not compiling everything from sources that would take ages

9. Then you will need to choose the run mode for the server, I would recommend to choose Daemon to be able to autostart your server when TrueNas start

   

Running minecraft server

1. Edit the /etc/rc.conf with ee /etc/rc.conf or vim if you prefer (pkg install vim-tiny)

   With daemon option:
   - The service has been installed with the name 'minecraft'
   - To adjust maximum memory usage (-Xmx), use minecraft_memx= in /etc/rc.conf
   - To adjust initial memory usage (-Xms), use minecraft_mems= in /etc/rc.conf
   - To add other java parameters, use minecraft_args= in /etc/rc.conf
   - To run with a specific version of Java, use minecraft_java_version= in /etc/rc.conf
   - To see the interactive console, type service minecraft console
   

   So you can have something like that in /etc/rc.conf

   # Minecraf server
   minecraft_enable="YES"
   # minecraft_memx=
   # minecraft_mems=
   # minecraft_args=
   # minecraft_java_version=
   
   

2. make /tmp writable for every users chmod a+w /tmp
3. Start the server for the first time service minecraft start
4. Check the logs with tail /var/log/minecraft-server/latest.log

   [17:20:28] [ServerMain/WARN]: Failed to load eula.txt
   [17:20:28] [ServerMain/INFO]: You need to agree to the EULA in order to run the server. Go to eula.txt for more info.
   

5. Edit eula.txt with vim /usr/local/etc/minecraft-server/eula.txt
6. Then restart the server again with service minecraft start
7. Follow the logs tail -f /var/log/minecraft-server/latest.log
8. Access the minecraft console service minecraft console
9. Quit the console Ctrl+b then press d or you can do Ctrl+b and type :detach and hit Enter

Upgrade the package to Minecraft 1.21.5

1. cd /usr/ports/games/minecraft-server
2. Edit the Makefile with vim Makefile

    PORTNAME=	minecraft-server
    DISTVERSION=	1.21.5
    CATEGORIES=	games java
    MASTER_SITES=	https://piston-data.mojang.com/v1/objects/e6ec2f64e6080b9b5d9b471b291c33cc7f509733/
    DISTNAME=	server
    EXTRACT_SUFX=	.jar
    DIST_SUBDIR=	${PORTNAME}-${DISTVERSION}   
   

   You can the url from the minecraft official server download page
3. Update the distfile make clean makesum
4. Then rebuild and install env USE_PACKAGE_DEPENDS_ONLY=yes make reinstall
5. Restart the server to be in 1.21.5 service minecraft restart

References / External links

• Install Minecraft Server FreeBsd official wiki page
• How to quit Tmux Session console
• https://docs.freebsd.org/en/books/porters-handbook/quick-porting/#porting-checksum