Mercurial > hg > anonet-resdb

annotate doc/structure.txt @ 1260:f5ad11b817f1 draft default tip master

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