OpenPdf

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 15)

Free open-source PDF toolkit with 30+ tools : merge, split, compress, convert, OCR, encrypt & more. Self-hosted iLovePDF alternative built with Next.js 15 & FastAPI. No signup, no limits, privacy-first.

OpenPdf 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">OpenPdf</h1>

Free, open-source PDF toolkit with 30 professional tools. Self-hosted iLovePDF alternative.

<a href="#features">Features</a> &nbsp;&bull;&nbsp;
 <a href="#demo">Demo</a> &nbsp;&bull;&nbsp;
 <a href="#quick-start">Quick Start</a> &nbsp;&bull;&nbsp;
 <a href="#tech-stack">Tech Stack</a> &nbsp;&bull;&nbsp;
 <a href="#contributing">Contributing</a> &nbsp;&bull;&nbsp;
 <a href="#license">License</a>

---

## Why OpenPdf?

Most online PDF tools are closed-source, riddled with ads, and upload your files to unknown servers. OpenPdf is different:

- **100% Open Source** — MIT licensed. Inspect, modify, and deploy it yourself.
- **Privacy First** — All processing happens on your server. Files are auto-deleted after 15 minutes.
- **No Limits** — No file size caps, no watermarks, no account required.
- **30 Professional Tools** — Everything from merging to OCR in one clean interface.
- **Self-Hosted** — One `docker-compose up` and you're running.

---

## Demo

<details>
<summary>Full Homepage</summary>

 <img src="scripts/screenshots/homepage.png" alt="OpenPdf Homepage" width="100%" />

</details>

---

## Features

### Core Manipulation
| Tool | Description |
|------|-------------|
| **Merge PDF** | Combine multiple PDFs into one with drag-and-drop reordering |
| **Split PDF** | Split by page ranges, every N pages, or extract specific pages |
| **Rotate PDF** | Rotate pages 90/180/270 degrees |
| **Delete Pages** | Remove specific pages from a PDF |
| **Reorder Pages** | Rearrange page order with drag-and-drop |

### Conversion
| Tool | Description |
|------|-------------|
| **PDF to Word** | Convert PDF to editable .docx with formatting preserved |
| **PDF to Excel** | Extract tables from PDF into .xlsx spreadsheets |
| **PDF to PowerPoint** | Convert PDF pages to .pptx slides |
| **PDF to Images** | Export pages as PNG or JPG with configurable DPI |
| **Images to PDF** | Combine multiple images into a single PDF |
| **HTML to PDF** | Convert HTML files to PDF documents |
| **Word to PDF** | Convert .docx documents to PDF |

### Optimization
| Tool | Description |
|------|-------------|
| **Compress PDF** | Reduce file size with low/medium/high quality presets |
| **Linearize PDF** | Optimize for fast web viewing (progressive loading) |
| **Flatten PDF** | Flatten form fields and annotations |

### Security
| Tool | Description |
|------|-------------|
| **Encrypt PDF** | AES-256 password protection with owner/user passwords |
| **Decrypt PDF** | Remove password protection |
| **Redact PDF** | Permanently black out sensitive text by keyword search |
| **Add Watermark** | Text watermarks with custom opacity, position, and rotation |
| **Sign PDF** | Place a signature image on any page |

### Content & Forms
| Tool | Description |
|------|-------------|
| **OCR PDF** | Make scanned PDFs searchable using Tesseract OCR |
| **Add Page Numbers** | Insert page numbers with configurable position and format |
| **Edit Metadata** | View and edit title, author, subject, keywords |
| **Add Bookmarks** | Create table of contents / bookmarks |
| **Repair PDF** | Fix corrupted or damaged PDF files |

### Analysis
| Tool | Description |
|------|-------------|
| **Compare PDFs** | Side-by-side visual diff highlighting differences |
| **Extract Text** | Pull all text with per-page view and copy button |
| **Extract Images** | Extract all embedded images with individual/bulk download |
| **PDF Info** | Detailed file info, metadata, and per-page stats |
| **Count Pages** | Count pages across one or multiple PDFs |

---

## Quick Start

### Docker (Recommended)

```bash
git clone https://github.com/aymenhmaidiwastaken/OpenPdf.git
cd OpenPdf
cp .env.example .env
docker compose up --build -d
docker compose ps
```

