README.md
1# OnionShare
2
3[OnionShare](https://onionshare.org) is an open source tool for securely and anonymously sending and receiving files using Tor onion services. It works by starting a web server directly on your computer and making it accessible as an unguessable Tor web address that others can load in [Tor Browser](https://www.torproject.org/) to download files from you, or upload files to you. It doesn't require setting up a separate server, using a third party file-sharing service, or even logging into an account.
4
5Unlike services like email, Google Drive, DropBox, WeTransfer, or nearly any other way people typically send files to each other, when you use OnionShare you don't give any companies access to the files that you're sharing. So long as you share the unguessable web address in a secure way (like pasting it in an encrypted messaging app), _no one_ but you and the person you're sharing with can access the files.
6
7## Documentation
8
9To learn how OnionShare works, what its security properties are, and how to use it, check out the [wiki](https://github.com/micahflee/onionshare/wiki).
10
11## Installing OnionShare
12
13You can download OnionShare for Windows and macOS from the [OnionShare website](https://onionshare.org).
14
15For macOS you can also use [Homebrew](https://brew.sh/):
16
17```
18brew cask install onionshare
19```
20
21For Ubuntu-like Linux distributions, you can use this PPA:
22
23```
24sudo add-apt-repository ppa:micahflee/ppa
25sudo apt install -y onionshare
26```
27
28OnionShare may also be available in your Linux distribution's package manager. Check [this wiki page](https://github.com/micahflee/onionshare/wiki/How-Do-I-Install-Onionshare) for more information.
29
30## Contributing to OnionShare
31
32You can set up your development environment to build OnionShare yourself by following [these instructions](/BUILD.md). You may also subscribe to our mailing list [here](https://lists.riseup.net/www/info/onionshare-dev), and join our public Keybase team [here](https://keybase.io/team/onionshare).
33
34Test status: [](https://circleci.com/gh/micahflee/onionshare)
35
36# Screenshots
37
38
39
40
41
42
43
44
45
46
){kind=link}
