From 12240fb74c0c6f2768e1070f849cd265ea3dd181 Mon Sep 17 00:00:00 2001 From: VG Date: Wed, 28 Jan 2015 18:45:29 +0100 Subject: First commit --- readme.rst | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 readme.rst (limited to 'readme.rst') diff --git a/readme.rst b/readme.rst new file mode 100644 index 0000000..8044f57 --- /dev/null +++ b/readme.rst @@ -0,0 +1,40 @@ +Shareit +####### + +Description +=========== + +When you want to share a file by e-mail or on a chat conversation, and the +file is relatively big, the file might be refused or it might just be +impractical. + +Shareit is a simple webpage allowing one to store a file for some time (10 +days by default) and create a url to share. Recipients just have to download +the file from the created url. + +This service supports resume, useful for big files. + +Created urls have the following form: + + http://shareit.exemple.com/download/90580754da3ed1b3e4be38c9b277bc9b + +No real security is implemented, it is a quick and dirty hack. + +Access restriction might be done on the server configuration side. For +example, you might want to restrict people to send files to the server to +prevent abuse of service, or preventing the share of illegal content, but +allowing unauthentified download. + +The `doc` directory contains example of configuration you can use to deploy +the service. The `scripts` directory contains example client scripts to ease +the use of service and pass authentication with a netrc file. + +Installation +============ + +The shareit service might be run in development mode by simply calling it +inside shareit directory: + + cd sharit && ./shareit.py + +The service can be run as a python wsgi service. I tested it under uwsgi. -- cgit v1.2.3