Mercurial > hg > anonet-resdb

comparison doc/structure.txt @ 1161:7ee50aaec5e4 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Aded a little documentation for newbies, that explain a litle bit how resdb is structured.
author Query <nobody@space>
date Mon, 10 Mar 2014 12:49:48 +0000
parents
children
comparison
equal deleted inserted replaced
1158:955f269cc2c7 1161:7ee50aaec5e4
1 --- ResDB structure (As written by Sarah.ano 10/March/2014)
2 When I 'joined' anonet I was told to update the resdb.
3 This in itself isnt all that hard to do if someone helps you.
4 But when that isnt the case youre kind of stuck.
5 There isnt a helpful README that says exactly what to do, or even what is necesary.
6 As of writing, there isnt anything on the anonet wiki about it either.
7 Maybe this can be that README?
8
9 -- ResDB in a nutshell
10 ResDB is where people write down what they own.
11 If its not in the ResDB, people wont know its yours.
12 Things like tinydns use the db/dom directory to find relevant DNS servers.
13 Chakra in #anonet uses all information to answer requests. (try @asowner <num>)
14
15 -- A smallish disclaimer
16 Do not blindly run anything you find in ResDB.
17 Someone could have edited, well, anything, to include a rm -rf / (or worse)
18 Everything is written in human readable languages. So just cat the scripts and read them.
19 You might even learn something.
20
21 -- What are all these things?
22 Short explanation on what everything in resdb is.
23 doc/ Where people put documentation. A bit sparse. Also where this file should be.
24 db/ Ill get to that later. Its the important bit.
25 contrib/ Full of a lot of misc things that people found useful enough to include. Most of it is not documented. Run with care.
26 scripts/ Mostly scripts directly related to working with ResDB. Again, run with care.
27
28 The executables are related to running your own git and serving your modified ResDB.
29 ./configure will configure git commit relevant stuff, and also configure gitd.
30 ./gitd will run the git server. Optimally you would use this to serve your modified ResDB to others. Once someone else has it, it will usually spread fast.
31 ./git-commit will commit whatever canges you made. You should always do this when done fucking with resdb. People cant pull uncommited changes.
32
33 Once you want to announce your changes, just go to #anonet and tell people to pull from git://<yourgitdip>/
34 Note that many people set up a proper git server to serve ResDB and other things. The included gitd is a bootstrap and potential hazard. (Since future commits might put bad things in there.)
35
36 -- DB Structure
37 - db/as/
38 Every claimed AS has a directory here. Inside is a single file called 'owner'.
39 That file simply contains the handle of whoever owns that AS.
40 To add yourself, either create these things manually or use a script. (scripts/add_as)
41
42 - db/dom/
43 Inside is a directory for each TLD in use. In each TLD directory are domain names.
44 Each domain name directory contains another 'owner' file, and a ns directory.
45 The ns directory should contain a file named 'a.ns.<domain>.<tld>' or something similar.
46 In that file should be a valid anonet ip to a DNS server. This DNS server will be asked about your domain and is required.
47 There is also a script for this (scripts/add_dom), but take care to give a valid ns as argument too or your domain will be broken.
48
49 - db/ip and db/ip6
50 Nested directories for each byte of an IP. At the end of that chain is, again, an owner file and a cidr file.
51 Doing this manually might cause confusion, headaches and sudden death.
52 Id recommend using a script. (scripts/add_ip)
53
54 - db/usr
55 Kind of freeform. A directory for every handle that cares to add itself.
56 Inside, you can put pretty much whatever information you want.
57 An adress to your git server, contact information. The filenames should be short and descriptive.
58 Just check a few folders yourself and youll get the idea. Maybe find something useful.
59
60 -- So what do?
61 Well, if you are reading this, I assume you are already peered. So you should know your information.
62 So go and add it to the relevant places as explained.
63 If you are still confused (as you should be) head to #anonet and seek help. You should say Hi anyway.
64 Help on other related things (like tinydns) can be found on the wiki or asked for.
65 If something doesnt work, fuck around with it untill it does.