2025-01-23 08:30:09 -06:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=11" / >
< meta name = "generator" content = "Doxygen 1.12.0" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > DNScode: DNScode< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< script type = "text/javascript" src = "clipboard.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "cookie.js" > < / script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "search/searchdata.js" > < / script >
< script type = "text/javascript" src = "search/search.js" > < / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr id = "projectrow" >
< td id = "projectalign" >
< div id = "projectname" > DNScode< span id = "projectnumber" >   0.1.9< / span >
< / div >
< div id = "projectbrief" > Simplifying DNS configuration< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
< / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
< / script >
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
< / script >
< div id = "main-nav" > < / div >
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function(){initNavTree('md_README.html',''); initResizable(true); });
/* @license-end */
< / script >
< div id = "doc-content" >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< div id = "MSearchResults" >
< div class = "SRPage" >
< div id = "SRIndex" >
< div id = "SRResults" > < / div >
< div class = "SRStatus" id = "Loading" > Loading...< / div >
< div class = "SRStatus" id = "Searching" > Searching...< / div >
< div class = "SRStatus" id = "NoMatches" > No Matches< / div >
< / div >
< / div >
< / div >
< / div >
< div > < div class = "header" >
< div class = "headertitle" > < div class = "title" > DNScode< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< div class = "textblock" > < p > < a class = "anchor" id = "autotoc_md0" > < / a > < / p >
< h1 > < a class = "anchor" id = "autotoc_md1" > < / a >
Simplifying DNS Zone management< / h1 >
< hr / >
< h1 > < a class = "anchor" id = "autotoc_md3" > < / a >
About< / h1 >
< p > DNScode is a project to help simplify DNS zone management, when using plain text files with servers like BIND and NSD. It provides a framework for programmatically generating zone files with Python, allowing for more flexability, compared to other DNS as code solutions.< / p >
< h1 > < a class = "anchor" id = "autotoc_md4" > < / a >
Installation< / h1 >
2025-01-27 10:21:20 -06:00
< div class = "fragment" > < div class = "line" > bash< / div >
< div class = "line" > # Create working directory< / div >
< div class = "line" > mkdir dnsproject< / div >
< div class = "line" > cd dnsproject< / div >
< div class = "line" > < / div >
< div class = "line" > # Create virtual envrionment (optional, but highly recomended)< / div >
< div class = "line" > python3 -m venv .venv< / div >
< div class = "line" > source .venv/bin/activate< / div >
< div class = "line" > < / div >
< div class = "line" > # Install the dnscode package< / div >
< div class = "line" > pip install dnscode< / div >
< / div > <!-- fragment --> < h1 > < a class = "anchor" id = "autotoc_md5" > < / a >
Usage< / h1 >
2025-01-31 09:12:32 -06:00
< div class = "fragment" > < div class = "line" > < span class = "comment" > # dnsproject.py< / span > < / div >
< div class = "line" > < / div >
< div class = "line" > < span class = "keyword" > import< / span > dnscode< / div >
< div class = "line" > < / div >
< div class = "line" > zone = < a class = "code hl_class" href = "classdnscode_1_1dnscode_1_1Zone.html" > dnscode.Zone< / a > (origin=< span class = "stringliteral" > ' example.com' < / span > ) < span class = "comment" > # Create zone object< / span > < / div >
< div class = "ttc" id = "aclassdnscode_1_1dnscode_1_1Zone_html" > < div class = "ttname" > < a href = "classdnscode_1_1dnscode_1_1Zone.html" > dnscode.dnscode.Zone< / a > < / div > < div class = "ttdef" > < b > Definition< / b > dnscode.py:204< / div > < / div >
< / div > <!-- fragment --> < / div > < / div > <!-- contents -->
2025-01-23 08:30:09 -06:00
< / div > <!-- PageDoc -->
< / div > <!-- doc - content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
< li class = "footer" > Generated by < a href = "https://www.doxygen.org/index.html" > < img class = "footer" src = "doxygen.svg" width = "104" height = "31" alt = "doxygen" / > < / a > 1.12.0 < / li >
< / ul >
< / div >
< / body >
< / html >
