~quartsize/puppet-rsh

6fd18a41d4341ec4ece490dc9084e23190605bb2 — Laura Hild 1 year, 10 months ago a807c5a
Slightly improve README.md
1 files changed, 10 insertions(+), 7 deletions(-)

M README.md
M README.md => README.md +10 -7
@@ 1,17 1,20 @@
rsh
===

The rsh module installs, configures, and manages RSH clients, servers, and
.rhosts/hosts.equiv files. It provides three classes and one defined type:
This module installs, configures, and manages RSH clients, servers, and
.rhosts/hosts.equiv files. It provides three classes and one defined type.

```puppet
include rsh
```

includes both `rsh::clients` and `rsh::servers`, the latter of which by default
enables `rshd` only (to enable others, see the class parameters). To manage
`hosts.equiv`, provide an array of lines to `rsh::servers::hosts_equiv`.
enables `rshd` only (to additionally enable `rlogind` or `rexecd`, see the
class parameters). To manage `/etc/hosts.equiv`, provide an array of lines to
`rsh::servers::hosts_equiv`.

The defined type, `rsh::rhosts`, manages user `.rhosts` files. Since a
`.rhosts` is required for root RSH, it also manages the addition of the
necessary line to `/etc/securetty`.
The defined type, `rsh::rhosts`, manages an individual user's `.rhosts` file,
which is required, for example, to enable RSH by `root`, which ignores
`/etc/hosts.equiv`.  Because making a `root` `.rhosts` effective also requires
adding a line to `/etc/securetty`, if `rsh::rhosts`` is used for `root`,
`rsh::rhosts` will also manage the addition of that line.