summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2014-05-21 21:54:11 -0400
committerMicah Lee <micah@micahflee.com>2014-05-21 21:54:11 -0400
commit599c1fd08fc3eacf27cfcb6f43b29934357d2123 (patch)
treeb4b5f91155b14a4b94a92cc5eb3194a43e1693d5 /README.md
parentbd1feac404bd1d2cac438a228be867d7af26c9d1 (diff)
downloadonionshare-599c1fd08fc3eacf27cfcb6f43b29934357d2123.tar.gz
onionshare-599c1fd08fc3eacf27cfcb6f43b29934357d2123.zip
updated the screenshot to use an OSX one, and updated readme to reflect #2
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 12 insertions, 15 deletions
diff --git a/README.md b/README.md
index 01e60c9a..eed6541b 100644
--- a/README.md
+++ b/README.md
@@ -1,33 +1,30 @@
# OnionShare
-OnionShare is a program to securely and anonymously share a file of any size with someone. It works by starting a web server, making it accessible as a Tor hidden service, and making it require credentials to access and download the file. It doesn't require setting up a server on the internet somewhere or using a third party filesharing service. You host the file on your own computer and use a Tor hidden service to make it temporarily accessible over the internet. The other user just needs to use Tor Browser to download the file from you.
+OnionShare lets you securely and anonymously share a file of any size with someone. It works by starting a web server, making it accessible as a Tor hidden service, and generating an unguessable URL access and download the file. It doesn't require setting up a server on the internet somewhere or using a third party filesharing service. You host the file on your own computer and use a Tor hidden service to make it temporarily accessible over the internet. The other user just needs to use Tor Browser to download the file from you.
![Screenshot](/screenshot.png)
## Quick Start
-At the moment OnionShare is a command line program. It works in normal desktop GNU/Linux distributions, Tails, and Mac OS X. To get started, either git clone the onionshare repository or [download this zip file](https://github.com/micahflee/onionshare/archive/master.zip) and extract it. Open a terminal and navigate to the onionshare directory.
+At the moment OnionShare is a command line program. It works in normal desktop GNU/Linux distributions, Tails, and Mac OS X (Windows coming soon). To get started, either git clone the onionshare repository or [download this zip file](https://github.com/micahflee/onionshare/archive/master.zip) and extract it. Open a terminal and navigate to the onionshare directory.
OnionShare relies on Tor. You need to either have a system Tor installed (`sudo apt-get install tor`), or you can open Tor Browser so that OnionShare can use the Tor server provided there. Start Tor, and then run `onionshare.py`, passing in the file that you want to share, like this:
- [user@dev onionshare]$ ./onionshare.py ~/secret_files.zip
- Connecting to Tor ControlPort to set up hidden service on port 51439
+ [user@dev onionshare]$ ./onionshare.py ~/Desktop/secrets.pdf
+ Connecting to Tor ControlPort to set up hidden service on port 26828
- Give this information to the person you're sending the file to:
- URL: http://ryrvuliyyqv5qann.onion/
- Username: 0aa7d7266ca05753
- Password: d3e6eabad14ea7ad
+ Give this URL to the person you're sending the file to:
+ http://v645bzpxmdtclpv3.onion/73b44511983c08bf29df40d0b1d00a69
Press Ctrl-C to stop server
- * Running on http://127.0.0.1:51439/
- 127.0.0.1 - - [21/May/2014 15:48:50] "GET / HTTP/1.1" 401 -
- 127.0.0.1 - - [21/May/2014 15:48:59] "GET / HTTP/1.1" 200 -
- 127.0.0.1 - - [21/May/2014 15:49:01] "GET /favicon.ico HTTP/1.1" 404 -
- 127.0.0.1 - - [21/May/2014 15:49:02] "GET /favicon.ico HTTP/1.1" 404 -
- 127.0.0.1 - - [21/May/2014 15:49:03] "GET /download HTTP/1.1" 200 -
+ * Running on http://127.0.0.1:26828/
+ 127.0.0.1 - - [21/May/2014 21:52:42] "GET /73b44511983c08bf29df40d0b1d00a69 HTTP/1.1" 200 -
+ 127.0.0.1 - - [21/May/2014 21:52:43] "GET /favicon.ico HTTP/1.1" 404 -
+ 127.0.0.1 - - [21/May/2014 21:52:44] "GET /favicon.ico HTTP/1.1" 404 -
+ 127.0.0.1 - - [21/May/2014 21:52:46] "GET /73b44511983c08bf29df40d0b1d00a69/download HTTP/1.1" 200 -
-Securely send the URL, username, and password to the person you are sending the file to (like by using Jabber and OTR). When they load the website, they will be connecting directly to your computer to download the file. They'll need the username and password to authenticate. Once you confirm that they have downloaded the file you're sending (ask them if they have the file), press Ctrl-C to shut down the server.
+Securely send the URL to the person you are sending the file to (like by using Jabber and OTR). When they load the website in Tor Browser, they will be connecting directly to your computer to download the file. Once you confirm that they have downloaded the file you're sending (ask them if they have the file), press Ctrl-C to shut down the server.
## Using OnionShare in Tails