summaryrefslogtreecommitdiff
path: root/docs/source/develop.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/develop.rst')
-rw-r--r--docs/source/develop.rst118
1 files changed, 59 insertions, 59 deletions
diff --git a/docs/source/develop.rst b/docs/source/develop.rst
index 5b08c921..042800c4 100644
--- a/docs/source/develop.rst
+++ b/docs/source/develop.rst
@@ -40,7 +40,7 @@ Verbose mode
When developing, it's convenient to run OnionShare from a terminal and add the ``--verbose`` (or ``-v``) flag to the command.
This prints a lot of helpful messages to the terminal, such as when certain objects are initialized, when events occur (like buttons clicked, settings saved or reloaded), and other debug info. For example::
- $ poetry run onionshare-cli -v ~/Documents/roms/nes/Q-bert\ \(USA\).nes
+ $ $ poetry run onionshare-cli -v ~/Documents/roms/nes/Q-bert\ \(USA\).nes
╭───────────────────────────────────────────╮
│ * ▄▄█████▄▄ * │
│ ▄████▀▀▀████▄ * │
@@ -58,62 +58,61 @@ This prints a lot of helpful messages to the terminal, such as when certain obje
│ █ █ █▀▄ █ ▄▀▄ █▀▄ ▀▄ █▀▄ ▄▀▄ █▄▀ ▄█▄ │
│ ▀▄▀ █ █ █ ▀▄▀ █ █ ▄▄▀ █ █ ▀▄█ █ ▀▄▄ │
│ │
- │ v2.3.3 │
+ │ v2.4 │
│ │
│ https://onionshare.org/ │
╰───────────────────────────────────────────╯
-
- [Aug 28 2021 10:32:39] Settings.__init__
- [Aug 28 2021 10:32:39] Settings.load
- [Aug 28 2021 10:32:39] Settings.load: Trying to load /home/user/.config/onionshare/onionshare.json
- [Aug 28 2021 10:32:39] Common.get_resource_path: filename=wordlist.txt
- [Aug 28 2021 10:32:39] Common.get_resource_path: filename=wordlist.txt, path=/home/user/git/onionshare/cli/onionshare_cli/resources/wordlist.txt
- [Aug 28 2021 10:32:39] ModeSettings.load: creating /home/user/.config/onionshare/persistent/dreamy-stiffen-moving.json
- [Aug 28 2021 10:32:39] ModeSettings.set: updating dreamy-stiffen-moving: general.title = None
- [Aug 28 2021 10:32:39] ModeSettings.set: updating dreamy-stiffen-moving: general.public = False
- [Aug 28 2021 10:32:39] ModeSettings.set: updating dreamy-stiffen-moving: general.autostart_timer = 0
- [Aug 28 2021 10:32:39] ModeSettings.set: updating dreamy-stiffen-moving: general.autostop_timer = 0
- [Aug 28 2021 10:32:39] ModeSettings.set: updating dreamy-stiffen-moving: share.autostop_sharing = True
- [Aug 28 2021 10:32:39] Web.__init__: is_gui=False, mode=share
- [Aug 28 2021 10:32:39] Common.get_resource_path: filename=static
- [Aug 28 2021 10:32:39] Common.get_resource_path: filename=static, path=/home/user/git/onionshare/cli/onionshare_cli/resources/static
- [Aug 28 2021 10:32:39] Common.get_resource_path: filename=templates
- [Aug 28 2021 10:32:39] Common.get_resource_path: filename=templates, path=/home/user/git/onionshare/cli/onionshare_cli/resources/templates
- [Aug 28 2021 10:32:39] Web.generate_static_url_path: new static_url_path is /static_3tix3w3s5feuzlhii3zwqb2gpq
- [Aug 28 2021 10:32:39] ShareModeWeb.init
- [Aug 28 2021 10:32:39] Onion.__init__
- [Aug 28 2021 10:32:39] Onion.connect
- [Aug 28 2021 10:32:39] Settings.__init__
- [Aug 28 2021 10:32:39] Settings.load
- [Aug 28 2021 10:32:39] Settings.load: Trying to load /home/user/.config/onionshare/onionshare.json
- [Aug 28 2021 10:32:39] Onion.connect: tor_data_directory_name=/home/user/.config/onionshare/tmp/tmppb7kvf4k
- [Aug 28 2021 10:32:39] Common.get_resource_path: filename=torrc_template
- [Aug 28 2021 10:32:39] Common.get_resource_path: filename=torrc_template, path=/home/user/git/onionshare/cli/onionshare_cli/resources/torrc_template
+
+ [Sep 09 2021 19:13:20] Settings.__init__
+ [Sep 09 2021 19:13:20] Settings.load
+ [Sep 09 2021 19:13:20] Settings.load: Trying to load /home/user/.config/onionshare/onionshare.json
+ [Sep 09 2021 19:13:20] Common.get_resource_path: filename=wordlist.txt
+ [Sep 09 2021 19:13:20] Common.get_resource_path: filename=wordlist.txt, path=/home/user/code/onionshare/cli/onionshare_cli/resources/wordlist.txt
+ [Sep 09 2021 19:13:20] ModeSettings.load: creating /home/user/.config/onionshare/persistent/polish-pushpin-hydrated.json
+ [Sep 09 2021 19:13:20] ModeSettings.set: updating polish-pushpin-hydrated: general.title = None
+ [Sep 09 2021 19:13:20] ModeSettings.set: updating polish-pushpin-hydrated: general.public = False
+ [Sep 09 2021 19:13:20] ModeSettings.set: updating polish-pushpin-hydrated: general.autostart_timer = 0
+ [Sep 09 2021 19:13:20] ModeSettings.set: updating polish-pushpin-hydrated: general.autostop_timer = 0
+ [Sep 09 2021 19:13:20] ModeSettings.set: updating polish-pushpin-hydrated: share.autostop_sharing = True
+ [Sep 09 2021 19:13:20] Web.__init__: is_gui=False, mode=share
+ [Sep 09 2021 19:13:20] Common.get_resource_path: filename=static
+ [Sep 09 2021 19:13:20] Common.get_resource_path: filename=static, path=/home/user/code/onionshare/cli/onionshare_cli/resources/static
+ [Sep 09 2021 19:13:20] Common.get_resource_path: filename=templates
+ [Sep 09 2021 19:13:20] Common.get_resource_path: filename=templates, path=/home/user/code/onionshare/cli/onionshare_cli/resources/templates
+ [Sep 09 2021 19:13:20] Web.generate_static_url_path: new static_url_path is /static_gvvq2hplxhs2cekk665kagei6m
+ [Sep 09 2021 19:13:20] ShareModeWeb.init
+ [Sep 09 2021 19:13:20] Onion.__init__
+ [Sep 09 2021 19:13:20] Onion.connect
+ [Sep 09 2021 19:13:20] Settings.__init__
+ [Sep 09 2021 19:13:20] Settings.load
+ [Sep 09 2021 19:13:20] Settings.load: Trying to load /home/user/.config/onionshare/onionshare.json
+ [Sep 09 2021 19:13:20] Onion.connect: tor_data_directory_name=/home/user/.config/onionshare/tmp/tmpf3akiouy
+ [Sep 09 2021 19:13:20] Common.get_resource_path: filename=torrc_template
+ [Sep 09 2021 19:13:20] Common.get_resource_path: filename=torrc_template, path=/home/user/code/onionshare/cli/onionshare_cli/resources/torrc_template
Connecting to the Tor network: 100% - Done
- [Aug 28 2021 10:32:56] Onion.connect: Connected to tor 0.4.6.7
- [Aug 28 2021 10:32:56] Settings.load
- [Aug 28 2021 10:32:56] Settings.load: Trying to load /home/user/.config/onionshare/onionshare.json
- [Aug 28 2021 10:32:56] OnionShare.__init__
- [Aug 28 2021 10:32:56] OnionShare.start_onion_service
- [Aug 28 2021 10:32:56] Onion.start_onion_service: port=17609
- [Aug 28 2021 10:32:56] Onion.start_onion_service: key_type=NEW, key_content=ED25519-V3
- [Aug 28 2021 10:33:03] ModeSettings.set: updating dreamy-stiffen-moving: general.service_id = sobp4rklarkz34mcog3pqtkb4t5bvyxv3dazvsqmfyhw4imqj446ffqd
- [Aug 28 2021 10:33:03] ModeSettings.set: updating dreamy-stiffen-moving: onion.private_key = sFiznwaPWJdKmFXumdDLkJGdUUdjI/0TWo+l/QEZiE/XoVogjK9INNoz2Tf8vmpe66ssa85En+5w6F2kKyTstA==
- [Aug 28 2021 10:33:03] ModeSettings.set: updating dreamy-stiffen-moving: onion.client_auth_priv_key = YL6YIEMZS6J537Y5ZKEA2Z6IIQEWFK2CMGTWK5G3DGGUREHJSJNQ
- [Aug 28 2021 10:33:03] ModeSettings.set: updating dreamy-stiffen-moving: onion.client_auth_pub_key = 5HUL6RCPQ5VEFDOHCSRAHPFIB74EHVFJO6JJHDP76EDWVRJE2RJQ
+ [Sep 09 2021 19:13:30] Onion.connect: Connected to tor 0.4.6.7
+ [Sep 09 2021 19:13:30] Settings.load
+ [Sep 09 2021 19:13:30] Settings.load: Trying to load /home/user/.config/onionshare/onionshare.json
+ [Sep 09 2021 19:13:30] OnionShare.__init__
+ [Sep 09 2021 19:13:30] OnionShare.start_onion_service
+ [Sep 09 2021 19:13:30] Onion.start_onion_service: port=17616
+ [Sep 09 2021 19:13:30] Onion.start_onion_service: key_type=NEW, key_content=ED25519-V3
+ [Sep 09 2021 19:13:35] ModeSettings.set: updating polish-pushpin-hydrated: general.service_id = vucwsdmjt7szoc6pel3puqoxobiepdsowmqaq7pm7dzhembtzr2capad
+ [Sep 09 2021 19:13:35] ModeSettings.set: updating polish-pushpin-hydrated: onion.private_key = +HfFALM4MtrNh59ibfMtRwDCIpfpWHIcNh3boahqrHh3TkLAyQvzKTm/y53KoYKSh0VU+m9DZY7DtZuCzkHkqQ==
+ [Sep 09 2021 19:13:35] ModeSettings.set: updating polish-pushpin-hydrated: onion.client_auth_priv_key = G24TSNLIJX7YZM6R7P24AIGRU4N56ZFL7ENZVIDIWUEWY66YS3EQ
+ [Sep 09 2021 19:13:35] ModeSettings.set: updating polish-pushpin-hydrated: onion.client_auth_pub_key = GDY2EPXSS7Q3ELQJFIX2VELTVZ3QEYIGWIZ26CEDQKZJ5Y7VKI3A
Compressing files.
- [Aug 28 2021 10:33:03] ShareModeWeb.init
- [Aug 28 2021 10:33:03] ShareModeWeb.set_file_info_custom
- [Aug 28 2021 10:33:03] ShareModeWeb.build_zipfile_list
- [Aug 28 2021 10:33:03] Web.start: port=17609
- * Running on http://127.0.0.1:17609/ (Press CTRL+C to quit)
-
+ [Sep 09 2021 19:13:35] ShareModeWeb.init
+ [Sep 09 2021 19:13:35] ShareModeWeb.set_file_info_custom
+ [Sep 09 2021 19:13:35] ShareModeWeb.build_zipfile_list
+ [Sep 09 2021 19:13:35] Web.start: port=17616
+ * Running on http://127.0.0.1:17616/ (Press CTRL+C to quit)
+
Give this address and private key to the recipient:
- http://sobp4rklarkz34mcog3pqtkb4t5bvyxv3dazvsqmfyhw4imqj446ffqd.onion
- Private key: YL6YIEMZS6J537Y5ZKEA2Z6IIQEWFK2CMGTWK5G3DGGUREHJSJNQ
-
- Press Ctrl+C to stop the server
+ http://vucwsdmjt7szoc6pel3puqoxobiepdsowmqaq7pm7dzhembtzr2capad.onion
+ Private key: G24TSNLIJX7YZM6R7P24AIGRU4N56ZFL7ENZVIDIWUEWY66YS3EQ
+ Press Ctrl+C to stop the server
You can add your own debug messages by running the ``Common.log`` method from ``onionshare/common.py``. For example::
@@ -145,24 +144,25 @@ You can do this with the ``--local-only`` flag. For example::
│ █ █ █▀▄ █ ▄▀▄ █▀▄ ▀▄ █▀▄ ▄▀▄ █▄▀ ▄█▄ │
│ ▀▄▀ █ █ █ ▀▄▀ █ █ ▄▄▀ █ █ ▀▄█ █ ▀▄▄ │
│ │
- │ v2.3.3 │
+ │ v2.4 │
│ │
│ https://onionshare.org/ │
╰───────────────────────────────────────────╯
-
- * Running on http://127.0.0.1:17621/ (Press CTRL+C to quit)
-
+
+ * Running on http://127.0.0.1:17641/ (Press CTRL+C to quit)
+
Files sent to you appear in this folder: /home/user/OnionShare
-
+
Warning: Receive mode lets people upload files to your computer. Some files can potentially take control of your computer if you open them. Only open things from people you trust, or if you know what you are doing.
-
+
Give this address and private key to the sender:
- http://127.0.0.1:17621
+ http://127.0.0.1:17641
Private key: E2GOT5LTUTP3OAMRCRXO4GSH6VKJEUOXZQUC336SRKAHTTT5OVSA
-
+
Press Ctrl+C to stop the server
-In this case, you load the URL ``http://127.0.0.1:17621`` in a normal web-browser like Firefox, instead of using the Tor Browser. The Private key is not actually needed in local-only mode, so you can ignore it.
+
+In this case, you load the URL ``http://127.0.0.1:17641`` in a normal web-browser like Firefox, instead of using the Tor Browser. The private key is not actually needed in local-only mode, so you can ignore it.
Contributing Translations
-------------------------