summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md33
1 files changed, 22 insertions, 11 deletions
diff --git a/README.md b/README.md
index c756bcd..5228dcf 100644
--- a/README.md
+++ b/README.md
@@ -5,29 +5,40 @@ Manage rsyslog client and server via Puppet
## How to use
### Client
+#### Using default values
```
- include rsyslog::client
+ class { 'rsyslog::client': }
```
-Default server name is set to 'log'
-
-#### Using a different server
+#### Variables and default values
```
- $rsyslog_server = 'another-server'
- include rsyslog::client
+ class { 'rsyslog::client':
+ log_local => false,
+ log_auth_local => false,
+ custom_config => undef,
+ server => 'log',
+ }
```
### Server
+#### Using default values
```
- include rsyslog::server
+ class { 'rsyslog::server': }
```
-Both can be installed at the same time.
+#### Variables and default values
+```
+ class { 'rsyslog::server':
+ enable_tcp => true,
+ enable_udp => true,
+ server_dir => '/srv/log/',
+ custom_config => undef,
+ high_precision_timestamps => false,
+ }
+```
-#### Other variables
-* $rsyslog_server_dir = '/srv/log/'
+Both can be installed at the same time.
### Other notes
* rsyslog::client is logging through relp
-* rsyslog::server is running relp, udp and tcp