Skip to content
This repository has been archived by the owner on Oct 3, 2020. It is now read-only.

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
hjacobs committed Oct 3, 2020
1 parent f251ed6 commit 547bce3
Showing 1 changed file with 1 addition and 47 deletions.
48 changes: 1 addition & 47 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,47 +1 @@
===========
Local CNAME
===========

.. image:: https://img.shields.io/pypi/v/local-cname.svg
:target: https://pypi.python.org/pypi/local-cname
:alt: Latest Version

.. image:: https://img.shields.io/pypi/status/local-cname.svg
:target: https://pypi.python.org/pypi/local-cname
:alt: Development Status

.. image:: https://img.shields.io/pypi/pyversions/local-cname.svg
:target: https://pypi.python.org/pypi/local-cname
:alt: Python Versions

.. image:: https://img.shields.io/pypi/l/local-cname.svg
:target: https://github.com/hjacobs/local-cname/blob/master/LICENSE
:alt: License

This is a little helper script to emulate a local CNAME DNS by writing to ``/etc/hosts``.
DNS changes (e.g. to rollout new services) can be tested by overwriting DNS names in the local ``/etc/hosts`` file.
The hosts file only supports IP addresses thus making it cumbersome to emulate a DNS ``CNAME`` without a local DNS server/proxy.
The ``local-cname`` is a very small script to automatically lookup DNS names and write IP addresses to the hosts file.
It is self-contained and restores your local ``/etc/hosts`` file on exit (press CTRL+C).

Installation:

.. code-block:: bash
$ pip install -U local-cname # might need "sudo" or use "--user"
Usage:

.. code-block:: bash
$ sudo local-cname FROM_DNS_NAME TO_DNS_NAME
# press CTRL+C to cancel and restore your old /etc/hosts
Example:

.. code-block:: bash
$ sudo local-cname google.com duckduckgo.com
$ ping google.com
Moved to https://codeberg.org/hjacobs/local-cname

0 comments on commit 547bce3

Please sign in to comment.