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.2.tar.gz (65.0 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.2-py3-none-any.whl (80.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lfss-0.11.2.tar.gz
  • Upload date:
  • Size: 65.0 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.2.tar.gz
Algorithm Hash digest
SHA256 ca496461925f8c1ffdfa222d173bc62852e3828d4bb0075b30b841ae676cbf02
MD5 8f93f5d486cad5e1c8b2f09c304fe22c
BLAKE2b-256 7c66895b815dc4a061f9ce54a2c3337a04847709213796b2a0be6719fd9a41c7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lfss-0.11.2-py3-none-any.whl
  • Upload date:
  • Size: 80.2 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2aad99405d28834fd388cbc118138074435f7b15e6da1389bcfbb6c9c7653654
MD5 4b2ee1cf1352ea7b7eb411149e976af4
BLAKE2b-256 5425b030270b095bcc20ab7642b000576adf0bbed8f50d89a4706882d219d4d0

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