docs: Update README with version compatibility matrix
- Add version support table to README - Link to VERSION_SUPPORT.md for detailed policies - Add minimum requirements documentation - Update license to GPL-3.0-or-later - Add links to key documentation and contributing info
This commit is contained in:
35
README.md
35
README.md
@@ -3,6 +3,19 @@ bind9
|
|||||||
|
|
||||||
A feature-complete ansible role for installing and configuring bind9. The purpose of this role is to fully template out the entire official bind9 configuration file format.
|
A feature-complete ansible role for installing and configuring bind9. The purpose of this role is to fully template out the entire official bind9 configuration file format.
|
||||||
|
|
||||||
|
## Version Compatibility
|
||||||
|
|
||||||
|
| BIND9 Version | Role Branch | Status | Supported Platforms |
|
||||||
|
|---------------|-------------|--------|---------------------|
|
||||||
|
| 9.18.x (LTS) | `main` | ✅ Supported | Debian 11-13, Ubuntu 20.04-24.04 |
|
||||||
|
| 9.20.x+ | `9.20` | 🚧 Planned | Debian 12-13, Ubuntu 22.04-24.04 |
|
||||||
|
|
||||||
|
For detailed version support policy, branching strategy, and migration guidance, see [docs/VERSION_SUPPORT.md](docs/VERSION_SUPPORT.md).
|
||||||
|
|
||||||
|
**Minimum Requirements:**
|
||||||
|
- Ansible: 2.13+
|
||||||
|
- Python: 3.8+
|
||||||
|
|
||||||
What the role does:
|
What the role does:
|
||||||
- Fully configures named.conf
|
- Fully configures named.conf
|
||||||
- Checks that the config is valid
|
- Checks that the config is valid
|
||||||
@@ -195,10 +208,30 @@ Simple sample config of a recursive BIND server that allows your localnetwork to
|
|||||||
allow-recursion:
|
allow-recursion:
|
||||||
- mylan
|
- mylan
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
- **[Configuration Grammar Reference](CONFIGURATION_GRAMMAR.md)**: Comprehensive guide to all BIND9 configuration options
|
||||||
|
- **[Version Support Policy](docs/VERSION_SUPPORT.md)**: Supported versions, branching strategy, and release management
|
||||||
|
- **[Changelog](CHANGELOG.md)**: Version history and upgrade notes
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Contributions are welcome! Please see [docs/VERSION_SUPPORT.md](docs/VERSION_SUPPORT.md) for:
|
||||||
|
- Branching strategy
|
||||||
|
- Testing requirements
|
||||||
|
- Backporting policies
|
||||||
|
- Release procedures
|
||||||
|
|
||||||
|
## Links
|
||||||
|
|
||||||
|
- **Repository**: https://git.valid.dk/daniel/ansible-bind9-role
|
||||||
|
- **Issues**: https://git.valid.dk/daniel/ansible-bind9-role/issues
|
||||||
|
- **BIND9 Documentation**: https://bind9.readthedocs.io/
|
||||||
|
|
||||||
License
|
License
|
||||||
-------
|
-------
|
||||||
|
|
||||||
BSD
|
GPL-3.0-or-later
|
||||||
|
|
||||||
Author Information
|
Author Information
|
||||||
------------------
|
------------------
|
||||||
|
|||||||
Reference in New Issue
Block a user