initial commitHEADmain

1 files changed, 35 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c08db5b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Ansible role to setup domains on a uberspace
+
+Role to setup domains on a [uberspace](https://manual.uberspace.de/en/web-domains.html).
+Both web and mail domains are supported.
+
+## Requirements
+
+* The domains must be specified in the host inventory
+
+## Example Setup
+
+### Inventory
+```yml
+group:
+  hosts:
+    example.uber.space:
+    ansible_user: example
+    remote_user: example
+    domains:
+      - www.example.tld
+    mail_domains:
+      - mail.example.tld
+```
+
+### Playbook
+```yml
+- hosts: host-pattern
+  roles:
+    - uberspace_domains
+```
+
+## License
+
+This ansible role is licensed under the term of the GPLv3.  
+For further information see the `COPYING` file or [https://www.gnu.org/licenses/gpl-3.0.en.html](https://www.gnu.org/licenses/gpl-3.0.en.html).