Git-Mirrors/onionshare
1
0
Fork 0
mirror of https://github.com/onionshare/onionshare.git synced 2025-05-02 14:36:15 -04:00
Code Issues Projects Releases Packages Wiki Activity

Finish updating advanced docs

Browse source
This commit is contained in:
Micah Lee 2021-09-09 19:04:04 -07:00
parent 57d499ee69
commit 4456b96a27
1 changed files with 17 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

47
docs/source/advanced.rst
View file

@ -25,7 +25,7 @@ If you save a tab, a copy of that tab's onion service secret key will be stored
Turn Off Private Key Turn Off Private Key
-------------------- --------------------
By default, all OnionShare services are protected with a private key, which Tor calls Client Authentication. By default, all OnionShare services are protected with a private key, which Tor calls "client authentication".
When browsing to an OnionShare service in Tor Browser, Tor Browser will prompt for the private key to be entered. When browsing to an OnionShare service in Tor Browser, Tor Browser will prompt for the private key to be entered.
@ -105,23 +105,19 @@ You can browse the command-line documentation by running ``onionshare --help``::
│ █ █ █▀▄ █ ▄▀▄ █▀▄ ▀▄ █▀▄ ▄▀▄ █▄▀ ▄█▄ │ │ █ █ █▀▄ █ ▄▀▄ █▀▄ ▀▄ █▀▄ ▄▀▄ █▄▀ ▄█▄ │
│ ▀▄▀ █ █ █ ▀▄▀ █ █ ▄▄▀ █ █ ▀▄█ █ ▀▄▄ │ │ ▀▄▀ █ █ █ ▀▄▀ █ █ ▄▄▀ █ █ ▀▄█ █ ▀▄▄ │
│ │ │ │
│ v2.3.3 │ │ v2.4 │
│ │ │ │
│ https://onionshare.org/ │ │ https://onionshare.org/ │
╰───────────────────────────────────────────╯ ╰───────────────────────────────────────────╯
usage: onionshare-cli [-h] [--receive] [--website] [--chat] [--local-only] usage: onionshare-cli [-h] [--receive] [--website] [--chat] [--local-only] [--connect-timeout SECONDS] [--config FILENAME] [--persistent FILENAME] [--title TITLE] [--public]
[--connect-timeout SECONDS] [--config FILENAME] [--auto-start-timer SECONDS] [--auto-stop-timer SECONDS] [--no-autostop-sharing] [--data-dir data_dir] [--webhook-url webhook_url] [--disable-text] [--disable-files]
[--persistent FILENAME] [--title TITLE] [--public] [--disable_csp] [-v]
[--auto-start-timer SECONDS] [--auto-stop-timer SECONDS] [filename ...]
[--no-autostop-sharing] [--data-dir data_dir]
[--webhook-url webhook_url] [--disable-text]
[--disable-files] [--disable_csp] [-v]
[filename [filename ...]]
positional arguments: positional arguments:
filename List of files or folders to share filename List of files or folders to share
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
--receive Receive files --receive Receive files
@ -129,29 +125,20 @@ You can browse the command-line documentation by running ``onionshare --help``::
--chat Start chat server --chat Start chat server
--local-only Don't use Tor (only for development) --local-only Don't use Tor (only for development)
--connect-timeout SECONDS --connect-timeout SECONDS
Give up connecting to Tor after a given amount of Give up connecting to Tor after a given amount of seconds (default: 120)
seconds (default: 120)
--config FILENAME Filename of custom global settings --config FILENAME Filename of custom global settings
--persistent FILENAME Filename of persistent session --persistent FILENAME Filename of persistent session
--title TITLE Set a title --title TITLE Set a title
--public Don't use a private key --public Don't use a private key
--auto-start-timer SECONDS --auto-start-timer SECONDS
Start onion service at scheduled time (N seconds Start onion service at scheduled time (N seconds from now)
from now)
--auto-stop-timer SECONDS --auto-stop-timer SECONDS
Stop onion service at schedule time (N seconds Stop onion service at schedule time (N seconds from now)
from now) --no-autostop-sharing Share files: Continue sharing after files have been sent (default is to stop sharing)
--no-autostop-sharing Share files: Continue sharing after files have --data-dir data_dir Receive files: Save files received to this directory
been sent (default is to stop sharing)
--data-dir data_dir Receive files: Save files received to this
directory
--webhook-url webhook_url --webhook-url webhook_url
Receive files: URL to receive webhook Receive files: URL to receive webhook notifications
notifications
--disable-text Receive files: Disable receiving text messages --disable-text Receive files: Disable receiving text messages
--disable-files Receive files: Disable receiving files --disable-files Receive files: Disable receiving files
--disable_csp Publish website: Disable Content Security Policy --disable_csp Publish website: Disable Content Security Policy header (allows your website to use third-party resources)
header (allows your website to use third-party -v, --verbose Log OnionShare errors to stdout, and web errors to disk
resources)
-v, --verbose Log OnionShare errors to stdout, and web errors to
disk