aboutsummaryrefslogtreecommitdiffstats
path: root/readme.rst
blob: 310ca6128f950a012745b05b07c919168d35971c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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:

    https://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.