aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorStefan Joosten <stefan@sjoosten.nl>2016-08-01 00:26:16 +0200
committerStefan Joosten <stefan@sjoosten.nl>2016-08-01 00:26:16 +0200
commitfd2c9d5e351319e433838fe81b44b09af754555b (patch)
tree955afec5d29cb50ba0e28fbf1c5e67db11846217 /README.md
parent13c1f320d66b781913cfa867ba7f7fe53daeeaac (diff)
downloadansible-teamspeak-fd2c9d5e351319e433838fe81b44b09af754555b.tar.gz
ansible-teamspeak-fd2c9d5e351319e433838fe81b44b09af754555b.tar.xz
ansible-teamspeak-fd2c9d5e351319e433838fe81b44b09af754555b.zip
Updated README
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 12 insertions, 12 deletions
diff --git a/README.md b/README.md
index bd772b8..8e36bf5 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
TeamSpeak 3 Server
==================
-Role that deploys a TeamSpeak 3 server.
+Role to deploy a TeamSpeak 3 server.
Inspired by [dharmab/ansible-playbooks/roles/teamspeak](https://github.com/dharmab/ansible-playbooks/tree/master/roles/teamspeak).
TeamSpeak 3 servers installed with this role can also be updated to newer versions with this role.
@@ -16,20 +16,20 @@ Tested on Ubuntu 16.04.1.
Role Variables
--------------
-defaults/main.yml:
+<tt>defaults/main.yml</tt>:
-* teamspeak.user: User to run the teamspeak server. Defaults to "teamspeak".
-* teamspeak.comment: User comment field. Defaults to "Teamspeak 3 user".
-* teamspeak.home: Home directory for the teamspeak user. Will also be used to install the teamspeak server in. Defaults to "/opt/teamspeak".
-* teamspeak.shell: Shell for the teamspeak user. Defaults to "/usr/sbin/nologin".
-* teamspeak.symlink: Name of symlink to point to current TeamSpeak 3 server directory. Defaults to "current".
-* teamspeak.version: Version of Teamspeak 3 Server to install. Defaults to "3.0.12.4".
-* teamspeak.checksum: SHA256 checksum of archive of TeamSpeak 3 server version for verification purposes. Example: "sha256:6bb0e8c8974fa5739b90e1806687128342b3ab36510944f576942e67df7a1bd9"
-* teamspeak.keep: Amount of TeamSpeak 3 server versions to keep installed, includes current version. A setting of "2" keeps the current and one previous version installed.
+* <tt>teamspeak.user</tt>: User to run the teamspeak server. Defaults to "teamspeak".
+* <tt>teamspeak.comment</tt>: User comment field. Defaults to "Teamspeak 3 user".
+* <tt>teamspeak.home</tt>: Home directory for the teamspeak user. Will also be used to install the teamspeak server in. Defaults to "/opt/teamspeak".
+* <tt>teamspeak.shell</tt>: Shell for the teamspeak user. Defaults to "/usr/sbin/nologin".
+* <tt>teamspeak.symlink</tt>: Name of symlink to point to current TeamSpeak 3 server directory. Defaults to "current".
+* <tt>teamspeak.version</tt>: Version of Teamspeak 3 Server to install. Defaults to "3.0.12.4".
+* <tt>teamspeak.checksum</tt>: SHA256 checksum of archive of TeamSpeak 3 server version for verification purposes. Example: "sha256:6bb0e8c8974fa5739b90e1806687128342b3ab36510944f576942e67df7a1bd9"
+* <tt>teamspeak.keep</tt>: Amount of TeamSpeak 3 server versions to keep installed, includes current version. A setting of "2" keeps the current and one previous version installed.
-vars/{debian,redhat}.yml:
+<tt>vars/{debian,redhat}.yml</tt>:
-* systemd_service_file_path: Path where Systemd service files are installed.
+* <tt>systemd_service_file_path</tt>: Path where Systemd service files are installed.
Dependencies
------------