Skip to main content

Register

In order to get started, you need to create several objects in the NX3 registry: https://git.brettb.xyz/nx3/registry.

The registry is a git repository. You create objects by forking the main repository, making your changes, and then submitting a pull request for review.

Editing the git repository requires a Linux/Mac computer due to the characters used in file names. Windows Subsystem for Linux *may* work but is not officially supported.

When filling out objects in the registry, refer to the schema to speed up your review process.

When submitting your pull request, you must squash your changes into a single commit.

The registry includes a couple of scripts in order to help check your request:

  • fmt-my-stuff <FOO>-MNT: Automatically fixes minor formatting errors
  • check-my-stuff <FOO>-MNT: Validates your objects against the registry schema

*Do not use the gitea web interface to edit files, doing so will create a large number of commits and prevents the running of registry scripts.*

Registry Example

This example assumes that your name is <FOO>, and are part of an organization called <ORG-FOO>. *Organization objects are not required if you are registering as an individual*. Please make sure you replace these with appropriate values.

We will create several objects as a part of this example:

  • maintainer objects
  • person objects, which describe people or organizations and can provide contact information
  • and resource objects (AS Number, IP Subnet, DNS Zone, etc.)

Create a Maintainer Object

Create a mntner object in data/mntner/ named <FOO>-MNT. It will be used to edit all objects that are under your responsibility.

  • Use <FOO>-MNT as mnt-by

Example data/mntner/FOO-MNT:

mntner:             FOO-MNT
admin-c:            FOO-NX3
tech-c:             FOO-NX3
mnt-by:             FOO-MNT
source:             NX3

Create Person Objects

Create a person object in data/person/ for yourself (not your organization).

  • Use something like <FOO>-NX3 as your nic-hdl, ensuring it ends with -NX3
  • Ther person field is a little more freeform, you can use your nickname or real name here.
  • Provide an email
  • You can also provide other forms of contact
  • Don't forget to set mnt-by to <FOO>-MNT

Example data/person/FOO-NX3

organisation:       ORG-FOO
org-name:           Foo Organisation
admin-c:            FOO-DN42
tech-c:             FOO-DN42
mnt-by:             FOO-MNT
source:             DN42
Back to top