zone-update 0.10.0

A library of CRUD-like operations on DNS zones for multiple providers
Documentation 
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

# Zone Update

[![Crates.io](https://img.shields.io/crates/v/zone-update)](https://crates.io/crates/zone-update)
[![Docs.rs](https://docs.rs/zone-update/badge.svg)](https://docs.rs/zone-update)
[![GitHub CI](https://github.com/tarka/zone-update/actions/workflows/tests.yml/badge.svg)](https://github.com/tarka/zone-update/actions)
[![License](https://img.shields.io/crates/l/zone-update)](https://github.com/tarka/zone-update/blob/main/README.md#License)

A minimal Rust library providing CRUD-like operations on DNS records with various DNS providers.

## Overview

Zone Update is a lightweight library that provides a simple interface for
programmatically managing DNS zone records through provider APIs.
The library is both blocking and async, and supports multiple async runtimes
(see below).

### Supported DNS providers

Currently, Zone Update supports the following DNS providers:

* Cloudflare
* deSEC
* DigitalOcean
* Dnsimple
* DnsMadeEasy
* Gandi
* Linode
* Porkbun

See the [DNS providers matrix](docs/PROVIDERS.md) for more details.

### Supported Runtimes

`zone-update` supports both blocking and async APIs. For async the library
attempts to be as provider-agnostic; it is known (tested) to work with the
following runtimes:

* [tokio](https://tokio.rs/)
* [smol](https://docs.rs/smol/)
* [compio](https://compio.rs/)
* [monoio](https://github.com/bytedance/monoio)
* [glommio](https://github.com/DataDog/glommio)

### Feature flags

Each DNS provider is gated behind their name, however all provider are enabled
by default. To limit the providers you can add `zone-update` to your
`Cargo.toml` in the following format:

```text
zone-update = { version = "*", default-features = false, features = ["digitalocean", "desec"] }
```

The other notable flag is `async`, which is not enabled by default.

## Usage

### Basic Example

```rust
use zone_update::{gandi, DnsProvider, errors::Result};
use std::net::Ipv4Addr;

fn update_gandi_record() -> Result<()> {
    let config = zone_update::Config {
        domain: "example.com".to_string(),
        dry_run: false,
    };
    
    let auth = gandi::Auth::ApiKey("your-api-key".to_string());
    let client = gandi::Gandi::new(config, auth);
    
    let host = "www";
    let new_ip = Ipv4Addr::new(192, 0, 2, 1);

    // Update the A record for www.example.com
    client.update_a_record(host, &new_ip)?;
    
    Ok(())
}
```

See the `examples` directory for other use-cases.

## Contributing

At this point the most useful contributions would be to add additional DNS
provider APIs. However other contributions are welcome.

### AI Contribution Policy

This reason this project will not accept runtime code generated by
AI. Generation of _draft_ documentation and test code is acceptable, but should
be reviewed by the submitter before raising a PR.

## License

This project is licensed under either of:

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE-2.0.txt))
- MIT license ([LICENSE-MIT](LICENSE-MIT))

at your option.