Quick start

This page takes you from nothing to your own working zone in the GNU Name System (GNS) in five steps. It takes about five minutes and needs no configuration file.

Note

GNUnet is alpha software. GNS is its most mature component, but expect rough edges and do not rely on it for anything critical yet. See What works today.

1. Install GNUnet

Install the gnunet package of your operating system, for example:

$ sudo apt install gnunet       # Debian, Ubuntu, ...
$ guix install gnunet           # GNU Guix
$ brew install gnunet           # macOS with Homebrew

Distribution packages are sometimes outdated, and peers of different major versions (say, 0.28.x and 0.29.x) may be unable to talk to each other. Check that gnunet-arm --version reports the latest release; if it does not, install from source. Installing GNUnet also covers other systems.

Some packages run GNUnet as a system service shared by all users of the machine. If yours created a gnunet group, add yourself to it and log in again:

$ sudo usermod -aG gnunet $USER

2. Start your peer

$ gnunet-arm -s

This starts the GNUnet services in the background and returns immediately. (gnunet-arm -e stops them again.)

3. Create a zone

A zone is the GNS equivalent of a domain, except that nobody rents it to you and nobody can take it away: it is a key pair you generate yourself.

$ gnunet-identity -C myzone

You now control the top-level domain .myzone on your machine.

4. Add a record

$ gnunet-namestore -z myzone -a -n www -t A -V 192.0.2.1 -e 1d

This maps the name www.myzone to the IPv4 address 192.0.2.1, valid for one day.

5. Resolve it

$ gnunet-gns -u www.myzone
>>> Looking for `A' records under `www.myzone'
Resolving... <<< 1 record(s) found:

A: `192.0.2.1'

That’s it: you have a working GNS zone.

Where to go next