Skip to content

ArchiveLabs/lenny

Repository files navigation

Lenny Logo

Lenny

The open source Library-in-a-Box to preserve and lend digital books.
Learn more »

Issues · Pull Requests · License

Stars Forks Open Issues Pull Requests Last Commit License

📖 Table of Contents


About the Project

Lenny is a free, open source, Library-in-a-Box for libraries to preserve and lend digital books.

  • 📚 Designed for libraries that want control over their digital collections.
  • 🔐 Built with modern authentication, DRM, and flexible storage options.
  • 🌍 Easy to self-host, customize, and scale for any library size.
  • 🚀 Active development and open to contributions!

Features

  • Full Lending Workflow: Borrow, return, and manage digital books.
  • API-first: RESTful endpoints for integration and automation.
  • Containerized: Simple Docker deployment and robust Makefile for scripts.
  • Book Importer: Quickly load hundreds of test books for demos or pilots.
  • Readium Integration: Secure, browser-based reading experience.
  • Flexible Storage: S3, Internet Archive, or local file support.
  • Database-backed: Uses PostgreSQL and SQLAlchemy.

OPDS 2.0 Feed


Technologies

  • Docker for deployment and containerization
  • nginx as a reverse proxy
  • FastAPI (Python) as the web & API framework
  • Minio API for storing digital assets
  • YAML for configuring library-level rules
  • PostgreSQL for the database
  • SQLAlchemy as the Python ORM
  • Readium LCP for DRM
  • Readium Web SDK for a secure web reading experience
  • OPDS for syndicating holdings

Endpoints

  • /v{1}/api
  • /v{1}/manage
  • /v{1}/read
  • /v{1}/opds
  • /v{1}/stats

Getting Started

To install and run Lenny as a production application:

curl -fsSL https://raw.githubusercontent.com/ArchiveLabs/lenny/refs/heads/main/install.sh | sudo sh

Development Setup

git clone https://github.com/ArchiveLabs/lenny.git
cd lenny
make all
  • This will generate a .env file with reasonable defaults (if not present).
  • Navigate to localhost:8080 (or your $LENNY_PORT).
  • Enter the API container with:
    docker exec -it lenny_api bash

Importing Test Books

docker exec -it lenny_api python scripts/load_open_books.py 

Testing Readium Server

BOOK=$(echo -n "s3://bookshelf/32941311.epub" |  base64 | tr '/+' '_-' | tr -d '=')
echo "http://localhost:15080/$BOOK/manifest.json"
curl "http://localhost:15080/$BOOK/manifest.json"

Rebuilding

docker compose -p lenny down
docker compose -p lenny up -d --build

FAQs

Everything is broken and I need to start from scratch
make tunnel rebuild start preload items=10 log
If I disconnect from the internet and tunnel stops working, what do I do?
make untunnel tunnel start
I am getting database connection problems
make resetdb restart preload items=5
I need to stop services (also kills the tunnel)
make stop 

Tests

All automated tests are in the tests/ directory.

To run tests:

pytest
  • Install dependencies:
    pip install -r requirements.txt
  • Test configs via .env.test if needed.

Project Structure

/
├── lenny/                # Core application code
│   └── routes/           # API route definitions and docs
├── scripts/              # Utility scripts (e.g. load_open_books.py)
├── tests/                # Automated tests
├── docker/               # Docker configuration
├── Makefile              # Make commands for setup/maintenance
├── install.sh            # Production install script
├── .env                  # Environment variables (generated)
└── README.md             # Project documentation

Contributing

Contributions are welcome! Please open an issue or pull request if you have suggestions or improvements.


Pilot

We're seeking partnerships with libraries who would like to try lending digital resources to their patrons.


Open Topics

  • Authentication - How does your library perform authentication currently?

Community & Support


📄 License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).


Empowering libraries to share digital knowledge.

About

An open source set of Lending APIs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5