From e77171151813109558dd34061cc5c42d104bf180 Mon Sep 17 00:00:00 2001
From: Felix Strick <felix.strick@udo.edu>
Date: Fri, 24 Jun 2022 13:18:54 +0000
Subject: [PATCH] [Readme] Fix default configuration information in readme

---
 README.md | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index e94fdfe..2651313 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
+```
-- 
GitLab