howto/Getting-started.md
... ...
@@ -25,18 +25,28 @@ To do so, create a pull request at <https://git.dn42.us/dn42/registry>.
25 25
This example assumes that your name is `<FOO>`, part of an organisation called `<FOO-ORG>` (for instance, your hackerspace). Obviously, these should be replaced by the appropriate values in all examples below.
26 26
27 27
We will create several types of objects: **maintainer** objects, which have an associated password and allow you to authenticate so that you can edit your own objects; **person** objects, which describe people or organisations and provide contact information; and finally, all other objects, which are resources (AS number, IP subnet, DNS zone, etc).
28
+All objects are simple text files in the specific subfolders.
28 29
29 30
### Create a maintainer object
30 31
31
-Create a `mntner` object named `<FOO>-MNT`. It will be used to edit all the objects that are under your responsibility.
32
+Create a `mntner` object in `data/mntner/` named `<FOO>-MNT`. It will be used to edit all the objects that are under your responsibility.
32 33
33 34
<!-- - choose a password, and don't forget it. **Note:** even though the field is named `sha512-pw`, you must enter *your password* directly, *not* the sha512 of your password.
34 35
- use `DUMMY-DN42` as `admin-c` and `tech-c`. We will update this later. -->
35 36
- use `<FOO>-MNT` as `mnt-by`, otherwise, you won't be able to edit your maintainer object.
37
+- optionally add a PGP Fingerprint `auth: pgp-fingerprint <pgp-fingerprint>`
38
+
39
+Example: data/mntner/EXAMPLE-MNT
40
+```
41
+mntner: EXAMPLE-MNT
42
+admin-c: EXAMPLE-DN42
43
+tech-c: EXAMPLE-DN42
44
+mnt-by: EXAMPLE-MNT
45
+```
36 46
37 47
### Create person objects
38 48
39
-Create a `person` object for **yourself** (not your organisation/hackerspace/whatever).
49
+Create a `person` object in `data/person/` for **yourself** (not your organisation/hackerspace/whatever).
40 50
41 51
- use something like `<FOO>-DN42` as `nic-hdl`, it should end with `-DN42`.
42 52
- the `person` field is more freeform, you may use your nickname or even real name here.
... ...
@@ -47,6 +57,14 @@ Create a `person` object for **yourself** (not your organisation/hackerspace/wha
47 57
48 58
<!-- You must now edit the maintainer object created earlier, to properly fill in the `admin-c` and `tech-c` fields (set them to `<FOO>-DN42`). -->
49 59
60
+Example: data/mntner/EXAMPLE-DN42
61
+```
62
+person: John Doe
63
+contact: john.doe@example.com
64
+nic-hdl: EXAMPLE-DN42
65
+mnt-by: EXAMPLE-MNT
66
+```
67
+
50 68
If you intend to register resources for an organisation (e.g. your hackerspace), you must also create an `organisation` object for your organisation:
51 69
52 70
- `organisation` is of the form `<ORG-FOO>`.
... ...
@@ -56,6 +74,15 @@ If you intend to register resources for an organisation (e.g. your hackerspace),
56 74
- you may provide a website (`www` field).
57 75
- don't forget to set `mnt-by` to `<FOO>-MNT`, since you're managing this object on behalf of your organisation.
58 76
77
+Example: data/organisation/ORG-EXAMPLE
78
+```
79
+organisation: ORG-EXAMPLE
80
+org-name: Example Organisation
81
+admin-c: EXAMPLE-DN42
82
+tech-c: EXAMPLE-DN42
83
+mnt-by: EXAMPLE-MNT
84
+```
85
+
59 86
### Guidelines for future objects
60 87
61 88
From now on, you should use:
... ...
@@ -68,7 +95,7 @@ This applies to AS numbers, network prefixes, routes, DNS records...
68 95
69 96
### Register an AS number
70 97
71
-To register an AS number, simply create an `aut-num` object. `as-name` should be a name for your AS.
98
+To register an AS number, simply create an `aut-num` object in `data/aut-num/`. `as-name` should be a name for your AS.
72 99
73 100
Your AS number can be chosen arbitrarily in the dn42 ASN space, look at the `as-block` objects. The historic ASN space is around 64600-64855 and 76100-76200. Starting from June 2014, **you must allocate your AS number in the new 4242420000-4242423999 range**.
74 101
... ...
@@ -78,6 +105,15 @@ If you intend to use an ASN outside of the native dn42 ranges, please check that
78 105
79 106
If unsure, ask on the mailing list or IRC.
80 107
108
+Example: data/aut-num/AS4242423999
109
+```
110
+aut-num: AS4242423999
111
+as-name: AS for EXAMPLE Network
112
+admin-c: EXAMPLE-DN42
113
+tech-c: EXAMPLE-DN42
114
+mnt-by: EXAMPLE-MNT
115
+```
116
+
81 117
### Register a network prefix
82 118
83 119
To register an IPv4 network prefix, simply create an `inetnum` object.
... ...
@@ -109,7 +145,7 @@ If you want to register an [IPv6 prefix](/FAQ#frequently-asked-questions_what-ab
109 145
110 146
[Unique Local IPv6 Generator](http://unique-local-ipv6.com/)
111 147
112
-example: inet6num/fd42:4992:6a6d::_48
148
+example: data/inet6num/fd42:4992:6a6d::_48
113 149
```
114 150
cidr: fd42:4992:6a6d::/48
115 151
inet6num: fd42:4992:6a6d:0000:0000:0000:0000:0000 - fd42:4992:6a6d:ffff:ffff:ffff:ffff:ffff
... ...
@@ -124,7 +160,7 @@ nserver: ns2.evenet.dn42
124 160
status: ASSIGNED
125 161
```
126 162
127
-example: inetnum/172.23.75.0_24
163
+example: data/inetnum/172.23.75.0_24
128 164
```
129 165
cidr: 172.23.75.0/24
130 166
inetnum: 172.23.75.0 - 172.23.75.255
... ...
@@ -141,14 +177,14 @@ status: ASSIGNED
141 177
142 178
If you plan to announce your prefixes in dn42, which you probably want in most cases, you will also need to create a `route` object for ipv4 prefixes and a `route6` object for ipv6 prefixes. This information is used for ROA checks (route origin authorization). If you skip this step, your network will probably get filtered by some peers. Many people enforce ROA checks to prevent (accidental) hijacking of other people's prefixes.
143 179
144
-example: route6/fd42:4992:6a6d::_48
180
+example: data/route6/fd42:4992:6a6d::_48
145 181
```
146 182
route6: fd42:4992:6a6d::/48
147 183
origin: AS4242420092
148 184
mnt-by: MIC92-MNT
149 185
```
150 186
151
-example route/172.23.75.0_24:
187
+example data/route/172.23.75.0_24:
152 188
```
153 189
route: 172.23.75.0/24
154 190
origin: AS4242420092