Files
bentopdf/SIMPLE_MODE.md
abdullahalam123 bc181c8c96 chore: update image sources and version bump to 1.2.0
- Changed image sources for GDPR, CCPA, and HIPAA compliance logos to local paths.
- Updated package version to 1.2.0 in package-lock.json.
- Enhanced README and SIMPLE_MODE documentation with Docker usage instructions.
- Improved table-of-contents worker and related TypeScript definitions for better clarity and functionality.
- Refactored CSS styles for consistency and improved UI elements.
2025-11-08 13:17:29 +05:30

201 lines
4.6 KiB
Markdown

# Simple Mode for BentoPDF
Simple Mode is designed for internal organizational use where you want to hide all branding and marketing content, showing only the essential PDF tools for your users.
## What Simple Mode Does
When enabled, Simple Mode will:
- Hide the navigation bar
- Hide the hero section with marketing content
- Hide the features section
- Hide the security/compliance section
- Hide the FAQ section
- Hide the testimonials section
- Hide the support section
- Hide the footer
- Update the page title to "PDF Tools"
- Make the tools section more prominent
## How to Enable Simple Mode
### Method 1: Using Pre-built Simple Mode Image (Recommended)
Use the pre-built Simple Mode image directly:
**Using Docker Hub:**
```bash
docker run -p 3000:8080 bentopdf/bentopdf-simple:latest
```
**Using GitHub Container Registry:**
```bash
docker run -p 3000:8080 ghcr.io/alam00000/bentopdf-simple:latest
```
Or with Docker Compose:
```yaml
services:
bentopdf:
# Using Docker Hub
image: bentopdf/bentopdf-simple:latest
# Or using GitHub Container Registry
# image: ghcr.io/alam00000/bentopdf-simple:latest
container_name: bentopdf
restart: unless-stopped
ports:
- '3000:8080'
```
### Method 2: Using Docker Compose with Build
Build the image locally with Simple Mode enabled:
```bash
docker compose -f docker-compose.dev.yml build --build-arg SIMPLE_MODE=true
docker compose -f docker-compose.dev.yml up -d
```
### Method 3: Using Docker Build
Build the image with the SIMPLE_MODE build argument:
```bash
docker build --build-arg SIMPLE_MODE=true -t bentopdf-simple .
docker run -p 3000:8080 bentopdf-simple
```
### Method 4: Using npm Script (Easiest for Local Development)
Use the built-in npm script that handles everything:
```bash
npm run serve:simple
```
This command automatically:
- Sets `SIMPLE_MODE=true`
- Builds the project with Simple Mode enabled
- Serves the built files on `http://localhost:3000`
### Method 5: Using Environment Variables
Set the environment variable before building:
```bash
export SIMPLE_MODE=true
npm run build
npx serve dist -p 3000
```
## 🧪 Testing Simple Mode Locally
### Method 1: Using npm Script (Easiest for Development)
```bash
npm run serve:simple
```
This automatically builds and serves Simple Mode on `http://localhost:3000`.
### Method 2: Using Pre-built Image (Easiest for Production)
```bash
# Pull and run the Simple Mode image
docker pull bentopdf/bentopdf-simple:latest
docker run -p 3000:8080 bentopdf/bentopdf-simple:latest
```
Open `http://localhost:3000` in your browser.
### Method 3: Build and Test Locally
```bash
# Build with simple mode
SIMPLE_MODE=true npm run build
# Serve the built files
npx serve dist -p 3000
```
Open `http://localhost:3000` in your browser.
### Method 4: Compare Both Modes
```bash
# Test Normal Mode
docker run -p 3000:8080 bentopdf/bentopdf:latest
# Test Simple Mode
docker run -p 3001:8080 bentopdf/bentopdf-simple:latest
```
- Normal Mode: `http://localhost:3000`
- Simple Mode: `http://localhost:3001`
## 🔍 What to Look For
When Simple Mode is working correctly, you should see:
- ✅ Clean "PDF Tools" header (no marketing hero section)
- ✅ "Select a tool to get started" subtitle
- ✅ Search bar for tools
- ✅ All PDF tool cards organized by category
- ❌ No navigation bar
- ❌ No hero section with "The PDF Toolkit built for privacy"
- ❌ No features, FAQ, testimonials, or footer sections
## 📦 Available Docker Images
### Normal Mode (Full Branding)
**Docker Hub:**
- `bentopdf/bentopdf:latest`
- `bentopdf/bentopdf:v1.0.0` (versioned)
**GitHub Container Registry:**
- `ghcr.io/alam00000/bentopdf:latest`
- `ghcr.io/alam00000/bentopdf:v1.0.0` (versioned)
### Simple Mode (Clean Interface)
**Docker Hub:**
- `bentopdf/bentopdf-simple:latest`
- `bentopdf/bentopdf-simple:v1.0.0` (versioned)
**GitHub Container Registry:**
- `ghcr.io/alam00000/bentopdf-simple:latest`
- `ghcr.io/alam00000/bentopdf-simple:v1.0.0` (versioned)
## 🚀 Production Deployment Examples
### Internal Company Tool
```yaml
services:
bentopdf:
image: bentopdf/bentopdf-simple:latest
container_name: bentopdf
restart: unless-stopped
ports:
- '80:80'
environment:
- PUID=1000
- PGID=1000
```
## ⚠️ Important Notes
- **Pre-built images**: Use `bentopdf/bentopdf-simple:latest` for Simple Mode
- **Environment variables**: `SIMPLE_MODE=true` only works during build, not runtime
- **Build-time optimization**: Simple Mode uses dead code elimination for smaller bundles
- **Same functionality**: All PDF tools work identically in both modes