# Lumen

Lumen is a self-hosted file upload service written in Rust that accepts uploads from the ShareX screenshot tool. It is open source and self-hosted, installable on Unraid.

Canonical page: https://ourlocalhost.com/app/3002/lumen

## Description

Lumen is a self-hosted file upload service written in Rust that accepts uploads from the ShareX screenshot tool. It provides a lightweight, secure endpoint where only the uploader can decrypt submitted files. It is suitable for people who want a simple self-hosted upload target, though it is still in development and may be unstable.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

22/100 (Low), based on 4 of 4 factors.
- Maintained: 0 (last commit 954 days ago)
- Popular: 19 (8 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Light to run: 70 (1 GB minimum RAM)

## Links

- GitHub: https://github.com/ChecksumDev/lumen
- Documentation: https://github.com/ChecksumDev/lumen#usage-
- Official website: https://lumen.checksum.space
- Unraid: https://ca.unraid.net/apps/lumen-13rmxmh0d8gpj9?q=Lumen

## Common questions

### How do I build and start Lumen from source?

Clone the repository, run `cargo build --release`, rename `.env.example` to `.env`, set `PUBLIC_URL` if needed, and run the release binary.

### How do I connect ShareX to a Lumen instance?

Create a user by POSTing a username and password to `/register`, then save the returned API key. In the ShareX configuration, set `requestUrl` to your domain, set `x-api-key` to your user API key, and replace `API_KEY_HERE` in `deletionUrl`.

### What data caution applies when running Lumen benchmarks?

Running `cargo bench` creates many 1MB files and deletes all uploads by the test user when it finishes.

### How is upload privacy handled?

All uploads are encrypted with AES-256-GCM-SIV, and only the uploader can decrypt the files.

---
Source: Our Local Host (https://ourlocalhost.com/app/3002/lumen), the self-hosted and open-source app directory.
