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.0.tar.gz (61.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.11.0-py3-none-any.whl (76.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lfss-0.11.0.tar.gz
  • Upload date:
  • Size: 61.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.11.0.tar.gz
Algorithm Hash digest
SHA256 121ae718a13b35607e44695afd6ad089cefb03e9ffebec915c8f674b13145303
MD5 65a8fdbdac75151c6d9b20b30cd6a92b
BLAKE2b-256 285e0f252b0c77e214e6449540c139f15f5eede667dec4d9d7539e6dc9796fb7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lfss-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 76.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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d7b19ce7a39dcfd8cdc1bd5eb9a95ccf6d2c61e6b9578ae9566bb75a160181b2
MD5 dea7987714541920c60d9c49b8c1e6de
BLAKE2b-256 385130b74d38440327ccc6f44cf6d64e61839c10431bd7fcffe91bb287955ff3

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