Metadata-Version: 1.1
Name: udns
Version: 0.0.2
Summary: micro dns server
Home-page: https://github.com/prologic/udns/
Author: James Mills
Author-email: James Mills, prologic at shortcircuit dot net dot au
License: MIT
Download-URL: https://github.org/com/udns/releases/
Description: .. _dnslib: https://pypi.python.org/pypi/dnslib
        .. _circuits: http://circuitsframework.org/
        .. _Docker: http://docker.com/
        .. _Python: http://python.org/
        .. _Docker Compose: https://docs.docker.com/compose/
        
        
        udns - a micro (µ) DNS Server
        =============================
        
        .. image:: https://badge.waffle.io/prologic/udns.png?label=ready&title=Ready 
           :target: https://waffle.io/prologic/udns
           :alt: 'Stories in Ready'
        
        .. image:: https://travis-ci.org/prologic/udns.svg
           :target: https://travis-ci.org/prologic/udns
           :alt: Build Status
        
        .. image:: https://coveralls.io/repos/prologic/udns/badge.svg
           :target: https://coveralls.io/r/prologic/udns
           :alt: Coverage
        
        .. image:: https://landscape.io/github/prologic/udns/master/landscape.png
           :target: https://landscape.io/github/prologic/udns/master
           :alt: Quality
        
        udns is an authoritative, caching DNS server for development and small
        deployments written in `Python`_ using the `circuits`_ Application Framework
        and the `dnslib`_ DNS library. udns can be run standalone, via `Docker`_
        or using the `Docker Compose`_ tool. udns is designed to be small,
        lightweight, fast and flexible. udns fully supports forwarding, caching
        as well as honoring TTL(s). udns will also read your ``/etc/hosts`` file
        at startup and use this to populate an internal hosts cache so that entries
        in your local ``/etc/hosts`` file are fully resolvable with tools such as
        ``host``, ``dig`` and resolver client libraries.
        
        
        Installation and Usage
        ----------------------
        
        From Source::
            
            $ git clone https://github.com/prologic/udns
            $ cd udns
            $ python setup.py develop
            $ sudo udnsd --debug  # Server
            $ udnsc --help        # Client
        
        From Source using `Docker`_ and `Docker Compose`_::
            
            $ git clone https://github.com/prologic/udns
            $ cd udns
            $ docker-compose up -d                  # Server
            $ docker-compose run --rm udns udnsc    # Client
        
        Using `Docker`_::
            
            $ docker run -d -p 53:53/udp prologic/udns
        
        From PyPi (*coming soon*)::
            
            $ pip install udns
            $ udnsd     # Server
            $ udnsc     # Client
        
        
        Running as a Daemon::
            
            $ sudo udnsd -d --logfile=$(pwd)/udnsd.log --pidfile=$(pwd)/udnsd.pid
        
        
        Managing Zones and Records
        --------------------------
        
        udns is a full authoritative, caching DNS server and ships with a client to
        help manage zones and records. Here are some quick examples:
        
        Create new Zone::
            
            $ udnsc create abc.com.
        
        Create new Zone from a file::
            
            $ udnsc create abc.com. abc.com
        
        or:::
            
            $ udnsc create abc.com. - < abc.com
        
        List Zones::
            
            $ udnsc list
        
        Show Zone Records::
            
            $ udnsc show abc.com.
        
        Export a Zone:::
            
            $ udnsc export abc.com.
        
        .. note:: This exports the Zone to stdout which you can pipe into an output
                  file for storage using your shell.
                  e.g: ``udnsc export abc.com. > abc.com``
        
        Add Zone Records::
            
            $ udnsc add abc.com. www 127.0.0.1
        
        Delete a Zone Record::
            
            $ udnsc delete abc.com. www
        
        Delete a Zone::
            
            $ udnsc delete abc.com.
        
        .. note:: You __must__ specify zones as fully qualified domain names with a
                  trailing period. e.g: ``abc.com.``
        
        
        Changes
        -------
        
        
        udns 0.0.1 (*2014-08-26*)
        .........................
        
        - Initial Release
        
Keywords: micro dns server udns
Platform: POSIX
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: No Input/Output (Daemon)
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Communications :: Chat :: Internet Relay Chat
