mirror of
https://github.com/onionshare/onionshare.git
synced 2024-10-01 01:35:40 -04:00
162 lines
8.4 KiB
ReStructuredText
162 lines
8.4 KiB
ReStructuredText
Advanced Usage
|
|
==============
|
|
|
|
.. _save_tabs:
|
|
|
|
Save Tabs
|
|
---------
|
|
|
|
Everything in OnionShare is temporary by default. If yoy close an OnionShare tab, its address no longer exists and it can't be used again.
|
|
Sometimes you might want an OnionShare service to be persistent.
|
|
This is useful if you want to host a website available from the same URL even if you reboot your computer.
|
|
|
|
To make any tab persistent, check the "Save this tab, and automatically open it when I open OnionShare" box before starting the server.
|
|
When a tab is saved a purple pin icon appears to the left of its server status.
|
|
|
|
.. image:: _static/screenshots/advanced-save-tabs.png
|
|
|
|
When you quit OnionShare and then open it again, your saved tabs will start opened.
|
|
You'll have to manually start each service, but when you do they will start with the same OnionShare address and password.
|
|
|
|
If you save a tab, a copy of that tab's onion service secret key will be stored on your computer with your OnionShare settings.
|
|
|
|
.. _disable_passwords:
|
|
|
|
Disable Passwords
|
|
-----------------
|
|
|
|
By default, all OnionShare services are protected with the username `onionshare` and a randomly-generated password.
|
|
If someone takes 20 wrong guesses at the password, your onion service is automatically stopped to prevent a brute force attack against the OnionShare service.
|
|
|
|
Sometimes you might want your OnionShare service to be accessible to the public, like if you want to set up an OnionShare receive service so the public can securely and anonymously send you files. In this case, it's better to disable the password altogether.
|
|
If you don't do this, someone can force your server to stop just by making 20 wrong guesses of your password, even if they know the correct password.
|
|
|
|
To disable the password for any tab, just check the "Don't use a password" box before starting the server. Then the server will be public and won't have a password.
|
|
|
|
Scheduled Times
|
|
---------------
|
|
|
|
OnionShare supports scheduling exactly when a service should start and stop.
|
|
Before starting server, click "Show advanced settings" in its tab and then check the boxes next to either "Start onion service at scheduled time", "Stop onion service at scheduled time", or both, and set the respective desired dates and times.
|
|
|
|
If you scheduled a service to start in the future, when you click the "Start sharing" button you will see a timer counting down until it starts.
|
|
If you scheduled it to stop in the future, after it's started you will see a timer counting down to when it will stop automatically.
|
|
|
|
**Scheduling an OnionShare service to automatically start can be used as a dead man's switch**, where your service will be made public at a given time in the future if anything happens to you.
|
|
If nothing happens to you, you can cancel the service before it's scheduled to start.
|
|
|
|
.. image:: _static/screenshots/advanced-schedule-start-timer.png
|
|
|
|
**Scheduling an OnionShare service to automatically stop can be useful to limit exposure**, like if you want to share secret documents while making sure they're not available on the Internet for more than a few days.
|
|
|
|
.. image:: _static/screenshots/advanced-schedule-stop-timer.png
|
|
|
|
Command-line Interface
|
|
----------------------
|
|
|
|
In addition to its graphical interface, OnionShare has a command-line interface.
|
|
|
|
Linux
|
|
^^^^^
|
|
|
|
If you installed OnionShare using the Flatpak package, unfortunately the command-line interface isn't supported.
|
|
|
|
If you installed OnionShare using an operating system package, you can just run ``onionshare`` from the terminal.
|
|
|
|
macOS
|
|
^^^^^
|
|
|
|
Make a symbolic link to the OnionShare command-line binary like this::
|
|
|
|
ln -s /Applications/OnionShare.app/Contents/MacOS/onionshare /usr/local/bin
|
|
|
|
Now you can run ``onionshare`` from the terminal.
|
|
|
|
Windows
|
|
^^^^^^^
|
|
|
|
The command-line interface isn't supported in Windows.
|
|
|
|
If you really want to use it anyway, you can set up a Windows development environment (see :ref:`starting_development`) and then run this in a command prompt::
|
|
|
|
poetry run python dev_scripts\onionshare
|
|
|
|
Usage
|
|
^^^^^
|
|
|
|
You can browse the command-line documentation by running ``onionshare --help``::
|
|
|
|
$ onionshare --help
|
|
OnionShare 2.3 | https://onionshare.org/
|
|
|
|
@@@@@@@@@
|
|
@@@@@@@@@@@@@@@@@@@
|
|
@@@@@@@@@@@@@@@@@@@@@@@@@
|
|
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
|
|
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ ___ _
|
|
@@@@@@ @@@@@@@@@@@@@ / _ \ (_)
|
|
@@@@ @ @@@@@@@@@@@ | | | |_ __ _ ___ _ __
|
|
@@@@@@@@ @@@@@@@@@@ | | | | '_ \| |/ _ \| '_ \
|
|
@@@@@@@@@@@@ @@@@@@@@@@ \ \_/ / | | | | (_) | | | |
|
|
@@@@@@@@@@@@@@@@ @@@@@@@@@ \___/|_| |_|_|\___/|_| |_|
|
|
@@@@@@@@@ @@@@@@@@@@@@@@@@ _____ _
|
|
@@@@@@@@@@ @@@@@@@@@@@@ / ___| |
|
|
@@@@@@@@@@ @@@@@@@@ \ `--.| |__ __ _ _ __ ___
|
|
@@@@@@@@@@@ @ @@@@ `--. \ '_ \ / _` | '__/ _ \
|
|
@@@@@@@@@@@@@ @@@@@@ /\__/ / | | | (_| | | | __/
|
|
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ \____/|_| |_|\__,_|_| \___|
|
|
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
|
|
@@@@@@@@@@@@@@@@@@@@@@@@@
|
|
@@@@@@@@@@@@@@@@@@@
|
|
@@@@@@@@@
|
|
|
|
usage: onionshare [-h] [--receive] [--website] [--chat] [--local-only] [--connect-timeout SECONDS] [--config FILENAME] [--persistent FILENAME] [--public]
|
|
[--auto-start-timer SECONDS] [--auto-stop-timer SECONDS] [--legacy] [--client-auth] [--autostop-sharing] [--data-dir data_dir] [--disable_csp] [-v]
|
|
[filename [filename ...]]
|
|
|
|
positional arguments:
|
|
filename List of files or folders to share
|
|
|
|
optional arguments:
|
|
-h, --help Show this help message and exit
|
|
--receive Receive files
|
|
--website Publish website
|
|
--chat Start chat server
|
|
--local-only Don't use Tor (only for development)
|
|
--connect-timeout SECONDS
|
|
Give up connecting to Tor after a given amount of seconds (default: 120)
|
|
--config FILENAME Filename of custom global settings
|
|
--persistent FILENAME Filename of persistent session
|
|
--public Don't use a password
|
|
--auto-start-timer SECONDS
|
|
Start onion service at scheduled time (N seconds from now)
|
|
--auto-stop-timer SECONDS
|
|
Stop onion service at schedule time (N seconds from now)
|
|
--legacy Use legacy address (v2 onion service, not recommended)
|
|
--client-auth Use client authorization (requires --legacy)
|
|
--autostop-sharing Share files: Stop sharing after files have been sent
|
|
--data-dir data_dir Receive files: Save files received to this directory
|
|
--disable_csp Publish website: Disable Content Security Policy header (allows your website to use third-party resources)
|
|
-v, --verbose Log OnionShare errors to stdout, and web errors to disk
|
|
|
|
Legacy Addresses
|
|
----------------
|
|
|
|
OnionShare uses v3 Tor onion services by default.
|
|
These are modern onion addresses that have 56 characters, for example::
|
|
|
|
uf3wmtpbstcupvrrsetrtct7qcmnqvdcsxqzxthxbx2y7tidatxye7id.onion
|
|
|
|
OnionShare still has support for v2 onion addresses, the old type of onion addresses that have 16 characters, for example::
|
|
|
|
lc7j6u55vhrh45eq.onion
|
|
|
|
OnionShare calls v2 onion addresses "legacy addresses", and they are not recommended, as v3 onion addresses are more secure.
|
|
|
|
To use legacy addresses, before starting a server click "Show advanced settings" from its tab and check the "Use a legacy address (v2 onion service, not recommended)" box.
|
|
In legacy mode you can optionally turn on Tor client authentication.
|
|
Once you start a server in legacy mode you cannot remove legacy mode in that tab.
|
|
Instead you must start a separate service in a separate tab.
|
|
|
|
Tor Project plans to `completely deprecate v2 onion services <https://blog.torproject.org/v2-deprecation-timeline>`_ on October 15, 2021, and legacy onion services will soon be removed from OnionShare as well.
|