# Papermark — Open Source Document Sharing Analytics

> Papermark is an open-source DocSend alternative for sharing pitch decks and documents with page-by-page analytics, custom domains, and data rooms.

## Install

Save in your project root:

## Quick Use

```bash
git clone https://github.com/mfts/papermark.git
cd papermark
cp .env.example .env
pnpm install
pnpm dev
```

Open `http://localhost:3000` — upload a document and generate a trackable sharing link.

## Intro

**Papermark** is an open-source alternative to DocSend for sharing documents with built-in analytics. It is designed for founders sharing pitch decks, sales teams sharing proposals, and anyone who needs to know how recipients engage with their documents.

With 8.1K+ GitHub stars, Papermark provides page-by-page view analytics, custom branding, password protection, email capture, and virtual data rooms — all self-hostable with a Next.js stack.

## What Papermark Does

Papermark handles secure document sharing with detailed engagement tracking:

- **Document Sharing**: Upload PDFs, generate unique shareable links for each recipient
- **Page-by-Page Analytics**: Track which pages were viewed, time spent per page, and total viewing duration
- **Email Capture**: Require viewers to enter their email before accessing documents
- **Password Protection**: Add passwords to sensitive documents
- **Custom Domains**: Use your own domain for branded sharing links
- **Custom Branding**: White-label the viewer with your logo and colors
- **Data Rooms**: Create secure virtual data rooms for due diligence with folder organization
- **Expiration & Access Control**: Set link expiration dates and revoke access anytime
- **Notifications**: Real-time email alerts when someone views your document
- **Team Collaboration**: Share documents across team members with role-based access

### Tech Stack

| Component | Technology |
|-----------|-----------|
| Framework | Next.js 14, React, TypeScript |
| Database | PostgreSQL + Prisma |
| Auth | NextAuth.js |
| Storage | AWS S3 / Vercel Blob |
| Analytics | Custom event tracking |
| Deploy | Vercel, Docker |

### Sharing a Document via API

```typescript
// Upload and create a shareable link
const response = await fetch("/api/documents", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    name: "Series A Pitch Deck",
    url: "https://your-storage.com/pitch-deck.pdf",
  }),
});

const doc = await response.json();

// Create a link with settings
const link = await fetch(`/api/documents/${doc.id}/links`, {
  method: "POST",
  body: JSON.stringify({
    emailProtected: true,
    password: null,
    expiresAt: "2026-05-01T00:00:00Z",
    allowDownload: false,
  }),
});
```

### Self-Hosting with Docker

```bash
git clone https://github.com/mfts/papermark.git
cd papermark
cp .env.example .env

# Configure .env:
# DATABASE_URL=postgresql://...
# NEXTAUTH_SECRET=your_secret
# NEXTAUTH_URL=https://your-domain.com
# NEXT_PUBLIC_BASE_URL=https://your-domain.com

docker compose up -d
```

## FAQ

**Q: How is Papermark different from DocSend?**
A: Papermark is open-source and self-hostable, so you own your data. It provides similar analytics (page views, time per page) without monthly fees or per-link pricing.

**Q: Can I track who viewed my pitch deck?**
A: Yes. Enable email capture on links, and Papermark records viewer email, pages viewed, time per page, and total duration with real-time notifications.

**Q: What file formats are supported?**
A: Primarily PDF documents. The viewer renders PDFs page-by-page with smooth navigation.

**Q: Is there a hosted version?**
A: Yes. Papermark offers a hosted version at papermark.io with free and paid tiers, or you can self-host for free.

## Source & Thanks

- GitHub: [mfts/papermark](https://github.com/mfts/papermark) — 8.1K+ ⭐
- Website: [papermark.io](https://papermark.io)
- Docs: [papermark.io/docs](https://papermark.io/docs)

<!-- ZH -->

## 快速使用

```bash
git clone https://github.com/mfts/papermark.git
cd papermark
cp .env.example .env
pnpm install
pnpm dev
```

打开 `http://localhost:3000`，上传文档并生成可追踪的分享链接。

## 简介

**Papermark** 是一个开源的 DocSend 替代方案，用于分享文档并内置分析功能。专为分享 pitch deck 的创始人、发送提案的销售团队设计，帮助你了解接收者如何与文档互动。

拥有 8.1K+ GitHub 星标，Papermark 提供逐页查看分析、自定义品牌、密码保护、邮箱采集和虚拟数据室功能，支持自托管。

## 核心功能

- **文档分享**：上传 PDF，为每个接收者生成唯一的分享链接
- **逐页分析**：追踪查看了哪些页面、每页停留时间和总观看时长
- **邮箱采集**：要求查看者在访问文档前输入邮箱
- **密码保护**：为敏感文档添加密码
- **自定义域名**：使用自己的域名创建品牌化分享链接
- **数据室**：创建安全的虚拟数据室，支持文件夹组织
- **过期与访问控制**：设置链接过期时间，随时撤销访问

## 常见问题

**Q: 与 DocSend 有什么不同？**
A: Papermark 是开源且可自托管的，你拥有自己的数据。提供类似的分析功能，没有月费或按链接收费。

**Q: 可以追踪谁查看了我的 pitch deck 吗？**
A: 可以。启用邮箱采集后，Papermark 会记录查看者邮箱、查看页面、每页时间和总时长，并发送实时通知。

## 来源与致谢

- GitHub: [mfts/papermark](https://github.com/mfts/papermark) — 8.1K+ ⭐
- 官网: [papermark.io](https://papermark.io)

---
Source: https://tokrepo.com/en/workflows/f96288dc-3474-11f1-9bc6-00163e2b0d79
Author: AI Open Source