badjware
/
ansible-minecraft-server
1
0
Fork 0
Code Releases Activity

move machine creation to prereqs

This commit is contained in:
Massaki Archambault 2023-06-15 01:19:58 -04:00
parent 7d9ec6af10
commit 2ddad999e3
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -2,23 +2,24 @@
An ansible role to deploy a minecraft server.
Playbook was tested on a Ubuntu 22.04 LXC container hosted in Proxmox 7.4.
## Prerequisites
* Some basic Linux knowledge.
* Some way of provisioning a machine to host the server.
* A machine to host the minecraft server.
* Exact steps will vary depending on your hosting solution. Refer to their documentation.
* Refer to the [wiki](https://minecraft.fandom.com/wiki/Server/Requirements) for recommendations on the appropriate size of the machine for your expected player count.
* Make sure to create a user account on the server with access to the command `sudo` (sudoer). Make this account have the same name as your local user account to simplify deployment.
* [ansible](https://docs.ansible.com/ansible/latest/index.html)
## Deploy
1. Provision a machine to host the minecraft server.
* Exact steps will vary depending on your hosting solution. Refer to their documentation.
* Refer to the [wiki](https://minecraft.fandom.com/wiki/Server/Requirements) for recommendations on the appropriate size of the machine for your expected player count.
* Make sure to create a user account on the server with access to the command `sudo` (sudoer). Make this account have the same name as your local user account to simplify the next steps.
2. Edit *hosts* and replace `minecraft-server` with the hostname or ip of the machine hosting the minecraft server.
3. Edit *group_vars/minecraft-server.yaml* to change the basic server configuration. Refer to **Configuration options** below for more detail on available configurations.
1. Edit *hosts* and replace `minecraft-server` with the hostname or ip of the machine hosting the minecraft server.
2. Edit *group_vars/minecraft-server.yaml* to change the basic server configuration. Refer to **Configuration options** below for more detail on available configurations.
* Set `mc_server_memory` to an appropriate value.
* Optionally, configure `mc_server_ops` to be the info of a server "operator" (admin).
4. Deploy the minecraft server using the command: `ansible-playbook --ask-become-pass -i hosts site.yaml`
3. Deploy the minecraft server using the command: `ansible-playbook --ask-become-pass -i hosts site.yaml`
* You will be prompted for a password by ansible. Provide the password that you would use to run a command with `sudo` on the server.
## Configuration options