Skip to content

Commit dd7b7a1

Browse files
committed
V2
1 parent 8fc414a commit dd7b7a1

File tree

2 files changed

+72
-9
lines changed

2 files changed

+72
-9
lines changed

docs/FAQ.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,18 @@ All endpoints provide the same functionality.
3939
### Q8: What's different in V2.0?
4040

4141
V2.0 is a major frontend rewrite with significant improvements:
42-
- **Modern React Frontend**: Complete rewrite using React + TypeScript replacing the old Thymeleaf templates
42+
- **Modern React Frontend**: Complete rewrite using React + TypeScript replacing Thymeleaf
43+
- **Stateful Processing**: Upload PDFs once and chain multiple tools without reloading
44+
- **History & Undo**: Full undo/redo functionality and file versioning
4345
- **Better Performance**: Handles large PDFs (up to 100GB+) with improved memory management
44-
- **Stateful Processing**: Upload PDFs once and chain multiple tools without reloading files
45-
- **Client-Side Storage**: Uses IndexedDB for file persistence and thumbnail caching
46+
- **Client-Side Storage**: Files persist between tool switches using IndexedDB
4647
- **Native Desktop Apps**: Powered by Tauri for improved native experience
4748
- **Flexible Deployment**: Can deploy frontend and backend separately for better scalability
4849

4950
The backend and API remain largely unchanged, so existing integrations continue to work.
5051

52+
For a comprehensive overview of all changes and the reasoning behind V2.0, see [Getting Started - Welcome to V2.0](/).
53+
5154
### Q9: Can I customize the UI in V2.0 like I did in V1.5?
5255

5356
No, the V1.5 `customFiles/` folder override system no longer works in V2.0 due to the React-based frontend.

docs/Getting Started.md

Lines changed: 66 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,73 @@ slug: /
1313
- **Open-Source:** Community-driven with frequent updates and GitHub support.
1414
- **Multi-Language Support:** Available in 38+ languages with active translations.
1515

16+
## Welcome to Stirling-PDF V2.0
17+
18+
We're excited to introduce Stirling-PDF V2.0 - a complete frontend rewrite that brings significant improvements to performance, user experience, and architecture.
19+
20+
### Why V2.0?
21+
22+
V1.5 served us well, but as Stirling-PDF grew in popularity and feature set, we identified key areas for improvement:
23+
- **Performance bottlenecks** with large PDFs and complex workflows
24+
- **Limited interactivity** due to server-side rendering (Thymeleaf)
25+
- **Scalability challenges** with the monolithic frontend/backend coupling
26+
- **User experience gaps** - no file history, no undo functionality, files had to be re-uploaded for each tool
27+
28+
V2.0 addresses all of these limitations with a ground-up rewrite of the frontend.
29+
1630
### What's New in V2.0
17-
- **Modern React Frontend:** Complete rewrite with React + TypeScript for improved performance and user experience
18-
- **Stateful Document Processing:** Upload PDFs once and chain multiple tools without reloading
19-
- **Enhanced Performance:** Handles large PDFs (up to 100GB+) with improved memory management
20-
- **Client-Side File Storage:** IndexedDB for persistent file storage and thumbnail caching
21-
- **Improved Desktop Experience:** Native desktop apps powered by Tauri
22-
- **Flexible Deployment:** Separate frontend/backend deployment options for scalability
31+
32+
#### 🎨 Modern React Frontend
33+
Complete rewrite using React + TypeScript with Mantine UI components for a more responsive and intuitive user experience.
34+
35+
#### 🚀 Significantly Improved Performance
36+
- Handles extremely large PDFs (up to 100GB+) with optimized memory management
37+
- Client-side processing for faster operations
38+
- Background Web Workers for thumbnail generation
39+
- Smooth UI even with hundreds of files loaded
40+
41+
#### 📁 Stateful Document Processing
42+
**This is a game-changer:** Upload your PDFs once, then chain multiple tools without reloading!
43+
- Split a PDF → View the results → Merge some pages → Compress → Download
44+
- Files persist between tool switches
45+
- No more re-uploading the same file for each operation
46+
47+
#### ⏮️ History & Version Control
48+
- **Undo/Redo functionality** - Made a mistake? Just undo it!
49+
- **File versioning** - Keep track of changes as you process documents
50+
- **Preview before committing** - See the results before replacing your original file
51+
52+
#### 💾 Client-Side File Storage
53+
- Files stored locally in your browser using IndexedDB
54+
- Automatic thumbnail caching for faster previews
55+
- Files persist across page refreshes
56+
- Privacy-first: Files stay on your device until you explicitly upload them to the server
57+
58+
#### 🔀 Flexible Deployment Architecture
59+
- **Unified Mode (default):** Single container with both frontend and backend
60+
- **Split Mode:** Deploy frontend and backend separately for better scalability
61+
- **Backend-Only Mode:** Use Stirling-PDF as an API-only service
62+
- Load balance frontend and backend independently
63+
64+
#### 🖥️ Enhanced Desktop Experience
65+
Native desktop applications powered by Tauri (replacing jcefmaven) for better performance and native OS integration.
66+
67+
### What Stays the Same
68+
69+
- **All existing features** - Every PDF tool from V1.5 is available in V2.0
70+
- **Backend API compatibility** - Existing integrations and scripts continue to work
71+
- **Configuration** - Same environment variables and settings.yml structure
72+
- **Docker deployment** - Same Docker images, same volume mounts (except customFiles)
73+
- **Security features** - SSO, user management, and permissions unchanged
74+
75+
### Migration from V1.5
76+
77+
For most users, upgrading to V2.0 is seamless:
78+
1. Pull the latest Docker image
79+
2. Restart your container
80+
3. That's it!
81+
82+
**Note:** The V1.5 `customFiles/` template override system no longer works. See [UI Customisation](/Advanced%20Configuration/UI%20Customisation) for V2.0 customization options.
2383

2484
Please feel free to request new features or report bugs through our [GitHub](https://github.com/Stirling-Tools/Stirling-PDF/issues) or [Discord](https://discord.gg/Cn8pWhQRxZ).
2585

0 commit comments

Comments
 (0)