moving to release with better settings and onboarding, add dev setup docs

This commit is contained in:
Kevin Froman 2020-02-03 21:35:46 -06:00
förälder f0ffbb63e7
incheckning b08e95d752
4 ändrade filer med 26 tillägg och 13 borttagningar

13
docs/dev/setup.md Normal file
Visa fil

@ -0,0 +1,13 @@
This page assumes that Onionr is already installed and normal user requirements are setup.
The Onionr development environment is simple. All one really needs is a supported Python version (currently 3.7-3.8 as of writing).
There are additional requirements specified in requirements-dev.txt
Intended to be used from VSCode, there are scripts in scripts/ named enable/disable-dev-config.py.
These make modifications to the default config for the purpose of making testing Onionr nodes easier.
Be sure to disable it again before pushing work.
Generally, one should disable bootstrap list usage when making non trivial changes. This is a config option: general.use_bootstrap_list.

Visa fil

@ -15,8 +15,8 @@ conf['general']['dev_mode'] = False
conf['general']['insert_deniable_blocks'] = True
conf['general']['random_bind_ip'] = True
conf['onboarding']['done'] = False
conf['general']['minimum_block_pow'] = 6
conf['general']['minimum_send_pow'] = 6
conf['general']['minimum_block_pow'] = 5
conf['general']['minimum_send_pow'] = 5
json.dump(conf, open('static-data/default_config.json', 'w'), sort_keys=True, indent=4)

Visa fil

@ -7,16 +7,16 @@
},
"general": {
"announce_node": true,
"dev_mode": true,
"dev_mode": false,
"display_header": false,
"general.random_bind_ip": false,
"hide_created_blocks": true,
"insert_deniable_blocks": false,
"insert_deniable_blocks": true,
"max_block_age": 2678400,
"minimum_block_pow": 4,
"minimum_send_pow": 4,
"minimum_block_pow": 5,
"minimum_send_pow": 5,
"public_key": "",
"random_bind_ip": false,
"random_bind_ip": true,
"security_level": 0,
"show_notifications": true,
"socket_servers": false,
@ -35,7 +35,7 @@
"verbosity": "default"
},
"onboarding": {
"done": true
"done": false
},
"peers": {
"max_connect": 1000,
@ -53,11 +53,11 @@
"tor": {
"bridge_fingerprint": "",
"bridge_ip": "",
"existing_control_password": "testt",
"existing_control_port": 1338,
"existing_socks_port": 1337,
"existing_control_password": "",
"existing_control_port": 0,
"existing_socks_port": 0,
"use_bridge": false,
"use_existing_tor": true,
"use_existing_tor": false,
"v3onions": true
},
"transports": {

Visa fil

@ -1 +1 @@
1580781328
1580787293