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