Configuring OnionShare

OnionShare Settings

You can access Settings by clicking on the 'cog' icon in the bottom right corner of the OnionShare application.

Some of the settings are described below.

Sharing Options

Stop Sharing After First Download

If this setting is checked (enabled), then the Onion Hidden Service will stop automatically once the user has started downloading your share for the first time.

If you need to share your file with several users or allow the user to download it more than once in one sitting, you should uncheck (disable) this setting.

This setting is enabled by default.

Show Desktop Notifications

If this setting is checked, the sender will receive a desktop notification (e.g pop-up or systray bubble) when a user commences or completes a download.

This can be convenient if you don't wish to watch the OnionShare application's status bar itself and move on to other tasks, but wish to be notified when the user starts the download process.

If you don't wish to receive desktop notifications, you should uncheck this setting.

This setting is enabled by default.

Use Persistent URL (Advanced Usage)

If this setting is checked, then the next share will save the Onion Service URL (.onion domain name, and the /slug that follows). All future shares will re-use this persistent Onion Service URL.

See this page for more information regarding persistent URLs.

Stealth (Advanced)

Create Stealth Onion Services

If you want to use stealth onion services, you should enable this setting. For more information on Stealth Onion Services, please visit this page.

This setting is disabled by default.

Check for Updates

Notify me when updates are available

If this setting is checked, Windows and macOS users will receive notifications when a new version of OnionShare is available. You may also click the 'Check For Updates' button to force a check.

This setting is not shown for Linux users. Instead, Linux users should rely on their package management system (e.g apt) to install updates.

How Should Onionshare Connect to Tor?

Several options exist for obtaining a Tor connection:

• Use Tor that is bundled with OnionShare
• Attempt automatic configuration with Tor Browser
• Connect using (Tor) control port
• Connect using (Tor) socket file

'Use Tor that is bundled with OnionShare' is usually the easiest and most convenient setting, because it requires no further action from the user to set up.

For more information on the other options available, please visit this page.

FAQ

Why Can't I Click the Settings Icon?

You cannot click or modify the settings if you have an active share running.

Stop the share and then you will be able to modify the settings.

Once you have saved the settings, you can start a new share.

Where are the Settings Stored?

The settings are stored in a JSON file on your computer. When you click 'Save' in the settings dialog, the settings are re-written to the JSON file and OnionShare reloads its settings from that file.

If you have changed the Tor connection method, then clicking Save will also reconnect to Tor.

The location of the JSON file varies depending on your Operating System:

Linux

• In ~/.config/onionshare/onionshare.json

Mac OS

• In ~/Library/Application Support/Onionshare/onionshare.json

Windows

• In %APPDATA%\Onionshare\onionshare.json

%APPDATA% is usually located in C:\Users\<your user name>\AppData

NOTE: You should never have to manually edit the json file directly. This information is provided only for advanced or curious users.