Skip to content

Commit 0186902

Browse files
damacusdamacus
committed
docs: normalize markdown formatting
1 parent cc5c2c7 commit 0186902

9 files changed

Lines changed: 105 additions & 108 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [5.1.19](https://github.com/sous-chefs/djbdns/compare/5.1.18...v5.1.19) (2025-10-15)
99

10-
1110
### Bug Fixes
1211

1312
* **ci:** Update workflows to use release pipeline ([#68](https://github.com/sous-chefs/djbdns/issues/68)) ([76dece1](https://github.com/sous-chefs/djbdns/commit/76dece1864bf325f15114c64628569b7a14a806c))

‎LIMITATIONS.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,9 @@
3232

3333
### Build Dependencies
3434

35-
| Platform Family | Packages / Requirements |
36-
|-----------------|-------------------------|
37-
| Debian | Compiler and build tools; upstream also requires `daemontools` and `ucspi-tcp` |
38-
| RHEL | Compiler and build tools; upstream also requires `daemontools` and `ucspi-tcp` |
39-
| SUSE | Compiler and build tools; upstream also requires `daemontools` and `ucspi-tcp` |
35+
- Debian: compiler and build tools; upstream also requires `daemontools` and `ucspi-tcp`
36+
- RHEL: compiler and build tools; upstream also requires `daemontools` and `ucspi-tcp`
37+
- SUSE: compiler and build tools; upstream also requires `daemontools` and `ucspi-tcp`
4038

4139
## Known Issues
4240

‎MAINTAINERS.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ This file lists how this cookbook project is maintained. When making changes to
66

77
Check out [How Cookbooks are Maintained](https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/CONTRIBUTING.MD) for details on the process and how to become a maintainer or the project lead.
88

9-
# Project Maintainer
9+
## Project Maintainer
1010

1111
* [Tim Smith](https://github.com/tas50)
1212

13-
# Maintainers
13+
## Maintainers
1414

1515
* [Jennifer Davis](https://github.com/sigje)
1616
* [Tim Smith](https://github.com/tas50)

‎documentation/djbdns_axfr.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,29 @@ Creates the axfrdns service directory, bootstraps the `axfrdns` user, and enable
44

55
## Actions
66

7-
| Action | Description |
8-
|--------|-------------|
7+
| Action | Description |
8+
|-----------|------------------------------------------------------|
99
| `:create` | Configures and enables the axfrdns service (default) |
1010

1111
## Properties
1212

13-
| Property | Type | Default | Description |
14-
|----------|------|---------|-------------|
15-
| `service_name` | String | name property | Service name, typically `axfrdns` |
16-
| `manage_install` | Boolean | `true` | Also run `djbdns_install` before configuring the service |
17-
| `install_method` | String | platform-dependent | Install via `package` or `source` |
18-
| `package_name` | String | `'djbdns'` | Package name for package installs |
19-
| `source_url` | String | `'https://cr.yp.to/djbdns/djbdns-1.05.tar.gz'` | Upstream source tarball |
20-
| `bin_dir` | String | derived from `install_method` | Location of djbdns binaries used by runit |
21-
| `service_dir` | String | `'/etc/djbdns/axfrdns'` | Service root directory |
22-
| `sv_dir` | String | `'/etc/sv'` | runit service directory |
23-
| `service_link_dir` | String | `'/etc/service'` | runit enabled-service directory |
24-
| `listen_ip` | String | `'127.0.0.1'` | Address passed to `axfrdns-conf` |
25-
| `tinydns_dir` | String | `'/etc/djbdns/tinydns'` | Public tinydns directory used by axfrdns |
26-
| `axfrdns_uid` | Integer | `9996` | UID for the `axfrdns` account |
27-
| `dnscache_uid` | Integer | `9997` | UID for the `dnscache` account |
28-
| `dnslog_uid` | Integer | `9998` | UID for the `dnslog` account |
29-
| `tinydns_uid` | Integer | `9999` | UID for the `tinydns` account |
13+
| Property | Type | Default | Description |
14+
|--------------------|---------|------------------------------------------------|----------------------------------------------------------|
15+
| `service_name` | String | name property | Service name, typically `axfrdns` |
16+
| `manage_install` | Boolean | `true` | Also run `djbdns_install` before configuring the service |
17+
| `install_method` | String | platform-dependent | Install via `package` or `source` |
18+
| `package_name` | String | `'djbdns'` | Package name for package installs |
19+
| `source_url` | String | `'https://cr.yp.to/djbdns/djbdns-1.05.tar.gz'` | Upstream source tarball |
20+
| `bin_dir` | String | derived from `install_method` | Location of djbdns binaries used by runit |
21+
| `service_dir` | String | `'/etc/djbdns/axfrdns'` | Service root directory |
22+
| `sv_dir` | String | `'/etc/sv'` | runit service directory |
23+
| `service_link_dir` | String | `'/etc/service'` | runit enabled-service directory |
24+
| `listen_ip` | String | `'127.0.0.1'` | Address passed to `axfrdns-conf` |
25+
| `tinydns_dir` | String | `'/etc/djbdns/tinydns'` | Public tinydns directory used by axfrdns |
26+
| `axfrdns_uid` | Integer | `9996` | UID for the `axfrdns` account |
27+
| `dnscache_uid` | Integer | `9997` | UID for the `dnscache` account |
28+
| `dnslog_uid` | Integer | `9998` | UID for the `dnslog` account |
29+
| `tinydns_uid` | Integer | `9999` | UID for the `tinydns` account |
3030

3131
## Examples
3232

‎documentation/djbdns_cache.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,30 @@ Creates the public dnscache service directory, manages allowed client networks,
44

55
## Actions
66

7-
| Action | Description |
8-
|--------|-------------|
7+
| Action | Description |
8+
|-----------|--------------------------------------------------------------|
99
| `:create` | Configures and enables the public dnscache service (default) |
1010

1111
## Properties
1212

13-
| Property | Type | Default | Description |
14-
|----------|------|---------|-------------|
15-
| `service_name` | String | name property | Service name, typically `public-dnscache` |
16-
| `manage_install` | Boolean | `true` | Also run `djbdns_install` before configuring the service |
17-
| `install_method` | String | platform-dependent | Install via `package` or `source` |
18-
| `package_name` | String | `'djbdns'` | Package name for package installs |
19-
| `source_url` | String | `'https://cr.yp.to/djbdns/djbdns-1.05.tar.gz'` | Upstream source tarball |
20-
| `bin_dir` | String | derived from `install_method` | Location of djbdns binaries used by runit |
21-
| `service_dir` | String | `'/etc/djbdns/public-dnscache'` | Service root directory |
22-
| `listen_ip` | String | `node['ipaddress']` | Address passed to `dnscache-conf` |
23-
| `allowed_networks` | Array | first two IP octets | Networks allowed to query the cache |
24-
| `resolved_domain` | String | `node['domain'] || 'domain.local'` | Internal domain pinned to localhost |
25-
| `resolved_reverse_domains` | Array | RFC 6303-style defaults | Reverse zones pinned to localhost |
26-
| `cache_size` | String | `'1000000'` | dnscache `CACHESIZE` environment value |
27-
| `data_limit` | String | `'3000000'` | dnscache `DATALIMIT` environment value |
28-
| `dnscache_uid` | Integer | `9997` | UID for the `dnscache` account |
29-
| `dnslog_uid` | Integer | `9998` | UID for the `dnslog` account |
30-
| `tinydns_uid` | Integer | `9999` | UID for the `tinydns` account |
13+
| Property | Type | Default | Description |
14+
| -------------------------- | ------- | ---------------------------------------------- | -------------------------------------------------------- |
15+
| `service_name` | String | name property | Service name, typically `public-dnscache` |
16+
| `manage_install` | Boolean | `true` | Also run `djbdns_install` before configuring the service |
17+
| `install_method` | String | platform-dependent | Install via `package` or `source` |
18+
| `package_name` | String | `'djbdns'` | Package name for package installs |
19+
| `source_url` | String | `'https://cr.yp.to/djbdns/djbdns-1.05.tar.gz'` | Upstream source tarball |
20+
| `bin_dir` | String | derived from `install_method` | Location of djbdns binaries used by runit |
21+
| `service_dir` | String | `'/etc/djbdns/public-dnscache'` | Service root directory |
22+
| `listen_ip` | String | `node['ipaddress']` | Address passed to `dnscache-conf` |
23+
| `allowed_networks` | Array | first two IP octets | Networks allowed to query the cache |
24+
| `resolved_domain` | String | `node['domain'] \|\| 'domain.local'` | Internal domain pinned to localhost |
25+
| `resolved_reverse_domains` | Array | RFC 6303-style defaults | Reverse zones pinned to localhost |
26+
| `cache_size` | String | `'1000000'` | dnscache `CACHESIZE` environment value |
27+
| `data_limit` | String | `'3000000'` | dnscache `DATALIMIT` environment value |
28+
| `dnscache_uid` | Integer | `9997` | UID for the `dnscache` account |
29+
| `dnslog_uid` | Integer | `9998` | UID for the `dnslog` account |
30+
| `tinydns_uid` | Integer | `9999` | UID for the `tinydns` account |
3131

3232
## Examples
3333

‎documentation/djbdns_install.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@ Installs djbdns and creates the base service accounts and directories used by th
44

55
## Actions
66

7-
| Action | Description |
8-
|--------|-------------|
7+
| Action | Description |
8+
|-----------|-----------------------------------------------------------------------|
99
| `:create` | Installs djbdns and bootstraps shared users and directories (default) |
1010

1111
## Properties
1212

13-
| Property | Type | Default | Description |
14-
|----------|------|---------|-------------|
15-
| `instance_name` | String | name property | Resource identity |
16-
| `install_method` | String | platform-dependent | Install via `package` or `source` |
17-
| `package_name` | String | `'djbdns'` | Package name for package installs |
18-
| `source_url` | String | `'https://cr.yp.to/djbdns/djbdns-1.05.tar.gz'` | Upstream source tarball |
19-
| `bin_dir` | String | derived from `install_method` | Install location for djbdns binaries |
20-
| `dnscache_uid` | Integer | `9997` | UID for the `dnscache` account |
21-
| `dnslog_uid` | Integer | `9998` | UID for the `dnslog` account |
22-
| `tinydns_uid` | Integer | `9999` | UID for the `tinydns` account |
13+
| Property | Type | Default | Description |
14+
|------------------|---------|------------------------------------------------|--------------------------------------|
15+
| `instance_name` | String | name property | Resource identity |
16+
| `install_method` | String | platform-dependent | Install via `package` or `source` |
17+
| `package_name` | String | `'djbdns'` | Package name for package installs |
18+
| `source_url` | String | `'https://cr.yp.to/djbdns/djbdns-1.05.tar.gz'` | Upstream source tarball |
19+
| `bin_dir` | String | derived from `install_method` | Install location for djbdns binaries |
20+
| `dnscache_uid` | Integer | `9997` | UID for the `dnscache` account |
21+
| `dnslog_uid` | Integer | `9998` | UID for the `dnslog` account |
22+
| `tinydns_uid` | Integer | `9999` | UID for the `tinydns` account |
2323

2424
## Examples
2525

‎documentation/djbdns_internal_server.md‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,34 @@ Creates the internal tinydns service and supports either explicit record data or
44

55
## Actions
66

7-
| Action | Description |
8-
|--------|-------------|
7+
| Action | Description |
8+
|-----------|---------------------------------------------------------------|
99
| `:create` | Configures and enables the internal tinydns service (default) |
1010

1111
## Properties
1212

13-
| Property | Type | Default | Description |
14-
|----------|------|---------|-------------|
15-
| `service_name` | String | name property | Service name, typically `tinydns-internal` |
16-
| `manage_install` | Boolean | `true` | Also run `djbdns_install` before configuring the service |
17-
| `install_method` | String | platform-dependent | Install via `package` or `source` |
18-
| `package_name` | String | `'djbdns'` | Package name for package installs |
19-
| `source_url` | String | `'https://cr.yp.to/djbdns/djbdns-1.05.tar.gz'` | Upstream source tarball |
20-
| `bin_dir` | String | derived from `install_method` | Location of djbdns binaries used by runit |
21-
| `service_dir` | String | `'/etc/djbdns/tinydns-internal'` | Service root directory |
22-
| `sv_dir` | String | `'/etc/sv'` | runit service directory |
23-
| `service_link_dir` | String | `'/etc/service'` | runit enabled-service directory |
24-
| `listen_ip` | String | `'127.0.0.1'` | Address passed to `tinydns-conf` |
25-
| `zone_domain` | String | `node['domain'] || 'domain.local'` | Domain rendered into the fallback template |
26-
| `zone_ip` | String | `'127.0.0.1'` | IP rendered into the fallback template |
27-
| `data_template_source` | String | `'tinydns-internal-data.erb'` | Template used when no explicit records resolve |
28-
| `use_data_bag` | Boolean | `true` | Attempt legacy data-bag loading when `records` is empty |
29-
| `data_bag_name` | String | `'djbdns'` | Data bag name for legacy record loading |
30-
| `data_bag_item_id` | String, nil | `zone_domain.tr('.', '_')` | Data bag item id for legacy record loading |
31-
| `records` | Hash | `{}` | Explicit record map keyed by djbdns record type |
32-
| `dnscache_uid` | Integer | `9997` | UID for the `dnscache` account |
33-
| `dnslog_uid` | Integer | `9998` | UID for the `dnslog` account |
34-
| `tinydns_uid` | Integer | `9999` | UID for the `tinydns` account |
13+
| Property | Type | Default | Description |
14+
| ---------------------- | -------------- | ---------------------------------------------- | -------------------------------------------------------- |
15+
| `service_name` | String | name property | Service name, typically `tinydns-internal` |
16+
| `manage_install` | Boolean | `true` | Also run `djbdns_install` before configuring the service |
17+
| `install_method` | String | platform-dependent | Install via `package` or `source` |
18+
| `package_name` | String | `'djbdns'` | Package name for package installs |
19+
| `source_url` | String | `'https://cr.yp.to/djbdns/djbdns-1.05.tar.gz'` | Upstream source tarball |
20+
| `bin_dir` | String | derived from `install_method` | Location of djbdns binaries used by runit |
21+
| `service_dir` | String | `'/etc/djbdns/tinydns-internal'` | Service root directory |
22+
| `sv_dir` | String | `'/etc/sv'` | runit service directory |
23+
| `service_link_dir` | String | `'/etc/service'` | runit enabled-service directory |
24+
| `listen_ip` | String | `'127.0.0.1'` | Address passed to `tinydns-conf` |
25+
| `zone_domain` | String | `node['domain'] \|\| 'domain.local'` | Domain rendered into the fallback template |
26+
| `zone_ip` | String | `'127.0.0.1'` | IP rendered into the fallback template |
27+
| `data_template_source` | String | `'tinydns-internal-data.erb'` | Template used when no explicit records resolve |
28+
| `use_data_bag` | Boolean | `true` | Attempt legacy data-bag loading when `records` is empty |
29+
| `data_bag_name` | String | `'djbdns'` | Data bag name for legacy record loading |
30+
| `data_bag_item_id` | String or nil | `zone_domain.tr('.', '_')` | Data bag item id for legacy record loading |
31+
| `records` | Hash | `{}` | Explicit record map keyed by djbdns record type |
32+
| `dnscache_uid` | Integer | `9997` | UID for the `dnscache` account |
33+
| `dnslog_uid` | Integer | `9998` | UID for the `dnslog` account |
34+
| `tinydns_uid` | Integer | `9999` | UID for the `tinydns` account |
3535

3636
## Examples
3737

‎documentation/djbdns_rr.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ Adds tinydns records by running the generated `add-*` helper scripts in an exist
44

55
## Actions
66

7-
| Action | Description |
8-
|--------|-------------|
7+
| Action | Description |
8+
|--------|-------------------------------------------------------------------------|
99
| `:add` | Adds a tinydns resource record when it does not already exist (default) |
1010

1111
## Properties
1212

13-
| Property | Type | Default | Description |
14-
|----------|------|---------|-------------|
15-
| `fqdn` | String | name property | Fully qualified domain name to manage |
16-
| `ip` | String | required | IP address for the record |
17-
| `type` | String | `'host'` | Record helper to run: `alias`, `alias6`, `childns`, `host`, `host6`, `mx`, or `ns` |
18-
| `cwd` | String | `node['djbdns']['tinydns_internal_dir']/root` | Tinydns root directory containing `data` and `add-*` helpers |
13+
| Property | Type | Default | Description |
14+
|----------|--------|-----------------------------------------------|------------------------------------------------------------------------------------|
15+
| `fqdn` | String | name property | Fully qualified domain name to manage |
16+
| `ip` | String | required | IP address for the record |
17+
| `type` | String | `'host'` | Record helper to run: `alias`, `alias6`, `childns`, `host`, `host6`, `mx`, or `ns` |
18+
| `cwd` | String | `node['djbdns']['tinydns_internal_dir']/root` | Tinydns root directory containing `data` and `add-*` helpers |
1919

2020
## Examples
2121

0 commit comments

Comments
 (0)