Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/destrangis/lbox

Serve files via HTTP for a limited time
https://github.com/destrangis/lbox

file-sharing python3 temporary web-application wsgi-application

Last synced: 6 days ago
JSON representation

Serve files via HTTP for a limited time

Awesome Lists containing this project

README 

        
## Lbox - a litterbox clone-ish



This is a self-hosted server that makes you make available files for a limited amount of time.



### Installation



The best way to install this is via `pipx` which will create a virtual environment and manage the dependencies for you:



    pipx install lbox



That will work when the project is available from [Pypi](https://pypi.org), meanwhile from the .tar.gz file as created by the build command `sdist`:



    pipx install lbox-X.Y.tar.gz



Where, of course, X.Y is the version number.



### Building from repo



You should be working on a virtual environment. On your virtual environment install the `build`package:



    python3 -m pip install build



then simply run build, which will create the source distribution (i.e. the .tar.gz file) and the wheel package:



    python3 -m build



### Using Lbox



Lbox uses a configuration file that contains sections with a name of the form `` followed by either `hours`, `minutes`, `days` or `seconds`, e.g:



    [1 hour]

    dir = /var/www/lbox/1hourfiles

    [3 days]

    dir = /var/www/lbox/3dayfiles



In the example above, any file placed on the directory `/var/www/lbox/1hourfiles` will be deleted when its modification time is more than one hour ago. Similarly for files placed on `/var/www/lbox/3dayfiles`, which will be deleted after three days.



On each section there may be more directory variables listed, the name of the variable is unimportant. Also a variable can have multiple directories, e.g.:



    [1d]

    dir1 = /home/fred/temp

    manydirs =

       /var/www/lbox/1dayfiles

       /tmp/scratch



In this example, the files placed on any of those directories will be deleted when their modification time is one day old. Note that you only need to specify `d`, `m`, `h` and `s` for days, minutes, hours and seconds, respectively. Only the initial matters. Also note that whitespace between the number and the units is optional.



#### The lbox server



The `lbox`command is the web server that _publishes_  the files. It will just provide a list of the files along with its size and the time to expiration. Every file can be downloaded from the url ending in `/file/`, with no additional directory path. No, the server doesn't allow uploading new files, but what's the need for it? Being self hosted, you can always `scp`into the right directories to share.



The lbox server runs by default on port 8080 and needs the same configuration file as the `expirator` utility.



To run `lbox`use the command:



    lbox --config=lbox.conf



It is recommended that a `systemd`is created to run `lbox` continuously. It is also recommended that `lbox`be run on http behind a reverse proxy that handles the SSL certificate and manages security etc.



### License

This project is released under the MIT license.