yggdrasil-map/README.md

# Yggdrasil map

Forked from the code for http://www.fc00.org (http://h.fc00.org on Hyperboria).

## Sending your view of the network

This code reads a map of known nodes from `y.yakamo.org:3000/current` (reachable over yggdrasil). You may alternatively generate your own view of the network by running [a crawler script](scripts/crawl-dht.py), but this may take some time (figuring out how to run it and use the results is left as an exercise to the user).

## Web server
```bash
git clone https://github.com/Arceliar/yggdrasil-map.git
sudo apt-get install python-flask python-flup python-mysqldb python-pygraphviz python-networkx

cd yggdrasil-map/web
cp web_config.example.cfg web_config.cfg
python web.py
```

You would need to edit web.py to adjust the address/port the server listens on, and may want to edit the web_config.cfg file. Note that most of the options in web_config.cfg are unused after forking from the fc00.org code, so this is mostly just a workaround until we have time to clean up this code.

Run `web/updateGraph.py` periodically to rerender nodes graph. You may want to customize reverse-proxy IP retrieval logic in web.py.
branding 2018-11-17 21:08:51 +00:00			`# Yggdrasil map`
Added a license and a readme 2014-03-30 14:43:14 +00:00
branding 2018-11-17 21:08:51 +00:00			`Forked from the code for http://www.fc00.org (http://h.fc00.org on Hyperboria).`
Added a license and a readme 2014-03-30 14:43:14 +00:00
Update readme 2014-06-04 19:20:36 +00:00			`## Sending your view of the network`
update addresses in README 2015-07-26 20:11:12 +00:00
update some documentation, fix links in map, replace pointless version with coords field 2018-12-13 00:12:54 +00:00			This code reads a map of known nodes from `y.yakamo.org:3000/current` (reachable over yggdrasil). You may alternatively generate your own view of the network by running [a crawler script](scripts/crawl-dht.py), but this may take some time (figuring out how to run it and use the results is left as an exercise to the user).
Added a license and a readme 2014-03-30 14:43:14 +00:00
			`## Web server`
			```bash
branding 2018-11-17 21:08:51 +00:00			`git clone https://github.com/Arceliar/yggdrasil-map.git`
			`sudo apt-get install python-flask python-flup python-mysqldb python-pygraphviz python-networkx`
Added a license and a readme 2014-03-30 14:43:14 +00:00
branding 2018-11-17 21:08:51 +00:00			`cd yggdrasil-map/web`
			`cp web_config.example.cfg web_config.cfg`
update README 2015-07-26 20:16:07 +00:00			`python web.py`
Added a license and a readme 2014-03-30 14:43:14 +00:00			```
update README 2015-07-26 20:16:07 +00:00
branding 2018-11-17 21:08:51 +00:00			`You would need to edit web.py to adjust the address/port the server listens on, and may want to edit the web_config.cfg file. Note that most of the options in web_config.cfg are unused after forking from the fc00.org code, so this is mostly just a workaround until we have time to clean up this code.`

update README 2015-07-26 20:16:07 +00:00			Run `web/updateGraph.py` periodically to rerender nodes graph. You may want to customize reverse-proxy IP retrieval logic in web.py.