Skip to main content

End-to-end encrypted document sharing you self-host.

Project description

                    _ _            _
       __   _____| | | __ _ _ __(_)___
       \ \ / / _ \ | |/ _` | '__| / __|
        \ V /  __/ | | (_| | |  | \__ \
         \_/ \___|_|_|\__,_|_|  |_|___/

Files only the people you choose can read.

End-to-end encrypted document sharing you self-host.

pip install vellaris

Source · PyPI · Docs · License


Status

v0.2.0 — feature drop. Alpha; expect rough edges. The on-wire format is still locked, so blobs encrypted with any v0.x release keep decrypting on later versions.

What v0.2 adds on top of the v0.1 baseline:

  • Web Worker for crypto. RSA-4096 keygen and Argon2id-at-prod-params no longer block the main thread on signup or login. The EncryptAnim actually animates instead of stuttering.
  • IndexedDB-backed key store. The wrapped private key now lives in IDB, with one-shot migration from any pre-existing localStorage entry.
  • Streaming uploads. The upload route reads files via File.stream() instead of file.arrayBuffer(), so the SPA no longer trips ArrayBuffer size limits on multi-hundred-megabyte uploads.

Plus the v0.1.3 → v0.1.5 fixes already in: owner-visible "shared with" chips on /doc/:id, manual Cloudflare pageviews on the public auth routes only (no leak past login), and a strict-ish Content-Security- Policy on the SPA.

How it works

Vellaris encrypts files on your device with a fresh AES-256 key, then encrypts that key once for each recipient with their RSA-4096 public key. Your self-hosted server only ever holds ciphertext, encrypted-DEK rows, and a signed audit log — it cannot decrypt anything.

crypto: AES-256-GCM · RSA-4096 OAEP-SHA256 · Argon2id passphrase KDF

Three clients, one trust boundary

Client Install When to reach for it
CLI pip install vellaris Engineers, scripts, CI pipelines
Python SDK pip install vellaris Automations, ETLs, webhook handlers
Web Static SPA, deploy-anywhere Colleagues who don't live in a terminal

Every client speaks the same on-wire protocol; the server publishes its contract at /openapi.json.

Run a server

Docker

Pull the slim image (~120 MB, SQLite + local FS only):

docker pull ghcr.io/subhayu99/vellaris:0.5.0

Or the full image (~350 MB, every DB and cloud storage backend bundled):

docker pull ghcr.io/subhayu99/vellaris:0.5.0-full

For a tailored configuration (e.g. Postgres + S3 only) and a copy-paste docker run command, use the deployment configurator.

License

Apache 2.0. No CLA traps. Read every line on GitHub.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vellaris-0.6.0.tar.gz (93.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vellaris-0.6.0-py3-none-any.whl (75.7 kB view details)

Uploaded Python 3

File details

Details for the file vellaris-0.6.0.tar.gz.

File metadata

  • Download URL: vellaris-0.6.0.tar.gz
  • Upload date:
  • Size: 93.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for vellaris-0.6.0.tar.gz
Algorithm Hash digest
SHA256 74b0207acb192c1b96ed796a0554dacf1b4623e1e9caf329b56e30f027798ee8
MD5 2ccaebe4ba3c1fd9a49c149647766350
BLAKE2b-256 3c0cdb89f470d3ef187f5c06209a117d02d2d3ee0c79f7cf08ad125e226db35a

See more details on using hashes here.

Provenance

The following attestation bundles were made for vellaris-0.6.0.tar.gz:

Publisher: release.yml on subhayu99/vellaris

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vellaris-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: vellaris-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 75.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for vellaris-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7623c2aec893ce6137bba0dba731e487d879f56b8486b3d26c5c2b04ab7a3d37
MD5 08a5a303698067882a19556b29d11202
BLAKE2b-256 b765676e7be6e4caadb549214086348eaed64a2a8015945885ef41a479c1b927

See more details on using hashes here.

Provenance

The following attestation bundles were made for vellaris-0.6.0-py3-none-any.whl:

Publisher: release.yml on subhayu99/vellaris

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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