Open [http://localhost:3000](http://localhost:3000) in your browser.

Optional health checks:

```bash
curl http://localhost:3000/api/v1/health
curl http://localhost:8000/api/v1/health
```

### Manual Setup

**Prerequisites:** Python 3.11+, Node.js 18+, Redis

**Backend:**
```bash
cd backend
pip install -r requirements.txt
uvicorn main:app --host 0.0.0.0 --port 8000
```

**Frontend:**
```bash
cd frontend
npm install
npm run dev
```

Open [http://localhost:3000](http://localhost:3000). The frontend proxies API requests to the backend at port 8000.

---

## Tech Stack

### Frontend
- **Next.js 15** — App Router, Turbopack, server components
- **Tailwind CSS v4** — Custom neumorphic design system
- **Framer Motion** — Page transitions and component animations
- **PDF.js** — Client-side PDF preview with zoom and navigation
- **TypeScript** — End-to-end type safety

### Backend
- **FastAPI** — Async Python web framework
- **PyMuPDF** — PDF rendering, text extraction, OCR, comparison
- **pypdf** — Merge, split, rotate, page manipulation
- **pikepdf** — Encryption, metadata, linearization, repair
- **Celery + Redis** — Async job queue for heavy operations
- **ReportLab** — Watermarks, page numbers, PDF generation

---

## Architecture

```
Browser (Next.js) ──> Next.js API Routes (BFF Proxy) ──> FastAPI Backend
                                                              │
                                                         Celery Worker
                                                              │
                                                            Redis
```

Docker Compose runtime:

```
Browser -> frontend (Next.js, :3000) -> backend (FastAPI, :8000) -> redis + celery
```

- Next.js API routes proxy to FastAPI — no CORS, backend stays private
- Fast operations run synchronously, heavy ops (OCR, batch) go through Celery
- Temp files stored in `{UPLOAD_DIR}/{job_id}/`, auto-cleaned every 15 minutes
- Tool plugin architecture — add a new tool by creating one Python file

### API Endpoints

```
POST   /api/v1/tools/{tool_name}        Upload files + process
GET    /api/v1/jobs/{job_id}/status      Poll job progress
GET    /api/v1/jobs/{job_id}/download    Download result file
GET    /api/v1/jobs/{job_id}/files       List all output files
GET    /api/v1/jobs/{job_id}/content/*   Get file content inline
DELETE /api/v1/jobs/{job_id}             Clean up job
GET    /api/v1/health                    Health check
```

---

## Project Structure

```
OpenPdf/
├── frontend/
│   └── src/
│       ├── app/                    # Next.js App Router pages
│       │   ├── page.tsx            # Homepage
│       │   └── tools/[tool]/       # Dynamic tool pages
│       ├── components/             # React components
│       │   ├── home/               # Hero, FeatureGrid, FeatureCard
│       │   ├── tools/              # FileUploader, PdfViewer, OptionPanel
│       │   │   └── results/        # Inline result displays
│       │   ├── layout/             # Navbar, Footer, ThemeProvider
│       │   └── shared/             # Button, Modal, Toast
│       ├── hooks/                  # useFileUpload, useJobPolling
│       ├── lib/                    # tools-config, api-client, utils
│       └── types/                  # TypeScript interfaces
├── backend/
│   ├── main.py                     # FastAPI application
│   ├── config.py                   # Settings (pydantic-settings)
│   ├── routers/                    # API route handlers
│   ├── services/                   # Tool registry, file/job management
│   ├── tools/                      # 30 tool implementations
│   │   ├── base.py                 # Abstract base tool class
│   │   ├── merge.py
│   │   ├── compress.py
│   │   └── ...                     # One file per tool
│   └── tasks/                      # Celery app + workers
├── scripts/
│   ├── generate_demo_pdf.py        # Create demo PDF for testing
│   ├── take_screenshots.py         # Automated screenshot capture
│   └── create_gif.py               # Generate demo GIF
├── docker-compose.yml
├── .env.example
└── README.md
```

---

### Docker Files
- `frontend/Dockerfile` builds the production Next.js container.
- `frontend/.dockerignore` excludes local artifacts from image build context.
- `docs/contributions/docker-full-stack-startup-fix.md` documents the Docker startup fix contribution.

## Adding a New Tool

1. Create a new file in `backend/tools/`:

```python
from pathlib import Path
from tools.base import BaseTool

class MyNewTool(BaseTool):
    name = "my-new-tool"
    description = "What this tool does"
    category = "manipulation"  # or conversion, optimization, security, content, analysis
    is_async = False

def execute(self, input_files: list[Path], options: dict, output_dir: Path) -> list[Path]:
        # Your logic here
        output_path = output_dir / "result.pdf"
        # ... process files ...
        return [output_path]
```

2. Add the tool config in `frontend/src/lib/tools-config.ts`
3. That's it — the backend auto-discovers tools, and the frontend uses the dynamic `[tool]` route.

---

## Environment Variables

| Variable | Default | Description |
|----------|---------|-------------|
| `REDIS_URL` | `redis://localhost:6379/0` | Redis connection URL |
| `UPLOAD_DIR` | `/tmp/openpdf` | Temp file storage directory |
| `MAX_FILE_SIZE` | `52428800` (50 MB) | Maximum upload file size in bytes |
| `BACKEND_HOST` | `0.0.0.0` | Backend bind host |
| `BACKEND_PORT` | `8000` | Backend bind port |
| `NEXT_PUBLIC_API_URL` | `http://localhost:8000` | Backend URL for frontend proxy |
| `INTERNAL_API_URL` | `http://backend:8000` | Internal frontend proxy target for Docker networking |

---

## Contributing

Contributions are welcome! Here's how to get started:

1. **Fork** the repository
2. **Create** a feature branch (`git checkout -b feature/amazing-tool`)
3. **Commit** your changes (`git commit -m 'Add amazing tool'`)
4. **Push** to the branch (`git push origin feature/amazing-tool`)
5. **Open** a Pull Request

### Example Contribution: Docker Full-Stack Startup Fix

- Added a production frontend container and wired it into `docker-compose.yml` so Docker now serves port `3000`.
- Fixed frontend API proxy routing using `INTERNAL_API_URL` so `/api/v1/*` resolves to backend correctly in Docker.
- Added `frontend/.dockerignore` to keep local build artifacts out of image context.
- Added a detailed contribution write-up at `docs/contributions/docker-full-stack-startup-fix.md`.

### Ideas for Contributions

- New PDF tools (batch processing, PDF/A conversion, form filling)
- UI/UX improvements
- Performance optimizations
- Internationalization (i18n)
- Test coverage
- Documentation

---

## License

This project is licensed under the **MIT License** — see the [LICENSE](LICENSE) file for details.

You are free to use, modify, and distribute this software for any purpose, including commercial use.

---

If you find OpenPdf useful, please consider giving it a star on GitHub.

OpenPdf

OpenPdf 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

OpenPdf

OpenPdf 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README