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.11.5.tar.gz (67.9 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.11.5-py3-none-any.whl (83.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for lfss-0.11.5.tar.gz
Algorithm Hash digest
SHA256 204ca7746118d643eac2290181f4a037c0c05f364f4a3793758f84d70da83a9a
MD5 45071c7d5481d99441736c777b6a9ea6
BLAKE2b-256 a08c0fd6005fee2e92df6b29d2630f058410f043ab2ba5bdfa60398599f51653

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lfss-0.11.5-py3-none-any.whl
  • Upload date:
  • Size: 83.4 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.11.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0b47b75d72a202eaf9cda3d46117e0207b9678524838c7edfaf0127463a6e11e
MD5 b8768fb50097b465ab59ef1b763cc6fe
BLAKE2b-256 dd7505a16f3073327cf26be114aaa4fb30ac16412243b8d5235fb5d7cdf17291

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