summaryrefslogtreecommitdiff
path: root/README.md
blob: ca8c2df46f8f92296c69d0e1c329fb4929fe849f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# PowerDNSex

A client to [PowerDNS 4 API](https://doc.powerdns.com/md/httpapi/README/), with all CRUD operations to manage zones and records.

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:

  1. Add `powerdnsex` to your list of dependencies in `mix.exs`:

    ```elixir
    def deps do
      [{:powerdnsex, "~> 0.1.0"}]
    end
    ```

  2. Ensure `powerdnsex` is started before your application:

    ```elixir
    def application do
      [applications: [:powerdnsex]]
    end
    ```

## Configuration with env vars
Insert this in your Phoenix configuration files. Eg:  `config.exs`
```elixir
config :powerdnsex, url: {:system, "POWERDNS_URL"},
                    token: {:system, "POWERDNS_TOKEN"}
```
Make sure you set those envinronment variables.

## Example usage

### Zone Management

```elixir
# CREATE ZONE:
zone_model = %PowerDNSex.Models.Zone{
  id: "example.com.",
  kind: "Master",
  name: "example.com.",
  serial: 1,
}
{:ok, zone} = PowerDNSex.create_zone(zone_model)

# SHOW ZONE:
{:ok, zone} = PowerDNSex.show_zone("example.com")

# DELETE ZONE:
res = PowerDNSex.delete_zone("example.com")
```


### Record management

```elixir
# CREATE RECORD:
{:ok, zone} = PowerDNSex.show_zone("example.com")
record = %{
  name: "test.example.com.",
  type: "A",
  ttl: 60,
  records: [
    %{
      content: "192.168.11.67",
      disabled: false,
    }
  ]
}
res = PowerDNSex.create_record(zone, record)

# SHOW RECORD:
record = %{
  name: "test.example.com.",
  type: "A",
}
rrset = PowerDNSex.show_record("example.com", record)

# UPDATE RECORD:
{:ok, zone} = PowerDNSex.show_zone("example.com")
record = %{
  name: "test.example.com.",
  type: "A",
  ttl: 60,
  records: [
    %{
      content: "192.168.11.100",
      disabled: false,
    }
  ]
}
res = PowerDNSex.update_record(zone, record)

# DELETE RECORD:
{:ok, zone} = PowerDNSex.show_zone("example.com")
record = %{
  name: "test.example.com.",
  type: "A",
}
rrset = PowerDNSex.show_record("example.com", record)
res = PowerDNSex.delete_record(zone, rrset)
```