Getting Started
Learn what Alex is and how to set it up
What is Alex?
Alex is a personal library for reading PDFs and EPUBs. Download the desktop app, point it at your books, and start reading. No tracking, no algorithms, no subscriptions. Your books, on your terms.
The fastest way to get started is to download the desktop app for macOS or Linux. Alex can also be deployed as a Docker container or standalone Node.js app for always-on server setups.
Key features
- Automatic library ingestion - Alex watches your configured source, extracts metadata, generates cover images, and adds books automatically.
- Local + S3 storage modes - Run from a filesystem library folder or an S3-compatible bucket.
- In-browser reading - Read PDFs with page navigation, zoom, and text search. Read EPUBs with chapter navigation, adjustable font sizes, and reading themes.
- Progress tracking - Alex remembers where you left off in every book. Pick up reading on any device.
- Collections - Organize books into personal collections like "To Read," "Research," or "Favorites."
- Sharing - Share a collection with anyone via a link. Recipients can browse and read without creating an account.
- Multi-user support - Create accounts for family members or teammates. Each user gets independent progress and collections.
- Desktop app - Run Alex as a native desktop application with optional public access via the relay service.
Quick start
- Install Alex via Homebrew (
brew tap jamesacklin/alex && brew install --cask alex) or deploy via Docker. - Choose your storage mode: point to a local folder or connect an S3-compatible bucket.
- Add books: drop PDF or EPUB files into your library folder (or upload to your bucket).
- Start reading by clicking any book in your library.
Next steps
- Installation guide - Full setup instructions for Docker, Node.js, and desktop.
- Library Management - How ingestion, indexing, and browsing work.
- Reading Books - PDF and EPUB reader capabilities.