happyDomain

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://stackexchange.github.io/dnscontrol/ and https://github.com/miekg/dns) with a nice web interface written with Svelte. It runs as a single stateless Linux binary, backed by a database (currently: LevelDB, more to come soon).

Features:

• An ultra fast web interface without compromise
• Multiple domains management
• Support for 36+ DNS providers (including dynamic DNS, RFC 2136) thanks to DNSControl
• Support for the most recents resource records thanks to CoreDNS's library
• Zone editor with a diff view to review the changes before propagation
• Keep an history of published changes
• Contextual help
• Multiple user with authentication or one user without authtication
• Compatible with external authentication (through JWT tokens: Auth0, ...)

Using Docker

We are a Docker sponsored OSS project! thus you can easily try and/or deploy our app using Docker/podman/kubernetes/...:

docker run -e HAPPYDOMAIN_NO_AUTH=1 -p 8081:8081 happydomain/happydomain

This command will launch happyDomain in a few seconds, for evaluation purpose (no authentication, volatile storage, ...). With your browser, just go to http://localhost:8081 and enjoy!

In order to deploy happyDomain, check the Docker image documentation.

Building

Dependencies

In order to build the happyDomain project, you'll need the following dependencies:

• go at least version 1.18;
• nodejs tested with version 18 and 19.

Instructions

1. First, you'll need to prepare the frontend, by installing the node modules dependencies:

(cd ui; npm install)

If you forget the parenthesis, go back to the project root directory.

2. Then, generates assets files used by Go code:

go generate git.happydomain.org/happydomain/ui
go generate git.happydomain.org/happydomain

3. Finaly, build the Go code:

go build -v

This last command will create a binary happydomain 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:

./happydomain

After some initializations, it should show you:

Admin listening on ./happydomain.sock
Ready, listening on :8081

Go to http://localhost:8081/ to start using happyDomain.

Database configuration

By default, the LevelDB storage engine is used. You can change the storage engine using the option -storage-engine other-engine.

The help command ./happydomain -help can show you the available engines. By example:

-storage-engine value
	Select the storage engine between [leveldb mysql] (default leveldb)

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 "happydomain.db")

By default, a new directory is created near the binary, called happydomain.db. This directory contains the database used by the program. You can change it to a more meaningful/persistant path.

Persistant configuration

The binary will automatically look for some existing configuration files:

• ./happydomain.conf in the current directory;
• $XDG_CONFIG_HOME/happydomain/happydomain.conf;
• /etc/happydomain.conf.

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:

./happydomain /etc/happydomain/config

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:

storage-engine=leveldb
leveldb-path=/var/lib/happydomain/db/

Environment variables

It'll also look for special environment variables, beginning with HAPPYDOMAIN_.

You can achieve the same as the previous example, with the following environment variables:

HAPPYDOMAIN_STORAGE_ENGINE=leveldb
HAPPYDOMAIN_LEVELDB_PATH=/var/lib/happydomain/db/

You just have to replace dash by underscore.

Development environment

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 happydomain with the following arguments:

./happydomain -dev http://127.0.0.1:8080

In another terminal, run the node part:

cd ui; npm run dev

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.