diff options
author | Martin Schanzenbach <schanzen@gnunet.org> | 2023-09-08 20:41:06 +0200 |
---|---|---|
committer | Martin Schanzenbach <schanzen@gnunet.org> | 2023-09-08 20:41:06 +0200 |
commit | 7515bdcf30028d6c865d1ad96ac032dd3346dbec (patch) | |
tree | b3860c376593df974e3e05e05bd0a48cfa552a5b | |
parent | 2f13a7a1b64a70b6ddf180cf844f3087ecb221c3 (diff) | |
download | gana-7515bdcf30028d6c865d1ad96ac032dd3346dbec.tar.gz gana-7515bdcf30028d6c865d1ad96ac032dd3346dbec.zip |
add intro
-rw-r--r-- | intro.rst | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/intro.rst b/intro.rst new file mode 100644 index 0000000..3f907fb --- /dev/null +++ b/intro.rst | |||
@@ -0,0 +1,49 @@ | |||
1 | The GNUnet Assigned Numbers Authority (GANA) contains various registries | ||
2 | we maintain, for GNUnet other projects that need names and numbers for | ||
3 | use in network protocols. If you need to open a new registry, please | ||
4 | feel free to contact us at gana@gnunet.org. | ||
5 | |||
6 | The registry sources can be found here: https://git.gnunet.org/gana.git | ||
7 | |||
8 | History | ||
9 | ------- | ||
10 | |||
11 | Barry Leiba wrote on April 4th 2020 that “Neither IANA nor participants | ||
12 | in the IETF will have any necessary expertise to evaluate registration | ||
13 | requests in the sort of registry described, and no one will be well | ||
14 | served by the creation of such a registry at IANA. It would be far | ||
15 | better to have a registration process be described in this document | ||
16 | involving experts from the industry as reviewers and maintenance of the | ||
17 | registrations by an industry organization, rather than by IANA.” | ||
18 | |||
19 | So here we are. As IETF/IANA “lack the necessary expertise to operate a | ||
20 | registry” for names and numbers used in network protocols, the GNUnet | ||
21 | project is happy to step up. | ||
22 | |||
23 | License | ||
24 | ------- | ||
25 | |||
26 | The GANA database is licensed under the GPL. See ``COPYING`` in the Git | ||
27 | repository. | ||
28 | |||
29 | Design | ||
30 | ------ | ||
31 | |||
32 | Each registry must have a unique name and all associated information | ||
33 | lives in a directory under that unique name in the Git repository. | ||
34 | |||
35 | Each registry must include at least the following files: | ||
36 | |||
37 | - ``README[.*]``: document describing the purpose of the registry in | ||
38 | English | ||
39 | - ``POLICY[.*]``: registration policy, explaining required fields and | ||
40 | the procedure for adding, updating and deleting entries | ||
41 | - ``registry.rec``: GNU recutils data file with all of the current | ||
42 | entries in the registry | ||
43 | - ``Makefile``: GNU make makefile with a ``make check`` target to run | ||
44 | the validation logic. Ideally, the registry.rec should be written | ||
45 | such that the ``check`` target is simply invoking | ||
46 | ``recfix --check registry.rec``. Additional targets to convert | ||
47 | ``data.rec`` to various formats may be defined. In particular, see | ||
48 | ``format.sh`` in the root directory of the Git repository (try | ||
49 | ``--help``). | ||