Skip to content

Commit 799be5f

Browse files
committed
Improve README.md in preparation for public release
Add a section about how to include this role from github with ansible-galaxy.
1 parent e7ceda1 commit 799be5f

1 file changed

Lines changed: 25 additions & 10 deletions

File tree

README.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ ThinLinc Server
22
===============
33

44
This role takes care of installing, configuring and starting the
5-
ThinLinc Server software.
5+
ThinLinc server software. The ThinLinc server software is not included
6+
in this role, and will have to be obtained separately.
67

78

89
License
@@ -67,19 +68,27 @@ thinlinc_webadm_password: "$6$7cc31a35e02e55ec$hm.1MsloeBJqNKljx9RH88Z/eRKZCka5Z
6768
```
6869
6970
ThinLinc Web Administration password. This default password is
70-
"thinlinc". Generate new hashes with /opt/thinlinc/sbin/tl-gen-auth.
71+
"thinlinc". Generate new hashes with `/opt/thinlinc/sbin/tl-gen-auth`.
7172

7273

73-
Dependencies
74-
------------
75-
76-
No external Ansible dependencies.
74+
Examples
75+
--------
7776

77+
This role can be installed through ansible-galaxy with a
78+
`requirements.yml` file. Run `ansible-galaxy install -r
79+
requirements.yml` to install the role:
7880

79-
Example Playbook
80-
----------------
81+
```yml
82+
---
83+
- src: https:///github.com/cendio/ansible-role-thinlinc-server.git
84+
scm: git
85+
name: thinlinc-server
86+
version: v1.0
87+
```
8188

82-
Example inventory file:
89+
The role uses three groups - thinlinc-masters, thinlinc-agents and
90+
thinlinc-servers. Here's an example inventory file with one master
91+
server and three agent servers:
8392

8493
```yaml
8594
[thinlinc-masters]
@@ -95,10 +104,16 @@ thinlinc-masters
95104
thinlinc-agents
96105
```
97106

98-
Example playbook:
107+
Now that we got both a role and an inventory, connect the dots by
108+
applying the thinlinc-server role to the thinlinc-servers group with a
109+
`thinlinc.yml` playbook:
99110

100111
```yaml
101112
- hosts: thinlinc-servers
102113
roles:
103114
- { role: thinlinc-server, thinlinc_accept_eula: "yes" }
104115
```
116+
117+
The final step is to apply the playbook to the inventory, like this:
118+
119+
`ansible -i inventory thinlinc.yml`

0 commit comments

Comments
 (0)