Commit ba1e336b authored by Côme Chilliet's avatar Côme Chilliet
Browse files

Merge branch '161-document-the-dns-plugin-1.4' into '1.4'

Resolve "document the dns plugin" in 1.4

See merge request fusiondirectory/user-manual!316
parents 5855142d 3bc240fd
......@@ -32,7 +32,7 @@ SSL paths
^^^^^^^^^
.. image:: images/argonaut-client-ssl-filled.png
:alt: SSL informations related to Argonaut Server
:alt: SSL informations related to Argonaut Client
* Key: key used for https connection
* Certificate: certificate used for https connection
......
.. include:: /globals.rst
ACL
---
.. image:: images/dns-acl.png
:alt: Edition of a DNS ACL object
Acl
^^^
* Base: Object base
* ACL name: Name of this acl
* Address match list: The IP address match list for this acl
Configuration
=============
DNS
^^^
* DNS RDN: Branch in which DNS objects (zones, views, ACLs) will be stored
* Store final dot in domains: Whether to store a final dot at the end of domains
Description
===========
This plugin is used as DNS service management plugin.
It allows declaring DNS zones, ACL and views in FusionDirectory and save them in the LDAP.
If the systems plugin is installed, you can link systems to zones.
You can then use argonaut-ldap2zone to create and update zone files for your DNS server.
\ No newline at end of file
.. include:: /globals.rst
Functionalities
===============
DNS Management
--------------
Clicking the DNS entry from the main menu, you will get to the DNS management page.
On this page you can create and manage three types of objects:
DNS Zones
^^^^^^^^^
A DNS zone with all the records it contains.
.. image:: images/dns-zone.png
:alt: Edition of a DNS Zone object
DNS Views
^^^^^^^^^
.. image:: images/dns-view.png
:alt: Edition of a DNS View object
DNS ACLs
^^^^^^^^
.. image:: images/dns-acl.png
:alt: Edition of a DNS ACL object
Systems DNS tab
---------------
On systems, you will find a DNS tab that allows you to link a zone to this system.
.. image:: images/dns-system-tab.png
:alt: Main section of DNS system tab
If you add zones to this tab, you will be able to add records related to this system in the zone and FusionDirectory will keep them updated if you rename the system or change its IP. If the system matches the SOA field and has a correctly configured Argonaut client and Argonaut DNS settings service, you will also be able to trigger the zone refresh through ldap2zone from this tab. You can also trigger it from DNS management page, using the "Refresh Zone" action.
......@@ -8,3 +8,9 @@ FusionDirectory Plugins DNS
description
installation
configuration
management
zone
acl
view
system-tab
.. include:: /globals.rst
Management
----------
Clicking the DNS entry from the main menu, you will get to the DNS management page.
On this page you can create and manage three types of objects:
* Zones
* ACLs
* Views
.. include:: /globals.rst
Systems DNS tab
---------------
On systems, you will find a DNS tab that allows you to link a zone to this system.
.. image:: images/dns-system-tab.png
:alt: Main section of DNS system tab
If you add zones to this tab, you will be able to add records related to this system in the zone and FusionDirectory will keep them updated if you rename the system or change its IP. If the system matches the SOA field and has a correctly configured Argonaut client and Argonaut DNS settings service, you will also be able to trigger the zone refresh through ldap2zone from this tab. You can also trigger it from DNS management page, using the "Refresh Zone" action.
.. include:: /globals.rst
View
----
.. image:: images/dns-view.png
:alt: Edition of a DNS View object
View
^^^^
* Base: Object base
* View name: Name of this view
* Match clients ACL: Name of the DNS ACL to use for the source IP address of the incoming requests
* Match destinations ACL: Name of the DNS ACL to use for the destination IP address of the incoming requests
* Match recursive only: Match only recursive queries in this view
* DNS zones: DNS zones in this view
.. include:: /globals.rst
Zone
----
A DNS zone with all the records it contains.
.. image:: images/dns-zone.png
:alt: Edition of a DNS Zone object
Zone
^^^^
* Base: Object base
* Zone name: Zone name
* Reverse zones: Reverse zones for this zone in the form xx.xx.in-addr.arpa. or x.x.ip6.arpa.
SOA record
^^^^^^^^^^
* Primary DNS server: Domain name of the name server that was the original or primary source of data for this zone
* Mail address: Domain name which specifies the mailbox of the person responsible for this zone
* Serial number: Version number of the original copy of the zone
* Refresh: Time interval before the zone should be refreshed
* Retry: Time interval that should elapse before a failed refresh should be retried
* Expire: Time value that specifies the upper limit on the time interval that can elapse before the zone is no longer authoritative
* TTL: Minimum TTL field that should be exported with any RR from this zone
Records
^^^^^^^
The DNS records for this zone
Supported record types:
* A
* AAAA
* AFSDB
* CAA
* CERT
* CNAME
* DKIM (TXT)
* DMARC (TXT)
* DS
* KEY
* KX
* LOC
* MX
* NAPTR
* NS
* NSEC
* PTR
* RRSIG
* SIG
* SPF (TXT)
* SRV
* SSHFP
* TXT
The records with (TXT) appended are actually stored as TXT records in the zone, but FusionDirectory still provides a specific interface to help you correctly use them.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment