happyDomain/ansible-collection
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Use spaces instead of tabulation in samples

Browse Source
This commit is contained in:
nemunaire 2023-04-13 08:00:15 +02:00
parent 4626ec797d
commit da8b440225
1 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
README.md
View File

@ -34,7 +34,7 @@ To setup happyDomain as a local service (support Docker, openrc and systemd), us
```yaml ```yaml
roles: roles:
- name: happydns.happydomain.happydomain - name: happydns.happydomain.happydomain
use_container: no # yes if you want to use Docker instead use_container: no # yes if you want to use Docker instead
``` ```
### Create a user account on your happyDomain instance ### Create a user account on your happyDomain instance
@ -42,8 +42,8 @@ To setup happyDomain as a local service (support Docker, openrc and systemd), us
```yaml ```yaml
tasks: tasks:
- happydns.happydomain.user: - happydns.happydomain.user:
username: frederic@happydomain.org username: frederic@happydomain.org
password: "mySuperS3cur3P4$$w0rd" password: "mySuperS3cur3P4$$w0rd"
``` ```
This will create and enabled the user (no need to validate the email). This will create and enabled the user (no need to validate the email).
@ -56,15 +56,15 @@ Eg. for an AXFR/DDNS provider:
```yaml ```yaml
tasks: tasks:
- happydns.happydomain.provider: - happydns.happydomain.provider:
name: test name: test
type: DDNSServer type: DDNSServer
data: data:
server: 192.168.0.42 server: 192.168.0.42
keyname: ddns keyname: ddns
algorithm: hmac-sha256 algorithm: hmac-sha256
keyblob: yourBASE64Secret== keyblob: yourBASE64Secret==
happydomain_username: frederic@happydomain.org happydomain_username: frederic@happydomain.org
happydomain_password: "mySuperS3cur3P4$$w0rd" happydomain_password: "mySuperS3cur3P4$$w0rd"
``` ```
@ -73,10 +73,10 @@ Eg. for an AXFR/DDNS provider:
```yaml ```yaml
tasks: tasks:
- happydns.happydomain.domain: - happydns.happydomain.domain:
provider: test provider: test
domain: happydomain.tf domain: happydomain.tf
happydomain_username: frederic@happydomain.org happydomain_username: frederic@happydomain.org
happydomain_password: "mySuperS3cur3P4$$w0rd" happydomain_password: "mySuperS3cur3P4$$w0rd"
``` ```
### Create a new record for a domain ### Create a new record for a domain
@ -86,11 +86,11 @@ First, you need a zoneid:
```yaml ```yaml
tasks: tasks:
- happydns.happydomain.domain: - happydns.happydomain.domain:
provider: test provider: test
domain: happydomain.tf domain: happydomain.tf
happydomain_username: frederic@happydomain.org happydomain_username: frederic@happydomain.org
happydomain_password: "mySuperS3cur3P4$$w0rd" happydomain_password: "mySuperS3cur3P4$$w0rd"
register: my_zone register: my_zone
``` ```
Note the `register`ed variable. Note the `register`ed variable.
@ -100,16 +100,16 @@ Then, use the `happydns.happydomain.service` module:
```yaml ```yaml
tasks: tasks:
- happydns.happydomain.service: - happydns.happydomain.service:
happydomain_username: frederic@happydomain.org happydomain_username: frederic@happydomain.org
happydomain_password: "mySuperS3cur3P4$$w0rd" happydomain_password: "mySuperS3cur3P4$$w0rd"
domain: happydomain.tf domain: happydomain.tf
zone: "{{ my_zone.current_zone }}" zone: "{{ my_zone.current_zone }}"
subdomain: "test" subdomain: "test"
type: abstract.Server type: abstract.Server
service: service:
A: 127.0.0.1 A: 127.0.0.1
AAAA: "::1" AAAA: "::1"
apply_changes: yes apply_changes: yes
``` ```
This will add two records under `test.happydomain.tf`: A and AAAA (part of `abstract.Server`). This will add two records under `test.happydomain.tf`: A and AAAA (part of `abstract.Server`).
@ -122,16 +122,16 @@ You'll also need a zoneid, see previous section. Then:
```yaml ```yaml
tasks: tasks:
- happydns.happydomain.service: - happydns.happydomain.service:
happydomain_username: frederic@happydomain.org happydomain_username: frederic@happydomain.org
happydomain_password: "mySuperS3cur3P4$$w0rd" happydomain_password: "mySuperS3cur3P4$$w0rd"
domain: happydomain.tf domain: happydomain.tf
zone: "{{ my_zone.current_zone }}" zone: "{{ my_zone.current_zone }}"
subdomain: "test" subdomain: "test"
type: scvs.TXT type: scvs.TXT
service: service:
content: "This is a test record" content: "This is a test record"
state: absent state: absent
apply_changes: yes apply_changes: yes
``` ```
This will remove all records matching: This will remove all records matching: