diff --git a/README.md b/README.md index e94fdfe748d154f4177aa6144144a694ebbdef26..2651313a2225f2f397267698b9ad4f2f3c3a67d5 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,31 @@ This role installs and configures an OpenSSH-Server. It uses [Mozilla's Modern C ## Variables -- `sshd_ports`: The ports sshd should listen on. (Default: 22) +- `sshd_ports`: The ports (as list) sshd should listen on. (Default: 22) - `sshd_permit_root_login`: Allow Root-Login (Default: no) - `sshd_allow_pubkeys`: Allow login with pubkey (Default: yes) - `sshd_allow_passwords`: Allow login with passwords (Default: no) - `sshd_print_motd`: Print the MotD after login (Default: no) -- `sshd_agent_forwarding`: Allow Agent-Forwarding (Default: yes) -- `sshd_tcp_forwarding`: Allow TCP-Forwarding (Default: yes) -- `sshd_x11_forwarding`: Allow X11-Forwarding (Default: yes) +- `sshd_agent_forwarding`: Allow Agent-Forwarding (Default: no) +- `sshd_tcp_forwarding`: Allow TCP-Forwarding (Default: no) +- `sshd_x11_forwarding`: Allow X11-Forwarding (Default: no) - `sshd_listen_addresses`: The addresses sshd should listen on. (Default: 0.0.0.0 and ::) + + +## Example Playbook + +In your requirements.yml add: +```yaml +- src: https://gitlab.fachschaften.org/fsi-ansible/sshd.git + scm: git + name: sshd + version: "v2.5.2" +``` + +In your Playbook add: +```yaml + - name: Setup and configure sshd + become: yes + roles: + - sshd +```