onionshare/README.md

23 lines
1.3 KiB
Markdown
Raw Normal View History

2014-05-20 15:43:32 -04:00
# OnionShare
2014-05-20 14:22:16 -04:00
2014-08-27 14:44:54 -04:00
[![Build Status](https://travis-ci.org/micahflee/onionshare.png)](https://travis-ci.org/micahflee/onionshare)
2018-01-14 21:45:18 -05:00
[OnionShare](https://onionshare.org) lets you securely and anonymously share files of any size. It works by starting a web server, making it accessible as a Tor Onion Service, and generating an unguessable URL to access and download the files. It does _not_ require setting up a separate server or using a third party file-sharing service. You host the files on your own computer and use a Tor Onion Service to make it temporarily accessible over the internet. The receiving user just needs to open the URL in Tor Browser to download the file.
2014-05-20 15:43:32 -04:00
2018-01-14 21:45:18 -05:00
## Documentation
2014-05-20 15:43:32 -04:00
2018-01-14 21:45:18 -05:00
To learn how OnionShare works, what its security properties are, and how to use it, check out the [wiki](https://github.com/micahflee/onionshare/wiki).
## Downloading Onionshare
You can download OnionShare for Windows and macOS from the [OnionShare website](https://onionshare.org). It should be available in your package manager for Linux, and it's included by default in [Tails](https://tails.boum.org).
## Developing OnionShare
You can set up your development environment to build OnionShare yourself by following [these instructions](/BUILD.md).
2018-01-14 21:45:18 -05:00
# Screenshots
![Server Screenshot](/screenshots/server.png)
![Client Screenshot](/screenshots/client.png)