Skip to content

Latest commit

 

History

History
81 lines (45 loc) · 1.97 KB

README.md

File metadata and controls

81 lines (45 loc) · 1.97 KB
Raw

ansible-minecraft

This role installs vanilla Minecraft and configures it to run under Supervisor.

Requirements

This role supports Debian and Debian-based distributions (e.g., Ubuntu).

Role variables

The following variable defaults are defined in defaults/main.yml.

  • minecraft_version

    Minecraft version to install (default: 1.8)

  • minecraft_url

    Minecraft download URL (default: https://s3.amazonaws.com/Minecraft.Download/versions)

  • minecraft_user

    system user Minecraft runs as (default: minecraft)

  • minecraft_group

    system group Minecraft runs as (default: minecraft)

  • minecraft_home

    directory to install Minecraft to (default: /srv/minecraft)

  • minecraft_max_memory

    Java max memory (-Xmx) to allocate (default: 1024M)

  • minecraft_initial_memory

    Java initial memory (-Xms) to allocate (default: 1024M)

  • minecraft_supervisor_name

    Supervisor program name (default: minecraft)

  • minecraft_whitelist

    list of Minecraft usernames to whitelist (default: [])

  • minecraft_ops

    list of Minecraft usernames to make server ops (default: [])

  • minecraft_banned_players

    list of Minecraft usernames to ban (default: [])

  • minecraft_banned_ips

    list of IP addresses to ban (default: [])

Example

- hosts: minecraft
  roles:
     - { role: benwebber.minecraft, minecraft_whitelist: ["jeb_", "dinnerbone"]}

Contributing

Pull requests are welcome. Among other features, this role lacks support for:

  • non-Debian operating systems
  • custom Minecraft servers

This role includes a Vagrantfile to set up the development/testing environment using Vagrant.

License

Apache 2.0

Disclaimer

To automate the installation, this role automatically accepts the Minecraft EULA. Be aware that by using this role, you implicitly accept the same EULA.