feat: Add VitePress docs, EPUB to PDF tool, Phosphor icons, and licensing updates
- 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
This commit is contained in:
96
docs/self-hosting/index.md
Normal file
96
docs/self-hosting/index.md
Normal file
@@ -0,0 +1,96 @@
|
||||
# Self-Hosting Guide
|
||||
|
||||
BentoPDF can be self-hosted on your own infrastructure. This guide covers various deployment options.
|
||||
|
||||
## Quick Start with Docker
|
||||
|
||||
The fastest way to self-host BentoPDF:
|
||||
|
||||
```bash
|
||||
docker run -d -p 3000:80 ghcr.io/bentopdf/bentopdf:latest
|
||||
```
|
||||
|
||||
Or with Docker Compose:
|
||||
|
||||
```yaml
|
||||
# docker-compose.yml
|
||||
version: '3.8'
|
||||
services:
|
||||
bentopdf:
|
||||
image: ghcr.io/bentopdf/bentopdf:latest
|
||||
ports:
|
||||
- "3000:80"
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
## Building from Source
|
||||
|
||||
```bash
|
||||
# Clone and build
|
||||
git clone https://github.com/bentopdf/bentopdf.git
|
||||
cd bentopdf
|
||||
npm install
|
||||
npm run build
|
||||
|
||||
# The built files are in the `dist` folder
|
||||
```
|
||||
|
||||
## Configuration Options
|
||||
|
||||
### Simple Mode
|
||||
|
||||
Simple Mode is designed for internal organizational use where you want to hide all branding and marketing content, showing only the essential PDF tools.
|
||||
|
||||
**What Simple Mode hides:**
|
||||
- Navigation bar
|
||||
- Hero section with marketing content
|
||||
- Features, FAQ, testimonials sections
|
||||
- Footer
|
||||
- Updates page title to "PDF Tools"
|
||||
|
||||
```bash
|
||||
# Build with Simple Mode
|
||||
SIMPLE_MODE=true npm run build
|
||||
|
||||
# Or use the pre-built Docker image
|
||||
docker run -p 3000:8080 bentopdf/bentopdf-simple:latest
|
||||
```
|
||||
|
||||
See [SIMPLE_MODE.md](https://github.com/bentopdf/bentopdf/blob/main/SIMPLE_MODE.md) for full details.
|
||||
|
||||
### Base URL
|
||||
|
||||
Deploy to a subdirectory:
|
||||
|
||||
```bash
|
||||
BASE_URL=/pdf-tools/ npm run build
|
||||
```
|
||||
|
||||
## Deployment Guides
|
||||
|
||||
Choose your platform:
|
||||
|
||||
- [Vercel](/self-hosting/vercel)
|
||||
- [Netlify](/self-hosting/netlify)
|
||||
- [Cloudflare Pages](/self-hosting/cloudflare)
|
||||
- [AWS S3 + CloudFront](/self-hosting/aws)
|
||||
- [Hostinger](/self-hosting/hostinger)
|
||||
- [Nginx](/self-hosting/nginx)
|
||||
- [Apache](/self-hosting/apache)
|
||||
- [Docker](/self-hosting/docker)
|
||||
|
||||
## System Requirements
|
||||
|
||||
| Requirement | Minimum |
|
||||
|-------------|---------|
|
||||
| Storage | ~500 MB (with all WASM modules) |
|
||||
| RAM | 512 MB |
|
||||
| CPU | Any modern processor |
|
||||
|
||||
::: tip
|
||||
BentoPDF is a static site—there's no database or backend server required!
|
||||
:::
|
||||
Reference in New Issue
Block a user