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.1.tar.gz (62.7 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.1-py3-none-any.whl (77.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lfss-0.11.1.tar.gz
  • Upload date:
  • Size: 62.7 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.1.tar.gz
Algorithm Hash digest
SHA256 40b713039fbf057b2b6e6a3824cd21f69fffaa10ea2e568afe894eca9f349374
MD5 1c5c27e43bbe178c043c4b76d4b074b4
BLAKE2b-256 9644208100bcb1ae525780d4805abefe493889cc1869b196568376974612e98e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lfss-0.11.1-py3-none-any.whl
  • Upload date:
  • Size: 77.7 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1de9352140ec63afc08eccb8fadc834df2838d95313bd8e1a15288e2f0f9faab
MD5 79ce0d14077c8c27860168417afc3aaf
BLAKE2b-256 34dfae853c4ef197ef077956e529e7cd09b925822df135c50de3c71129bd526a

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