Skip to main content

Lite 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[all]"
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.14.1.tar.gz (81.6 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.14.1-py3-none-any.whl (70.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lfss-0.14.1.tar.gz
  • Upload date:
  • Size: 81.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for lfss-0.14.1.tar.gz
Algorithm Hash digest
SHA256 d8a8fe292de6ed8fc0d1d5323d253c540139ffb75054da2b2b90f26a2175b2bd
MD5 5405a83374745e266352640ec141e5e3
BLAKE2b-256 71d756712e9343a455ca7166f2344c4273847b7db6b80583a82a16d1c12dd692

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lfss-0.14.1-py3-none-any.whl
  • Upload date:
  • Size: 70.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for lfss-0.14.1-py3-none-any.whl
Algorithm Hash digest
SHA256 632eaed4683477a015804aa58e37e8d313665fdd5d06c8811f7270e71360b46a
MD5 a7c65ca4ce809c6e269e561620509e9e
BLAKE2b-256 86513d43d45e2f2dcbb6e98adeb02534465514385365583323af80d9bea3a343

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