-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from chrisglass/documentation
Added a slightly more beautiful and complete README
- Loading branch information
Showing
2 changed files
with
33 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
=================== | ||
mdns puppet module | ||
=================== | ||
|
||
Author: Daniel Leyden | ||
|
||
Supports the installation of avahi and publishing of services | ||
|
||
|
||
Usage | ||
====== | ||
|
||
Service | ||
------- | ||
To declare (expose an mdns service):: | ||
|
||
mdns::service { | ||
'myservice-%h': # %h is your hostname | ||
type => '_myservice._tcp', # The mdns service type | ||
port => '1234'; # The port your service is listening on | ||
} | ||
|
||
.. note:: Make sure your service definition contains a unique qulifier - puppet | ||
will not like having two instances with the same name | ||
|
||
Using the information | ||
--------------------- | ||
|
||
To use (consume a service):: | ||
|
||
# To get an array of all the services of a specific type: | ||
$a_variable = get_hosts_for_mdns_service('_myservice._tcp') | ||
|