.. _quickstart: 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 :doc:`status`. 1. Install GNUnet ----------------- Install the ``gnunet`` package of your operating system, for example: .. code-block:: console $ 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, :doc:`install from source `. :doc:`installing` 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: .. code-block:: console $ sudo usermod -aG gnunet $USER 2. Start your peer ------------------ .. code-block:: console $ 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. .. code-block:: console $ gnunet-identity -C myzone You now control the top-level domain ``.myzone`` on your machine. 4. Add a record --------------- .. code-block:: console $ 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 ------------- .. code-block:: console $ 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. Next: link to a friend's zone ----------------------------- Zones become useful when they point to each other. Records are private unless you publish them, so first add a *public* record (``-p``) and print your zone's public key: .. code-block:: console $ gnunet-namestore -z myzone -a -p -n blog -t A -V 192.0.2.2 -e 1d $ gnunet-identity -d -q -e myzone 000G0507HZ8M09QWA93N2YX9Y9357777C0HTPK7PA0HTKJS5GCXXPGKBWC Give this key to a friend, and ask for theirs. If your friend Alice gives you her key, add it to your zone under a name of your choice: .. code-block:: console $ gnunet-namestore -z myzone -a -n alice -t EDKEY -V 000G0...ALICEKEY -e 1d Now ``blog.alice.myzone`` resolves to whatever Alice published as ``blog``. Both peers need to be connected to the GNUnet network for this; the first lookup can take a while. Where to go next ---------------- - :doc:`gns/integration`: use GNS names in your browser and other applications. - :doc:`gns/sharing`: get a name under ``.pin.gns.alt`` that every GNUnet user can resolve. - :doc:`gns/concepts`: understand zones, delegation and start zones. - :doc:`users/start`: keep your peer running, and check that it is connected.