f30a084fce
- Set up VitePress documentation site (docs:dev, docs:build, docs:preview) - Added Getting Started, Tools Reference, Contributing, and Commercial License pages - Created self-hosting guides for Docker, Vercel, Netlify, Cloudflare, AWS, Hostinger, Nginx, Apache - Updated README with documentation link, sponsors section, and docs contribution guide - Added EPUB to PDF converter using LibreOffice WASM - Migrated to Phosphor Icons for consistent iconography - Added donation ribbon banner on landing page - Removed 'Like My Work?' section (replaced by ribbon) - Updated licensing.html with delivery model, AGPL notice, invoicing, and no-refund policy - Added Commercial License documentation page - Updated translations table (Chinese added, marked non-English as In Progress) - Added sponsors.yml workflow for auto-generating sponsor avatars
1.7 KiB
1.7 KiB
Getting Started
Welcome to BentoPDF! This guide will help you get up and running quickly.
What is BentoPDF?
BentoPDF is a free, open-source, privacy-first PDF toolkit that runs entirely in your browser. Your files never leave your device—all processing happens locally using WebAssembly (WASM) technology.
Quick Start
Option 1: Use the Hosted Version
Visit bentopdf.com to use BentoPDF instantly—no installation required.
Option 2: Self-Host with Docker
# Pull and run the Docker image
docker run -d -p 3000:80 ghcr.io/bentopdf/bentopdf:latest
# Or use Docker Compose
curl -O https://raw.githubusercontent.com/bentopdf/bentopdf/main/docker-compose.yml
docker compose up -d
Then open http://localhost:3000 in your browser.
Option 3: Build from Source
# Clone the repository
git clone https://github.com/bentopdf/bentopdf.git
cd bentopdf
# Install dependencies
npm install
# Start development server
npm run dev
Features at a Glance
| Category | Tools |
|---|---|
| Convert to PDF | Word, Excel, PowerPoint, Images, Markdown, EPUB, MOBI, and more |
| Convert from PDF | JPG, PNG, Text, Excel, SVG, and more |
| Edit & Annotate | Sign, Highlight, Redact, Fill Forms, Add Stamps |
| Organize | Merge, Split, Rotate, Delete Pages, Reorder |
| Optimize | Compress, Repair, Flatten, OCR |
| Security | Encrypt, Decrypt, Remove Restrictions |
Browser Support
BentoPDF works best on modern browsers:
- ✅ Chrome/Edge 90+
- ✅ Firefox 90+
- ✅ Safari 15+