whatisgithub

What is whitedns-wizard?

iampedii/whitedns-wizard — explained in plain English

Analysis updated 2026-05-18

90GoAudience · ops devopsComplexity · 4/5Setup · hard

In one sentence

A Go command-line wizard that automates setting up a self-hosted VPN server on your own VPS, handling Cloudflare DNS, TLS certificates, and Docker setup for you.

Mindmap

mindmap
  root((WhiteDNS Wizard))
    What it does
      Automates VPN server setup
      Manages Cloudflare DNS and TLS
      Interactive CLI menu
    Tech stack
      Go binary
      Docker and PostgreSQL
      Cloudflare API over SSH
    Use cases
      Provision VPN on own VPS
      Generate client import links
      Diagnose and repair setup
    Audience
      Ops and DevOps users
      Self-hosters
      Privacy focused users

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Set up a self-hosted VPN server on a rented VPS without manually configuring DNS, TLS, and Docker.

USE CASE 2

Generate ready-to-use VPN client connection strings for protocols like VLESS, Hysteria2, and Shadowsocks.

USE CASE 3

Run diagnostics or repair an existing VPN installation when something breaks.

USE CASE 4

Back up and restore a VPN server configuration from the command line.

What is it built with?

GoDockerPostgreSQLCloudflare APISSH

How does it compare?

iampedii/whitedns-wizardbjarneo/klicybertec-postgresql/pg_hardstorage
Stars909288
LanguageGoGoGo
Setup difficultyhardmoderatemoderate
Complexity4/53/54/5
Audienceops devopsops devopsops devops

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · hard Time to first run · 1h+

Requires a VPS, a domain on Cloudflare with a scoped API token, and SSH access, the setup flow provisions Docker containers and certificates end to end.

The README does not state a license, so terms of use are unclear.

So what is it?

WhiteDNS Wizard is a command-line tool written in Go that automates setting up a self-hosted VPN server on a rented cloud computer (VPS). Doing this manually would require juggling DNS configuration, SSL certificates, Docker containers, and a VPN management panel across many separate steps. WhiteDNS packages all of that into a single interactive menu you run on your local machine. The tool connects to Cloudflare (a service that manages your domain name and routes traffic) and to your VPS over SSH. Once you give it your Cloudflare API credentials, your domain name, and the address of your server, it handles the rest: creating the right DNS records, setting up strict TLS encryption, installing a Docker-based stack that includes a VPN panel called 3x-ui and a PostgreSQL database, and then printing ready-to-use connection strings you can paste into a VPN client app. The generated connection profiles cover a range of VPN protocols, including VLESS over WebSocket, Hysteria2, Shadowsocks, and Reality. Some are routed through Cloudflare's proxy network, which hides the server's real IP address. Others are direct. There is also a set of Tor-routed variants that send outbound traffic through the Tor anonymity network on the server side, so the destination website sees a Tor exit node address instead of your server. After the initial setup, the interactive menu gives you ongoing options: run diagnostics to check that everything is working, repair or restart the Docker stack, back up the configuration, restore from a backup, or generate a troubleshooting bundle you can share when asking for help. Secrets like API tokens are stored encrypted on disk so you can repeat any of these operations later without re-entering credentials. The project is aimed at people who want a managed, repeatable VPN setup on their own hardware and domain, with Cloudflare handling DNS and traffic proxying. It does not run a hosted service, everything lives on infrastructure you control.

Copy-paste prompts

Prompt 1
Walk me through the Cloudflare API token permissions required to run WhiteDNS Wizard.
Prompt 2
Explain what DNS records WhiteDNS Wizard creates and why each one exists.
Prompt 3
Help me build the whitedns binary and run the init setup menu on my VPS.
Prompt 4
Describe the difference between the Cloudflare-proxied and direct VPN profiles this tool generates.
Prompt 5
Explain how the Tor-routed profiles in WhiteDNS Wizard work and their UDP limitation.

Frequently asked questions

What is whitedns-wizard?

A Go command-line wizard that automates setting up a self-hosted VPN server on your own VPS, handling Cloudflare DNS, TLS certificates, and Docker setup for you.

What language is whitedns-wizard written in?

Mainly Go. The stack also includes Go, Docker, PostgreSQL.

What license does whitedns-wizard use?

The README does not state a license, so terms of use are unclear.

How hard is whitedns-wizard to set up?

Setup difficulty is rated hard, with roughly 1h+ to a first successful run.

Who is whitedns-wizard for?

Mainly ops devops.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.