You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+18-46Lines changed: 18 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,24 +3,15 @@ ansible-minecraft
3
3
4
4
|Build Status|
5
5
6
-
This role installs vanilla `Minecraft <https://minecraft.net/>`__ and
7
-
configures it to run under
8
-
`systemd <https://wiki.freedesktop.org/www/Software/systemd/>`__ or
9
-
`Supervisor <http://supervisord.org/>`__.
6
+
This role installs vanilla `Minecraft <https://minecraft.net/>`__ and configures it to run under `systemd <https://wiki.freedesktop.org/www/Software/systemd/>`__ or `Supervisor <http://supervisord.org/>`__.
10
7
11
-
**If you're viewing this at
12
-
https://github.com/benwebber/ansible-minecraft/, you're reading the
13
-
documentation for the master branch. `View documentation for the latest
**If you're viewing this at https://github.com/benwebber/ansible-minecraft/, you're reading the documentation for the master branch. `View documentation for the latest release (3.0.0). <https://github.com/benwebber/ansible-minecraft/tree/v3.0.0#ansible-minecraft>`__**
16
9
17
10
Requirements
18
11
------------
19
12
20
-
- **Optional:** Python 2.7 on the Ansible control machine to generate
21
-
user ACLs
22
-
- **Optional:** Ansible 2.0.2+ or ``curl`` on the control machine to
23
-
fetch the latest Minecraft version
13
+
- **Optional:** Python 2.7 on the Ansible control machine to generate user ACLs
14
+
- **Optional:** Ansible 2.0.2+ or ``curl`` on the control machine to fetch the latest Minecraft version
24
15
25
16
Features
26
17
--------
@@ -40,11 +31,8 @@ Features
40
31
| CentOS 7 || ✓ |
41
32
+----------------+--------------+-----------+
42
33
43
-
- safely stops the server using
44
-
`stop <http://minecraft.gamepedia.com/Commands#stop>`__ when
45
-
running under **systemd**
46
-
- uses `Docker <https://www.docker.com/>`__ and
47
-
`Serverspec <http://serverspec.org/>`__ to run integration tests
34
+
- safely stops the server using `stop <http://minecraft.gamepedia.com/Commands#stop>`__ when running under **systemd**
35
+
- uses `Docker <https://www.docker.com/>`__ and `Serverspec <http://serverspec.org/>`__ to run integration tests
48
36
- manages user ACLs
49
37
- manages ``server.properties``
50
38
- hooks: include arbitrary tasks at specific stages during execution
@@ -54,13 +42,10 @@ Versioning
54
42
55
43
This project follows `semantic versioning <http://semver.org/>`__.
56
44
57
-
In the context of semantic versioning, consider the role contract to be
58
-
defined by the role variables.
45
+
In the context of semantic versioning, consider the role contract to be defined by the role variables.
59
46
60
-
- Changes that require user intervention will increase the **major**
61
-
version. This includes changing the default value of a role variable.
62
-
- Changes that do not require user intervention, but add
63
-
backwards-compatible features, will increase the **minor** version.
47
+
- Changes that require user intervention will increase the **major** version. This includes changing the default value of a role variable.
48
+
- Changes that do not require user intervention, but add backwards-compatible features, will increase the **minor** version.
64
49
- Bug fixes will increase the **patch** version.
65
50
66
51
Refer to the `change log <CHANGELOG.rst>`__ for upcoming changes.
@@ -102,12 +87,10 @@ The following variable defaults are defined in ``defaults/main.yml``.
102
87
Java initial memory (``-Xms``) to allocate (default: ``1024M``)
103
88
104
89
``minecraft_service_name``
105
-
systemd service name or Supervisor program name (default:
106
-
``minecraft``)
90
+
systemd service name or Supervisor program name (default: ``minecraft``)
107
91
108
92
``minecraft_supervisor_name``
109
-
**DEPRECATED:** Supervisor program name (default:
110
-
``{{ minecraft_service_name }}``)
93
+
**DEPRECATED:** Supervisor program name (default: ``{{ minecraft_service_name }}``)
111
94
112
95
``minecraft_process_control``
113
96
Choose between ``systemd`` and ``supervisor`` (default: ``systemd``).
@@ -125,8 +108,7 @@ The following variable defaults are defined in ``defaults/main.yml``.
125
108
list of IP addresses to ban (default: ``[]``)
126
109
127
110
``minecraft_server_properties``
128
-
dictionary of server.properties entries (e.g. ``server-port: 25565``)
129
-
to set (default: ``{}``)
111
+
dictionary of server.properties entries (e.g. ``server-port: 25565``) to set (default: ``{}``)
130
112
131
113
Hooks and run stages
132
114
--------------------
@@ -154,10 +136,7 @@ Hooks and run stages
154
136
``start``
155
137
- (re)start server
156
138
157
-
You can execute custom tasks before or after specific stages. Simply
You can execute custom tasks before or after specific stages. Simply specify a `task include file <https://docs.ansible.com/ansible/playbooks_roles.html#task-include-files-and-encouraging-reuse>`__ using the relevant role variable:
161
140
162
141
.. code:: yaml
163
142
@@ -204,25 +183,22 @@ Example
204
183
Contributing
205
184
------------
206
185
207
-
Pull requests are welcome. Among other features, this role lacks support
208
-
for custom Minecraft servers.
186
+
Pull requests are welcome. Among other features, this role lacks support for custom Minecraft servers.
209
187
210
188
Testing
211
189
~~~~~~~
212
190
213
191
This role includes a Docker-based test harness for integration testing.
214
192
215
-
1. Install `Docker <https://docs.docker.com/engine/installation/>`__ and
1. Install `Docker <https://docs.docker.com/engine/installation/>`__ and `Docker Compose <https://docs.docker.com/compose/>`__.
217
194
218
195
2. Run tests with ``make``.
219
196
220
197
::
221
198
222
199
make jessie64 test
223
200
224
-
Integration tests use **systemd** by default. Set ``PROCESS_CONTROL`` to
225
-
change this:
201
+
Integration tests use **systemd** by default. Set ``PROCESS_CONTROL`` to change this:
226
202
227
203
::
228
204
@@ -238,10 +214,6 @@ Apache 2.0
238
214
Disclaimer
239
215
----------
240
216
241
-
To automate the installation, this role automatically accepts the
242
-
`Minecraft
243
-
EULA <https://account.mojang.com/documents/minecraft_eula>`__. Be aware
244
-
that by using this role, you implicitly accept the same EULA.
217
+
To automate the installation, this role automatically accepts the `Minecraft EULA <https://account.mojang.com/documents/minecraft_eula>`__. Be aware that by using this role, you implicitly accept the same EULA.
0 commit comments