Skip to main content

Lightweight file storage service

Project description

Lite File Storage Service (LFSS)

PyPI PyPI - Downloads

My experiment on a lightweight and high-performance file/object storage service...

Highlights:

  • User storage limit and access control.
  • Pagination and sorted file listing for vast number of files.
  • High performance: high concurrency, near-native speed on stress tests.
  • Support range requests, so you can stream large files / resume download.
  • WebDAV compatible (NOTE).

It stores small files and metadata in sqlite, large files in the filesystem.
Tested on 2 million files, and it is still fast.

Usage:

pip install lfss
lfss-user add <username> <password>
lfss-serve

By default, the data will be stored in .storage_data. You can change storage directory using the LFSS_DATA environment variable.

I provide a simple client to interact with the service:

lfss-panel --open

Or, you can start a web server at /frontend and open index.html in your browser.

The API usage is simple, just GET, PUT, DELETE to the /<username>/file/url path.
The authentication can be acheived through one of the following methods:

  1. Authorization header with the value Bearer sha256(<username>:<password>).
  2. token query parameter with the value sha256(<username>:<password>).
  3. HTTP Basic Authentication with the username and password (If WebDAV is enabled).

You can refer to frontend as an application example, lfss/api/connector.py for more APIs.

By default, the service exposes all files to the public for GET requests, but file-listing is restricted to the user's own files.
Please refer to docs/Permission.md for more details on the permission system.

More can be found in the docs directory.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lfss-0.10.0.tar.gz (60.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lfss-0.10.0-py3-none-any.whl (75.1 kB view details)

Uploaded Python 3

File details

Details for the file lfss-0.10.0.tar.gz.

File metadata

  • Download URL: lfss-0.10.0.tar.gz
  • Upload date:
  • Size: 60.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.5

File hashes

Hashes for lfss-0.10.0.tar.gz
Algorithm Hash digest
SHA256 1e60a74e01961525c05b60a7685b55a15243f830d00c1397b2adf84c798c8110
MD5 47b3a68a94ebe6322ff24d85bbc36fb0
BLAKE2b-256 384e8509817dbb721c4b9400c28ce66912bf6df8b88ac74990e8d16c6ae25877

See more details on using hashes here.

File details

Details for the file lfss-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: lfss-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 75.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.5

File hashes

Hashes for lfss-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e8b72f92b22e0a8b5d22775d0784ce5771457ba88217714d7eebb52a5d701198
MD5 f116635b21605fdb5510c11645d0e447
BLAKE2b-256 1a6948c48fc4f9bfaac83e0d71169bb014123e72f2ca45e78fea59631da54ae4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page