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
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.12.0.tar.gz (70.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.12.0-py3-none-any.whl (85.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lfss-0.12.0.tar.gz
  • Upload date:
  • Size: 70.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.12.0.tar.gz
Algorithm Hash digest
SHA256 162e1fd1bd0b0462d2bc78b985dce4caa69321591061626225df609217e6c34b
MD5 fc39ad4e49c9ec1935290fdffe89bf03
BLAKE2b-256 1eb698fc7c8877c73a3c9781084008a78c6cef236ba576724d777a23b610edfa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lfss-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 85.6 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.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 76865ef295a2decd98f75e129628e76d9bcdcc7db2d84f9b3f371ee83552c5a0
MD5 913f2f581b01a41f2b42013a8b6ce2f3
BLAKE2b-256 84b36dae6ba2edd67eb017038ee889315a2e222e6a555a3df8752147c94903f4

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