Finally a simple, modern and open source interface for domain name.
It consists of a HTTP REST API written in Golang (primarily based on https://github.com/miekg/dns) with a nice web interface written in Vue.js.
It runs as a single stateless Linux binary, backed by a database (currently: LevelDB, more to come soon).
In order to build the happyDNS project, you’ll need the following dependencies:
goat least version 1.16
nodejstested with version 14.4.0
yarntested with version 1.22.4
- First, you’ll need to prepare the frontend, by installing the node modules dependencies:
yarn --cwd ui install
- Then, generates assets files used by Go code:
go generate git.happydns.org/happydns/ui go generate git.happydns.org/happydns
- Finaly, build the Go code:
go build -v
This last command will create a binary
happydns you can use standalone.
Install at home
The binary comes with sane default options to start with.
You can simply launch the following command in your terminal:
After some initializations, it should show you:
Admin listening on ./happydns.sock Ready, listening on :8081
Go to http://localhost:8081/ to start using happyDNS.
By default, the LevelDB storage engine is used. You can change the storage engine using the option
The help command
./happydns -help can show you the available engines. By example:
-storage-engine value Select the storage engine between [leveldb mysql] (default leveldb)
LevelDB is a small embedded key-value store (as SQLite it doesn’t require an additional daemon to work).
-leveldb-path string Path to the LevelDB Database (default "happydns.db")
By default, a new directory is created near the binary, called
happydns.db. This directory contains the database used by the program.
You can change it to a more meaningful/persistant path.
The binary will automatically look for some existing configuration files:
./happydns.confin the current directory;
Only the first file found will be used.
It is also possible to specify a custom path by adding it as argument to the command line:
Config file format
Comments line has to begin with #, it is not possible to have comments at the end of a line, by appending # followed by a comment.
Place on each line the name of the config option and the expected value, separated by
=. For example:
It’ll also look for special environment variables, beginning with
You can achieve the same as the previous example, with the following environment variables:
You just have to replace dash by underscore.
If you want to contribute to the frontend, instead of regenerating the frontend assets each time you made a modification (with
go generate), you can use the development tools:
In one terminal, run
happydns with the following arguments:
./happydns -dev http://127.0.0.1:8080
In another terminal, run the node part:
yarn --cwd ui run serve
With this setup, static assets integrated inside the go binary will not be used, instead it’ll forward all requests for static assets to the node server, that do dynamic reload, etc.