Practical overview
When it fits
Use Agora when you need an operator-run HTTP download library and want the option to gate downloads with Lightning payments.
Who it is for
- Server operators who want to publish browsable downloads from a local directory.
- Operators who want to charge Lightning payments for selected file downloads.
Documented uses
- Expose a directory of documents or other files as an HTTP listing.
- Set free or paid access for files using directory-level configuration.
- Customize a directory listing with a rendered Markdown index page.
Requirements & limits
Agora is free software under the CC0-1.0 license. The repository documents pre-built binaries for Linux, macOS and Windows, as well as Cargo and Docker options.
- Paid downloads require a connection to an LND node; files are served free by default.
- A paid directory needs a
base-pricein its.agora.yamlconfiguration. - Access settings inherit recursively, while subdirectories can override them.
- For public-domain use, the documentation describes HTTPS certificate requests through Let's Encrypt and ACME.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Configure a directory for free and paid downloads
Serve a local file directory and use directory-level rules to mark downloads free or paid.
Before you start
- An Agora server and a local directory containing the files to serve.
- An LND node connected to Agora to charge for downloads.
Steps
Place a
.agora.yamlfile in the served directory and setpaidtotrueorfalse.For a paid directory, set
base-priceto a price in satoshis; the documented example is1000 sat.Add a
.agora.yamlfile in a subdirectory to override the inherited access setting for that section.
Expected outcome
Agora can serve a mix of free and paid files, with directory settings applying recursively and subdirectories able to override them.
Guide limitations
- Agora must be connected to an LND instance to charge for downloads.
- Setting
paidtotruewithout abase-pricecauses an error.
Build Agora from source
Compile the Agora binary from its checked-out Rust repository.
Before you start
- The Agora repository checked out locally.
- Rust installed, for example through rustup, with Cargo available.
Steps
Open a terminal in the checked-out repository.
Run the command below.
cargo build --releaseFind the resulting binary at
./target/release/agora.
Expected outcome
A release build of the Agora binary is produced in the repository's `target/release` directory.
Guide limitations
- The documented default Cargo build links to system libraries dynamically.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 16 October 2026
- Original website title
- agora-org/agora · Official homepage title · retained in its source language

