ddns-manager 0.1.3

Keep your ddns up to date

Based on hbontempo-br/dynamic-ip-updater-google-domains

ddns-manager

Easily keep your DNS records up to date with your Dynamic IP.

ddns-manager is a small and easy project made with python3 that intents to help you keep your DNS records pointing to your machine when you have a dynamic IP from your ISP.

Originally designed by [Henrique Bontempo][author].

The problem

If you want to access you home network through a VPN, host your own website, host a game server, have remote access to our security cameras or any other task that you have to access your home network from the internet you must have to locate it .

The most direct way is through your public IP , and it's easy if you have a static IP, but they are expensive and for many regions almost exclusive to business. If your ISP won't provide static IP on your location or you don't want to pay for it than you are stuck with a dynamic IP. You still can reach your home through your external IP, but there are no guarantees that this address won't change without a notice.

To circumvent this problem the most common idea is to use a url address that is constantly updated your external IP.

Objective

This project have a direct purpose: a simple and easy way of managing your DDNS.

Getting Started

Clone

Cloning this project requires git, instructions provided below.

Option 1: HTTPS

Check clone with https for further information.

    $ git clone https://github.com/hbontempo-br/ddns-manager.git

Option 2: SSH

Check clone with ssh for further information.

    $ git clone [e-mail]:hbontempo-br/ddns-manager.git

Run script

Install dependencies (setting up a virtual environment is recommended):

With pip:

    $ pip3 install requirements.txt

Then just run:

    $ python3 -m ddns_manager

Test

No secret here:

    $ python3 -m unittest discover

Running on Docker

You can run the update loop inside a docker container. The image can be found in Docker-hub.

Build

    $ docker build -t ddns-manager -f Dockerfile .

Run

Just mount the configuration file in the /config/config.yml :

    $ docker run \
        -v PATH_CONFIG:/config/config.yml
        -d hbontempo/ddns-manager

It's a good practice to run your this container with a --restart=always as showed above so your container starts running again even if a problem happens.

Contributing

Did you found a problem? Think that something could be improved? Just open an Issue

License

This project is licensed under the MIT license. Check the license file for further information.