onionshare/README.md

39 lines
1.9 KiB
Markdown
Raw Normal View History

2014-05-20 15:43:32 -04:00
# OnionShare
2014-05-20 14:22:16 -04:00
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).
For Ubuntu-like distributions, you could use this PPA to get the latest version:
```
sudo add-apt-repository ppa:micahflee/ppa
sudo apt install -y onionshare
```
OnionShare also may be available in your operating system's package manager:
2018-01-14 21:45:18 -05:00
[![Packaging status](https://repology.org/badge/vertical-allrepos/onionshare.svg)](https://repology.org/metapackage/onionshare/versions)
2018-01-14 21:45:18 -05:00
## Developing OnionShare
2018-01-31 13:59:46 -05:00
You can set up your development environment to build OnionShare yourself by following [these instructions](/BUILD.md). You may also subscribe to our developers mailing list [here](https://lists.riseup.net/www/info/onionshare-dev).
Test status: [![CircleCI](https://circleci.com/gh/micahflee/onionshare.svg?style=svg)](https://circleci.com/gh/micahflee/onionshare)
# Screenshots
![Share mode OnionShare](/screenshots/onionshare-share-server.png)
![Share mode Tor Browser](/screenshots/onionshare-share-client.png)
![Receive mode OnionShare](/screenshots/onionshare-receive-server.png)
2018-01-14 21:45:18 -05:00
![Receive mode Tor Browser](/screenshots/onionshare-receive-client.png)