DnsTube

🌐 Access your computer from anywhere. DnsTube is a Windows dynamic DNS client for Cloudflare-managed domains.

Project maintained by drittich Hosted on GitHub Pages — Theme by mattgraham

DnsTube

Access your computer from anywhere

A Dynamic DNS (DDNS) Windows service for Cloudflare-managed domains.

Table of Contents

What is this?

DnsTube is a Windows service that helps you access your computer remotely even if its IP address changes. It does this by using Cloudflare’s free DNS hosting and API to update the DNS entries for your domain name. This way you can always access your computer using its domain name instead of having to remember its IP address.

Quick Start

  1. Download the latest release.
  2. Install .NET 8 if needed.
  3. Extract the package, open a command prompt as Administrator, and run install-service.bat.
  4. Open http://localhost:5666 to complete setup.

Features

Requirements

UI

Downloading

Head over to the Releases page to download the latest binary.

Installing

Note: This application is built using .NET 8. You may need to download and install it from here: https://dotnet.microsoft.com/en-us/download. Once you’ve installed .NET 8:

You should see the following output:

PS C:\Program Files\DnsTubeService> .\install-service.bat
sc create "DnsTube Service" binPath="C:\Program Files\DnsTubeService\DnsTube.Service.exe" start=auto
[SC] CreateService SUCCESS
[SC] ChangeServiceConfig2 SUCCESS

SERVICE_NAME: DnsTube Service
		TYPE               : 10  WIN32_OWN_PROCESS
		STATE              : 2  START_PENDING
								(NOT_STOPPABLE, NOT_PAUSABLE, IGNORES_SHUTDOWN)
		WIN32_EXIT_CODE    : 0  (0x0)
		SERVICE_EXIT_CODE  : 0  (0x0)
		CHECKPOINT         : 0x0
		WAIT_HINT          : 0x7d0
		PID                : 21408
		FLAGS              :
PS C:\Program Files\DnsTubeService>

Once the service has started you can view the UI at the URL http://localhost:5666/. See the Configuration section for additional config, or if you need to host the UI on a different port.

Configuration

If you haven’t already done so, you will need to create an account with Cloudflare and make it the DNS authority for your domain. You then need to configure your DNS entries as appropriate. See Cloudflare - Manage DNS records for more info.

By default the service hosts the web application on your local machine at port 5666. If you wish to change this, edit appsettings.json accordingly. Once the service is running you can launch the interface at http://localhost:5666/ (or whatever port you have chosen).

After that, you’ll need to generate an API Token (preferred) or Key in order to access the API via DnsTube. The details for doing that can be found at Cloudflare - Create API token. See the Getting a Cloudflare API token section below for a quick walk-through.

Then, go to the DnsTube settings page and enter your email address and API key or token. Return to the main tab (refresh if necessary); you should now see a table listing your Cloudflare DNS entries. Check off the ones you want to dynamically update and the service should take it from there.

You can use nslookup to make sure DNS resolution is working correctly, e.g.,

nslookup mydomain.com

Getting a Cloudflare API token

  1. Log in to your Cloudflare dashboard and navigate to My Profile.
  2. Choose API Tokens and click Create Token.
  3. Start with the Edit Zone DNS template. By default this grants the Zone:DNS:Edit permission.
  4. Change the token name from Edit zone DNS to DnsTube
  5. Click Add More under Permissions and add a permission for Zone:Zone:Read.
  6. Under Zone Resources select which zones you want DnsTube to manage.
  7. If you want the token to be limited to specific zones, add them under Zone Resources.
  8. Click Continue to summary, then Create Token.
  9. Copy the API token for entering within DnsTube, as you will not be able to see it again once you navigate away.

When using a zone‑specific token, add the corresponding Zone IDs (comma-separated) on the DnsTube settings page. Tokens with access to all zones do not require this field.

Updating

Uninstalling

Open a command prompt as Administrator and uninstall the service using uninstall-service.bat. Note, the service will stop more quickly if you close the web UI. You should see the following output:

PS C:\Program Files\DnsTubeService> .\uninstall-service.bat

SERVICE_NAME: DnsTube Service
		TYPE               : 10  WIN32_OWN_PROCESS
		STATE              : 3  STOP_PENDING
								(STOPPABLE, NOT_PAUSABLE, ACCEPTS_SHUTDOWN)
		WIN32_EXIT_CODE    : 0  (0x0)
		SERVICE_EXIT_CODE  : 0  (0x0)
		CHECKPOINT         : 0x0
		WAIT_HINT          : 0x0
[SC] DeleteService SUCCESS
PS C:\Program Files\DnsTubeService>

Notes

  1. DnsTube only updates existing Cloudflare records. It will not create or remove records.
  2. Configuration is stored in a separate folder from the application so when you update, your configuration is preserved. (An exception to this is if you have changed the port the application is hosted on in appsettings.json.)
  3. The location of the configuration file can be found at the bottom ot the Settings page.

Development

The front-end application must be built before starting the .NET application. To do this, open a command prompt and go to [YOUR_INSTALL_FOLDER]\DnsTube.Service\ClientApp. Then run

npm install
npm run build

This will build your files and copy them to the [YOUR_INSTALL_FOLDER]\DnsTube.Service\wwwroot folder.

At this point you can load the solution in Visual Studio 2022 and run the application with Ctrl - F5. You should then be able to load the application UI at the URL http://localhost:5666.

The Name

We all know the internet is a series of tubes. This application uses those very same tubes to update your DNS.

Contributors

DnsTube project contributors

Star History

Star History Chart

License

This project is licensed under the MIT License - see the LICENSE file for details.