From b08e95d752806051ecb0354b94a7b63ccd781524 Mon Sep 17 00:00:00 2001 From: Kevin Froman Date: Mon, 3 Feb 2020 21:35:46 -0600 Subject: [PATCH] moving to release with better settings and onboarding, add dev setup docs --- docs/dev/setup.md | 13 +++++++++++++ scripts/disable-dev-config.py | 4 ++-- static-data/default_config.json | 20 ++++++++++---------- tests/runtime-result.txt | 2 +- 4 files changed, 26 insertions(+), 13 deletions(-) create mode 100644 docs/dev/setup.md diff --git a/docs/dev/setup.md b/docs/dev/setup.md new file mode 100644 index 00000000..a60c03d6 --- /dev/null +++ b/docs/dev/setup.md @@ -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. + + diff --git a/scripts/disable-dev-config.py b/scripts/disable-dev-config.py index 2168e9b2..a55566bf 100755 --- a/scripts/disable-dev-config.py +++ b/scripts/disable-dev-config.py @@ -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) diff --git a/static-data/default_config.json b/static-data/default_config.json index 4317f952..c68469a1 100755 --- a/static-data/default_config.json +++ b/static-data/default_config.json @@ -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": { diff --git a/tests/runtime-result.txt b/tests/runtime-result.txt index 412e149b..81b2d82f 100644 --- a/tests/runtime-result.txt +++ b/tests/runtime-result.txt @@ -1 +1 @@ -1580781328 \ No newline at end of file +1580787293 \ No newline at end of file