diff --git a/docs/Configuration/Configuration.md b/docs/Configuration/Configuration.md index a84cc2ad..ebbf6988 100644 --- a/docs/Configuration/Configuration.md +++ b/docs/Configuration/Configuration.md @@ -106,8 +106,8 @@ For advanced features and specific use cases, see these detailed guides: ### Authentication & Security **[Single Sign-On (SSO)](./Single%20Sign-On%20Configuration.md)** -- OAuth2 (Google, GitHub, Keycloak, OIDC) -- SAML2 (Okta, Azure AD) - Pro/Enterprise only +- OAuth2 (Google, GitHub, Keycloak, OIDC) - Enterprise only +- SAML2 (Okta, Azure AD) - Enterprise only - Complete configuration examples **[System and Security](./System%20and%20Security.md)** diff --git a/docs/Configuration/DATABASE.md b/docs/Configuration/DATABASE.md index 4604ba81..28384b4e 100644 --- a/docs/Configuration/DATABASE.md +++ b/docs/Configuration/DATABASE.md @@ -1,10 +1,10 @@ --- sidebar_position: 10 -tags: [pro, enterprise, database, management] +tags: [server, database, management] --- # Database Backups -> **Tier**: Pro, Enterprise +> **Tier**: Server ## Functionality Overview diff --git a/docs/Configuration/External Database.md b/docs/Configuration/External Database.md index bc5ae639..ba2e2030 100644 --- a/docs/Configuration/External Database.md +++ b/docs/Configuration/External Database.md @@ -2,14 +2,14 @@ sidebar_position: 9 id: External Database title: External Database -tags: [enterprise, database] +tags: [server, database] --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; # Using an External Database -> **Tier**: Enterprise +> **Tier**: Server It is possible to use your own external database with Stirling PDF rather than the default H2 database if you wish. PostgreSQL is currently the only supported variant, others will be added on request. diff --git a/docs/Configuration/Google Drive File Picker.md b/docs/Configuration/Google Drive File Picker.md index 823efd2d..263cc2e9 100644 --- a/docs/Configuration/Google Drive File Picker.md +++ b/docs/Configuration/Google Drive File Picker.md @@ -1,13 +1,13 @@ --- sidebar_position: 5 -tags: [pro, enterprise, management, feature, advanced feature] +tags: [server, management, feature, advanced feature] --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; # Google Drive File Picker -> **Tier**: Pro, Enterprise +> **Tier**: Server Stirling-PDF allows users to select Files for processing through tools via google drive. diff --git a/docs/Configuration/Single Sign-On Configuration.md b/docs/Configuration/Single Sign-On Configuration.md index 11a5361a..7b7410b0 100644 --- a/docs/Configuration/Single Sign-On Configuration.md +++ b/docs/Configuration/Single Sign-On Configuration.md @@ -1,13 +1,13 @@ --- sidebar_position: 3 -tags: [pro, enterprise, management, feature, advanced feature] +tags: [enterprise, management, feature, advanced feature] --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; # Single Sign-On (SSO) Configuration -> **Tier**: Pro, Enterprise +> **Tier**: Enterprise Stirling-PDF allows login via Single Sign-On (SSO) using OAuth 2 OpenID Connect (OIDC) and SAML 2. This allows you to log in to the app using an account you may have with another Provider such as Google or GitHub. diff --git a/docs/Configuration/System and Security.md b/docs/Configuration/System and Security.md index dfefe771..66c8db08 100644 --- a/docs/Configuration/System and Security.md +++ b/docs/Configuration/System and Security.md @@ -114,7 +114,7 @@ SYSTEM_CORSALLOWEDORIGINS=https://pdf.example.com,https://pdf-staging.example.co - Always use HTTPS in production - Keep list minimal -**Learn more:** [Security - CORS](../Functionality/Security/Security.md#cors-configuration) +**Learn more:** [Security - CORS Configuration](../Functionality/Security#cors-configuration) --- @@ -235,7 +235,7 @@ security: **⚠️ Security Note:** Disabled by default. Only enable in controlled environments where outbound HTTPS is secure. -**Learn more:** [Certificate Signing - Validation](../Functionality/Security/Certificate-Signing.md#validating-signatures) +**Learn more:** [Certificate Signing - Validation](../Functionality/Security/Certificate-Signing#validating-signatures) --- @@ -276,7 +276,7 @@ If migrating from V1, note these setting name changes: - `jwt.keyCleanup` → `jwt.enableKeyCleanup` - `jwt.secureCookie` → Removed (always secure in production) -**Learn more:** [Migration - JWT Changes](../Migration/Settings-Changes.md#enhanced-jwt-configuration) +**Learn more:** [Migration - JWT Changes](../Migration/Settings-Changes#enhanced-jwt-configuration) --- diff --git a/docs/Configuration/Usage Monitoring.md b/docs/Configuration/Usage Monitoring.md index 119710e5..4aa2978d 100644 --- a/docs/Configuration/Usage Monitoring.md +++ b/docs/Configuration/Usage Monitoring.md @@ -1,11 +1,11 @@ --- sidebar_position: 5 title: Usage Monitoring -tags: [pro, enterprise, management, feature, advanced feature] +tags: [enterprise, management, feature, advanced feature] --- # Usage Monitoring -> **Tier**: Pro, Enterprise +> **Tier**: Enterprise Stirling-PDF provides robust usage monitoring capabilities through its API, allowing you to track application usage patterns and performance metrics. diff --git a/docs/Functionality/OCR.md b/docs/Functionality/OCR.md index ad2d3c95..7747c8e0 100644 --- a/docs/Functionality/OCR.md +++ b/docs/Functionality/OCR.md @@ -312,7 +312,7 @@ See [API Documentation](../API.md) for complete endpoint reference. - **[Convert](./Convert/Convert.md)** - Convert OCR'd PDFs to Word, text, or other formats - **[Compress](./Compress.md)** - Reduce file size after OCR - **[Multi-Tool](./Multi-Tool.md)** - Chain OCR with other operations -- **[Auto-Rename](./Advanced-Tools.md#auto-rename)** - Rename files based on OCR'd content +- **[Auto-Rename](./Advanced-Tools#auto-rename)** - Rename files based on OCR'd content --- diff --git a/docs/Functionality/Security/Certificate-Signing.md b/docs/Functionality/Security/Certificate-Signing.md index 03e78ee1..39b5ebaf 100644 --- a/docs/Functionality/Security/Certificate-Signing.md +++ b/docs/Functionality/Security/Certificate-Signing.md @@ -811,12 +811,12 @@ curl -X POST http://stirling-pdf:8080/api/v1/security/validate-signature \ ## Learn More **Configuration:** -- [System and Security Settings](../../Configuration/System%20and%20Security.md#signature-validation) - Technical configuration details -- [Extra Settings](../../Configuration/Extra-Settings.md) - All certificate-related configuration options +- [System and Security Settings](../../Configuration/System%20and%20Security#signature-validation) - Technical configuration details +- [Extra Settings](../../Configuration/Extra-Settings) - All certificate-related configuration options **Migration:** -- [Settings Changes](../../Migration/Settings-Changes.md#pdf-signature-validation) - V2 new settings -- [New Features](../../Migration/New-Features.md#-pdf-signature-validation) - Feature overview +- [Settings Changes](../../Migration/Settings-Changes#pdf-signature-validation) - V2 new settings +- [New Features](../../Migration/New-Features#-pdf-signature-validation) - Feature overview **Related Tools:** - [Sign](./Security.md) - Handwritten/image signatures diff --git a/docs/Functionality/Security/Security.md b/docs/Functionality/Security/Security.md index bbdef933..0a2d86c0 100644 --- a/docs/Functionality/Security/Security.md +++ b/docs/Functionality/Security/Security.md @@ -32,7 +32,7 @@ description: Security features for PDFs and deployment configurations - **`validate-signature`**: Verify digital signatures and certificates in PDF documents. Check against trusted certificate chains including system trust, Adobe AATL, EU EUTL, and Mozilla CA bundle. - **Learn more:** [Certificate Signing - Validation](./Certificate-Signing.md#validating-signatures) + **Learn more:** [Certificate Signing - Validation](./Certificate-Signing#validating-signatures) - **`remove-cert-sign`**: Remove digital certificate signatures from PDFs. Useful when you need to edit a signed document. @@ -89,7 +89,7 @@ security: hardFail: false # Fail if revocation check fails ``` -**Learn more:** [Certificate Signing - Configuration](./Certificate-Signing.md#configuration-examples) +**Learn more:** [Certificate Signing - Configuration](./Certificate-Signing#configuration-examples) --- @@ -140,8 +140,8 @@ corsAllowedOrigins: ['https://pdf.example.com'] ``` **Learn more:** -- [Split Deployment Configuration](../../Configuration/System%20and%20Security.md#cors-configuration) -- [Docker Split Mode](../../Installation/Docker%20Install.md#split-deployment-advanced-users) +- [Split Deployment Configuration](../../Configuration/System%20and%20Security#cors-configuration) +- [Docker Split Mode](../../Installation/Docker%20Install#split-deployment-advanced-users) --- diff --git a/docs/Functionality/Security/Sign.md b/docs/Functionality/Security/Sign.md index 38977aff..132641e7 100644 --- a/docs/Functionality/Security/Sign.md +++ b/docs/Functionality/Security/Sign.md @@ -9,7 +9,7 @@ description: Add handwritten, text, or image signatures to PDFs **Tool ID:** `sign` -Add handwritten signatures, text signatures, or image-based signatures to PDF documents. This tool is for visual/handwritten signatures - for certificate-based digital signatures, see [Certificate Signing](./Certificate-Signing.md). +Add handwritten signatures, text signatures, or image-based signatures to PDF documents. This tool is for visual/handwritten signatures - for certificate-based digital signatures, see [Certificate Signing](./Certificate-Signing). --- @@ -34,7 +34,7 @@ There are two types of PDF signatures: **Use For:** Legal documents, contracts requiring authentication, compliance requirements. -**Learn More:** [Certificate Signing Guide](./Certificate-Signing.md) +**Learn More:** [Certificate Signing Guide](./Certificate-Signing) --- @@ -87,7 +87,7 @@ You can configure Stirling-PDF to load pre-stored signature files for quick acce - Quick signing of multiple documents - Team/organization signature standards -**Configuration:** [Sign with Custom Files](../../Configuration/Sign%20with%20custom%20files.md) +**Configuration:** [Sign with Custom Files](../../Configuration/Sign%20with%20custom%20files) --- @@ -172,7 +172,7 @@ You can configure Stirling-PDF to load pre-stored signature files for quick acce ### Visual vs. Digital Signatures -| Feature | Visual Signature (This Tool) | Digital Signature ([Certificate](./Certificate-Signing.md)) | +| Feature | Visual Signature (This Tool) | Digital Signature ([Certificate](./Certificate-Signing)) | |---------|------------------------------|-------------------------------------------------------------| | **Appearance** | Handwritten/image | May include visual + certificate info | | **Security** | Visual only, can be copied | Cryptographically secure | @@ -191,7 +191,7 @@ You can configure Stirling-PDF to load pre-stored signature files for quick acce - ✅ Documents that just need a visual signature - ✅ No cryptographic verification needed -**Use Digital Signing ([Certificate](./Certificate-Signing.md)) When:** +**Use Digital Signing ([Certificate](./Certificate-Signing)) When:** - ✅ Legal contracts requiring authentication - ✅ Compliance and regulatory documents - ✅ Documents that must prove integrity @@ -223,7 +223,7 @@ For organizations needing standardized signatures: 3. Users select from available signatures 4. Consistent appearance across documents -**Setup:** [Sign with Custom Files](../../Configuration/Sign%20with%20custom%20files.md) +**Setup:** [Sign with Custom Files](../../Configuration/Sign%20with%20custom%20files) --- @@ -297,7 +297,7 @@ For organizations needing standardized signatures: - Personal documents **❌ NOT Appropriate For:** -- Legal contracts (use [digital signatures](./Certificate-Signing.md)) +- Legal contracts (use [digital signatures](./Certificate-Signing)) - Financial documents requiring verification - Government/regulatory submissions - Documents requiring proof of identity @@ -348,11 +348,11 @@ See [API Documentation](../../API.md) for complete endpoint reference. ## Related Tools -- **[Certificate Signing](./Certificate-Signing.md)** - Digital signatures with certificates -- **[Add Image](../Advanced-Tools.md#add-image)** - Add logos or other images -- **[Add Stamp](../Content-Editing/Content-Editing.md)** - Add official stamps -- **[Flatten](./Security.md#permissions--access-control)** - Make signatures non-editable -- **[Add Password](./Security.md#password-protection)** - Protect signed documents +- **[Certificate Signing](./Certificate-Signing)** - Digital signatures with certificates +- **[Add Image](../Advanced-Tools#add-image)** - Add logos or other images +- **[Add Stamp](../Content-Editing#stamps--annotations)** - Add official stamps +- **[Flatten](../Security#permissions--access-control)** - Make signatures non-editable +- **[Add Password](../Security#password-protection)** - Protect signed documents --- @@ -369,4 +369,4 @@ Stirling-PDF's Sign tool provides: Perfect for forms, applications, and documents needing visual signatures! -**Need authentication and legal validity?** Use [Certificate Signing](./Certificate-Signing.md) instead. +**Need authentication and legal validity?** Use [Certificate Signing](./Certificate-Signing) instead. diff --git a/docs/Getting Started.md b/docs/Getting Started.md index 24415781..6a4faa79 100644 --- a/docs/Getting Started.md +++ b/docs/Getting Started.md @@ -49,8 +49,8 @@ Browse all 60+ PDF tools with descriptions and use cases **[Production Deployment Guide](./Server-Admin-Onboarding.md)** Complete walkthrough: installation → configuration → security → monitoring -**[Pro & Enterprise Features](./Pro.md)** -SSO, advanced monitoring, external databases, and priority support +**[Paid Offerings (Server & Enterprise)](./Paid-Offerings)** +External databases, Google Drive integration, SSO, advanced monitoring, and priority support **[Configuration Options](./Configuration/Extra-Settings.md)** All configuration options for Docker and server deployments diff --git a/docs/Migrating-to-V2.md b/docs/Migrating-to-V2.md deleted file mode 100644 index a144a89f..00000000 --- a/docs/Migrating-to-V2.md +++ /dev/null @@ -1,343 +0,0 @@ ---- -sidebar_position: 3 -description: Guide for upgrading from V1 to V2 ---- - -# Migrating from V1 to V2 - -:::info Complete Migration Guide -This page provides a quick overview. For comprehensive migration documentation, see the **[Migration Guide](./Migration/Overview)** with detailed sections on: -- [New Features](./Migration/New-Features) - Everything new in V2 -- [Settings Changes](./Migration/Settings-Changes) - Complete configuration updates -- [Breaking Changes](./Migration/Breaking-Changes) - Important changes and migration paths -::: - -Upgrading to Stirling-PDF V2 is straightforward for most users. This guide helps you understand what's changed and how to make the transition smoothly. - -## Should You Upgrade? - -**Yes, if you want:** -- ✅ Faster workflows with file persistence -- ✅ Undo/redo functionality -- ✅ Better performance with large files -- ✅ Desktop applications -- ✅ Modern, responsive interface -- ✅ Future features and updates - -**Consider staying on V1 if:** -- ⚠️ You heavily customized the UI using `customFiles/templates` (requires code changes to migrate) -- ⚠️ You have specific compatibility requirements with very old browsers - -## What's Changed for Users - -### New Features You'll Love - -1. **Upload Once, Use Everywhere** - - Files stay in your browser between operations - - No more re-uploading for each tool - - Faster multi-step workflows - -2. **Undo and Redo** - - Made a mistake? Just undo it - - Try different settings and compare results - - Track, revert, and download any previous version - - All file history stored locally on your device - -3. **Desktop Applications** - - Native Windows, Mac, and Linux apps - - Lightning-fast startup (as quick as 0.3 seconds) - - "Open with Stirling-PDF" from any PDF file - - Set as your default PDF viewer - - Work completely offline - -4. **Better Performance** - - Improved handling of large files - - Better memory management - - Smoother interface - - Faster page loads - -5. **In-App Settings Management** - - Configure all settings through the Settings menu (admin only) - - No need to edit config files or restart - - Visual interface with validation - - Changes apply immediately - -### What Works the Same - -- ✅ All PDF operations and tools -- ✅ API endpoints (integrations continue to work) -- ✅ Authentication and user management -- ✅ Security features -- ✅ Pipeline and automation (now called "Automate" in the frontend with improved UX) -- ✅ Multi-language support -- ✅ Custom settings and configurations -- ✅ Privacy commitment - Your data stays yours, with full control over analytics (see [Analytics and Telemetry](./analytics-telemetry)) - -## Upgrading Your Installation - -### Docker Users (Recommended Method) - -Simply update your image tag: - -```bash -# Stop current container -docker stop stirling-pdf - -# Pull V2.0 -docker pull stirlingtools/stirling-pdf:latest - -# Start with same configuration -docker start stirling-pdf -``` - -Or update your docker-compose.yml: - -```yaml -services: - stirling-pdf: - image: stirlingtools/stirling-pdf:latest # Change from 1.x to latest - # Keep all your existing environment variables and volumes - ports: - - 8080:8080 - volumes: - - ./data:/configs - - ./customFiles:/customFiles # V2 ignores templates, but other files work - environment: - # All your existing environment variables still work - - SECURITY_ENABLELOGIN=true - - LANGS=en-GB,es-ES,fr-FR -``` - -Then: -```bash -docker-compose down -docker-compose pull -docker-compose up -d -``` - -### Desktop Application Users - -1. **Windows**: Download new installer, run it (automatically updates) -2. **Mac**: Download new DMG, drag to Applications (replaces old version) -3. **Linux**: Install new .deb/.rpm/.AppImage - -Your settings should carry over automatically. - -### Manual Installation Users - -If you're running Stirling-PDF from the JAR file: - -1. Download the latest V2.0 release from [GitHub Releases](https://github.com/Stirling-Tools/Stirling-PDF/releases) -2. Stop the current V1 instance -3. Replace the JAR file -4. Start with the same command - -## Data Migration - -### Your Data is Safe - -V2.0 is **fully compatible** with V1 data: - -- ✅ User accounts and permissions -- ✅ API keys -- ✅ Settings and configurations -- ✅ Database (if using external database) -- ✅ Custom OCR language files -- ✅ Custom fonts and certificates - -**No manual migration needed** - just upgrade and your data continues working. - -### Volume Mounts That Still Work - -These volumes work exactly the same in V2: - -```yaml -volumes: - - ./configs:/configs # Settings and database - - ./logs:/logs # Log files - - ./customFiles/static:/customFiles/static # Custom images/logos - - ./tessdata:/usr/share/tessdata # OCR languages -``` - -### What Doesn't Work Anymore - -❌ **Template customization** - `customFiles/templates/` folder has been replaced - -The V1 template override system has been replaced with a new customization approach due to the UI framework change. V2 uses React components instead of HTML templates. - -**If you customized templates**, you'll need to: -1. Modify React components in the source code -2. Build the frontend -3. Deploy custom build - -See [UI Customisation](./Configuration/UI%20Customisation.md) for alternatives. - -## Breaking Changes - -### Template Customization System Changed - -**V1 Method (replaced in V2):** -``` -customFiles/templates/ - ├── home.html ❌ Replaced with React components - ├── merge.html ❌ Replaced with React components - └── settings.html ❌ Replaced with React components -``` - -**V2 Alternatives:** -- Use environment variables for branding -- Use settings panel for theme customization -- For extensive changes, modify React components in source - -### Environment Variables (New in V2) - -New optional variables you might want to use: - -```bash -# Deployment mode (default: BOTH) -MODE=BOTH # or FRONTEND or BACKEND - -# Internal backend port (when MODE=BOTH) -BACKEND_INTERNAL_PORT=8081 - -# Backend URL (when MODE=FRONTEND) -VITE_API_BASE_URL=http://your-backend:8080 -``` - -**All V1 environment variables still work** - these are additions, not replacements. - -## Post-Upgrade Checklist - -After upgrading, verify: - -- [ ] Can log in with existing credentials -- [ ] All PDF tools work as expected -- [ ] Settings and preferences are retained -- [ ] API integrations still function (if applicable) -- [ ] Custom branding appears correctly -- [ ] OCR languages are available -- [ ] Pipelines and automation continue working - -## New Features to Try - -After upgrading, explore these V2 features: - -1. **Upload a PDF** and try using multiple tools without re-uploading -2. **Use Undo/Redo** - make a change and undo it -3. **Check File Manager** - see all files stored in your browser -4. **Try the Desktop App** - download it for offline work -5. **Explore new interface** - faster and more responsive - -## Troubleshooting - -### "Files disappeared after refresh" - -This is normal V2 behavior. Files are temporarily stored in your browser: -- **Solution**: Download finished files before refreshing -- **Alternative**: Use desktop app for persistent storage - -### "My custom template changes are gone" - -V2 no longer uses HTML templates: -- **Solution**: Use environment variables for basic customization -- **Alternative**: Modify React source code for extensive changes -- **See**: [UI Customisation](./Configuration/UI%20Customisation.md) - -### "Interface looks different" - -V2 has a completely new React-based interface: -- **This is expected** - new modern design -- **All features are still there** - just in new locations -- **Tip**: Explore the new interface, it's more intuitive - -### "High memory usage" - -V2 actually uses less memory than V1 in most cases: -- **Check**: Are you using the right variant? (Standard vs Ultra-Lite) -- **Try**: Disable login if not needed (`SECURITY_ENABLELOGIN=false`) -- **See**: [FAQ - Memory Optimization](./FAQ.md#q6-my-stirling-pdf-using-high-ram-at-idle-how-can-i-optimize-memory-usage) - -### "API integration broken" - -V2's API is backward compatible: -- **Check**: Endpoint URLs haven't changed -- **Verify**: API keys are still valid -- **Test**: Use the Swagger UI at `/swagger-ui.html` - -## Rolling Back (If Needed) - -If you need to return to V1: - -### Docker -```bash -docker pull stirlingtools/stirling-pdf:1.5.0 # or your previous version -# Update your docker-compose.yml to use 1.5.0 tag -docker-compose up -d -``` - -### Desktop App -Uninstall V2 and reinstall V1 from [releases](https://github.com/Stirling-Tools/Stirling-PDF/releases/tag/v1.5.0) - -### Manual Installation -Replace the JAR file with your previous V1 version. - -**Note**: Your data will still work if you roll back - no data migration is needed in either direction. - -## Getting Help - -If you encounter issues: - -1. **Migration Guide**: [Complete Migration Documentation](./Migration/Overview) - Comprehensive upgrade guide -2. **Settings Changes**: [Configuration Updates](./Migration/Settings-Changes) - All setting changes -3. **Breaking Changes**: [What Changed](./Migration/Breaking-Changes) - Important changes -4. **FAQ**: [Frequently Asked Questions](./FAQ) - Common questions answered -5. **Report Issues**: [GitHub Issues](https://github.com/Stirling-Tools/Stirling-PDF/issues) -6. **Join Discord**: Get community help and support - -## Deployment Mode Options (Advanced) - -V2 allows splitting frontend and backend for advanced deployments: - -### Simple Deployment (Default) -```bash -# Everything in one container -docker run -e MODE=BOTH stirlingtools/stirling-pdf:latest -``` - -### Split Deployment -```bash -# Backend server -docker run -e MODE=BACKEND -p 8080:8080 stirlingtools/stirling-pdf:latest - -# Frontend (can run multiple instances) -docker run -e MODE=FRONTEND -e VITE_API_BASE_URL=http://backend:8080 -p 80:80 stirlingtools/stirling-pdf:latest -``` - -**Use split deployment if:** -- You want to scale frontend and backend independently -- Serving frontend from a CDN -- Running multiple frontends with one backend - -**Stick with MODE=BOTH if:** -- Simple single-server deployment -- Don't need independent scaling -- Want easiest setup - -See [Docker Installation](./Installation/Docker%20Install.md) for detailed examples. - -## Summary - -**Upgrading to V2 is easy:** -1. Pull latest Docker image (or download desktop app) -2. Start with your existing configuration -3. Everything continues working -4. Explore new features! - -**Key takeaways:** -- ✅ Data is fully compatible -- ✅ API remains unchanged -- ✅ Most customizations still work -- ❌ Template overrides need different approach -- 🎉 Many new features to enjoy - -**Welcome to V2!** Enjoy the faster, more modern Stirling-PDF experience. diff --git a/docs/Migration/Breaking-Changes.md b/docs/Migration/Breaking-Changes.md index d44127a1..b167f08a 100644 --- a/docs/Migration/Breaking-Changes.md +++ b/docs/Migration/Breaking-Changes.md @@ -256,7 +256,7 @@ SECURITY_JWT_KEYRETENTIONDAYS=7 **Action:** Users just need to log in again. Normal behavior. -**Learn more:** [Settings Changes - JWT Configuration](./Settings-Changes.md#enhanced-jwt-configuration) +**Learn more:** [Settings Changes - JWT Configuration](./Settings-Changes#enhanced-jwt-configuration) --- diff --git a/docs/Migration/New-Features.md b/docs/Migration/New-Features.md index f5372153..6335bfd8 100644 --- a/docs/Migration/New-Features.md +++ b/docs/Migration/New-Features.md @@ -195,7 +195,7 @@ system: frontendUrl: 'https://pdf.example.com' ``` -**Learn More:** [Docker Installation - Split Mode](../Installation/Docker%20Install.md#split-deployment-advanced-users) +**Learn More:** [Docker Installation - Split Mode](../Installation/Docker%20Install#split-deployment-advanced-users) --- @@ -425,8 +425,8 @@ system: ``` **Learn More:** -- [Certificate Signing Guide](../Functionality/Security/Certificate-Signing.md) -- [Configuration](../Configuration/System%20and%20Security.md#server-certificates) +- [Certificate Signing Guide](../Functionality/Security/Certificate-Signing) +- [Configuration](../Configuration/System%20and%20Security#server-certificates) --- diff --git a/docs/Migration/Overview.md b/docs/Migration/Overview.md index f1e14d6b..e4409a85 100644 --- a/docs/Migration/Overview.md +++ b/docs/Migration/Overview.md @@ -1,187 +1,213 @@ ---- -sidebar_position: 0 -id: Overview -title: Migrating from V1 to V2 -description: Complete guide for upgrading from Stirling-PDF V1 to V2 ---- - -# Migrating from V1 to V2 - -Upgrading to Stirling-PDF V2 is straightforward for most users. This section helps you understand what changed and how to migrate smoothly. - ---- - -## Quick Migration Guide - -### For Docker Users (Most Common) - -```bash -# Stop current container -docker stop stirling-pdf - -# Pull V2 -docker pull stirlingtools/stirling-pdf:latest - -# Start with same configuration -docker start stirling-pdf -``` - -**That's it!** Your data and settings migrate automatically. - ---- - -## Migration Topics - -### [New Features in V2](./New-Features.md) -Everything new in V2: -- Browser file storage -- Undo/redo functionality -- Desktop applications -- Split deployment architecture -- PDF signature validation -- Server certificate management -- Enhanced JWT -- And much more... - -### [Settings Changes](./Settings-Changes.md) -Configuration changes between V1 and V2: -- New settings added -- Deprecated settings removed -- Settings renamed or reorganized -- Migration examples - -### [Breaking Changes](./Breaking-Changes.md) -Important changes that may affect you: -- Template customization system replaced -- UI settings moved to in-app configuration -- Removed features -- API compatibility notes - ---- - -## Should You Upgrade? - -**Yes, if you want:** -- ✅ Faster workflows with file persistence -- ✅ Undo/redo functionality -- ✅ Better performance with large files -- ✅ Desktop applications -- ✅ Modern, responsive interface -- ✅ Future features and updates - -**Consider staying on V1 if:** -- ⚠️ You heavily customized UI using `customFiles/templates` (requires code changes to migrate) -- ⚠️ You have specific compatibility requirements with very old browsers - ---- - -## What Stays the Same - -- ✅ All existing PDF tools -- ✅ Backend API compatibility -- ✅ Configuration files (settings.yml) -- ✅ Docker deployment process -- ✅ Security features (SSO, user management) -- ✅ Pipeline automation (renamed "Automate" in UI) -- ✅ Privacy commitment - ---- - -## Data Migration - -### Your Data is Safe - -V2 is **fully compatible** with V1 data: -- ✅ User accounts and permissions -- ✅ API keys -- ✅ Settings and configurations -- ✅ Database (internal or external) -- ✅ Custom OCR language files -- ✅ Custom fonts and certificates - -**No manual migration needed** - just upgrade and your data continues working. - ---- - -## Deployment Options - -### Simple Upgrade - -Same as V1, everything in one container: -```bash -docker run -d \ - -p 8080:8080 \ - -v ./data:/configs \ - stirlingtools/stirling-pdf:latest -``` - -### New: Split Deployment (Optional) - -V2 allows separating frontend and backend: - -**Backend:** -```bash -docker run -d \ - -e MODE=BACKEND \ - -p 8081:8080 \ - stirlingtools/stirling-pdf:latest -``` - -**Frontend:** -```bash -docker run -d \ - -e MODE=FRONTEND \ - -e VITE_API_BASE_URL=http://backend:8080 \ - -p 8080:8080 \ - stirlingtools/stirling-pdf:latest -``` - -See [Docker Installation](../Installation/Docker%20Install.md) for details. - ---- - -## Post-Upgrade Checklist - -After upgrading, verify: - -- [ ] Can log in with existing credentials -- [ ] All PDF tools work as expected -- [ ] Settings and preferences retained -- [ ] API integrations still function (if applicable) -- [ ] Custom branding appears correctly -- [ ] OCR languages available -- [ ] Pipelines continue working (now called "Automate" in UI) - ---- - -## Getting Help - -If you encounter issues: - -1. **[Settings Changes](./Settings-Changes.md)** - Check if your config needs updates -2. **[Breaking Changes](./Breaking-Changes.md)** - Review what changed -3. **[FAQ](../FAQ.md)** - Common questions answered -4. **[GitHub Issues](https://github.com/Stirling-Tools/Stirling-PDF/issues)** - Report problems -5. **[Discord](https://discord.gg/Cn8pWhQRxZ)** - Community support - ---- - -## Rolling Back (If Needed) - -If you need to return to V1: - -```bash -docker pull stirlingtools/stirling-pdf:1.5.0 -# Update docker-compose.yml to use 1.5.0 tag -docker-compose up -d -``` - -**Note:** Your data will still work if you roll back. - ---- - -## Next Steps - -- **[New Features](./New-Features.md)** - Explore what's new -- **[Settings Changes](./Settings-Changes.md)** - Update your configuration -- **[Getting Started](../Getting%20Started.md)** - Start using V2 +--- +sidebar_position: 0 +id: Overview +title: Migrating from V1 to V2 +description: Complete guide for upgrading from Stirling-PDF V1 to V2 +--- + +# Migrating from V1 to V2 + +Upgrading to Stirling-PDF V2 is straightforward for most users. This guide will walk you through the upgrade process. + +:::warning Backup Your Configuration +Before upgrading, **back up your configuration folder** (usually mounted as `/configs`) to ensure you can restore your settings if needed: +```bash +# Docker volume backup +docker cp stirling-pdf:/configs ./configs-backup + +# Or if using bind mount +cp -r ./configs ./configs-backup +``` +::: + +--- + +## Quick Upgrade Guide + +### Docker Users (Most Common) + +Update your image tag to `latest` (or specific V2 version): + +```yaml +services: + stirling-pdf: + image: stirlingtools/stirling-pdf:latest # Change from 1.x to latest + # Keep all your existing environment variables and volumes +``` + +Then pull and restart. See the [Docker Installation Guide - Updating Section](../Installation/Docker%20Install#updating-stirling-pdf) for complete update commands. + +**That's it!** Your data and settings migrate automatically. + +--- + +### Desktop Application Users + +1. **Windows**: Download new installer from [GitHub Releases](https://github.com/Stirling-Tools/Stirling-PDF/releases), run it (automatically updates) +2. **Mac**: Download new DMG, drag to Applications (replaces old version) +3. **Linux**: Install new `.deb`/`.rpm`/`.AppImage` + +Your settings carry over automatically. + +--- + +### Manual Installation (JAR) + +1. Download the latest V2 release from [GitHub Releases](https://github.com/Stirling-Tools/Stirling-PDF/releases) +2. Stop the current V1 instance +3. Replace the JAR file +4. Start with the same command + +--- + +## Migration Guide Sections + +This migration guide is organized into detailed sections: + +### 📋 [Settings Changes](./Settings-Changes.md) +**Start here** if you have custom configuration. Covers: +- New settings added in V2 +- Deprecated settings to remove +- Settings that were renamed +- Configuration examples and migration checklist + +### ⚠️ [Breaking Changes](./Breaking-Changes.md) +**Important** - Review if you have customizations. Covers: +- Template customization system changes (most impactful) +- UI settings moved to in-app configuration +- Session management improvements +- Database notification changes +- API compatibility notes + +### ✨ [New Features](./New-Features.md) +**Explore what's new** - Comprehensive list of V2 features: +- Browser file storage +- Undo/redo functionality +- Desktop applications +- Multi-Tool workbench +- PDF signature validation +- In-app settings management +- And much more... + +--- + +## Should You Upgrade? + +**Yes, if you want:** +- ✅ Faster workflows with file persistence +- ✅ Undo/redo functionality +- ✅ Better performance with large files +- ✅ Desktop applications +- ✅ Modern, responsive interface +- ✅ Future features and updates + +**Consider staying on V1 if:** +- ⚠️ You heavily customized UI using `customFiles/templates` (requires code changes to migrate) +- ⚠️ You have specific compatibility requirements with very old browsers + +--- + +## What Stays the Same + +- ✅ All existing PDF tools +- ✅ Backend API compatibility +- ✅ Configuration files (settings.yml) +- ✅ Docker deployment process +- ✅ Security features (SSO, user management) +- ✅ Pipeline automation (renamed "Automate" in UI) +- ✅ Privacy commitment + +--- + +## Your Data is Safe + +V2 is **fully compatible** with V1 data: +- ✅ User accounts and permissions +- ✅ API keys +- ✅ Settings and configurations +- ✅ Database (internal or external) +- ✅ Custom OCR language files +- ✅ Custom fonts and certificates + +**No manual migration needed** - database schema updates automatically on first startup. + +--- + +## Post-Upgrade Checklist + +After upgrading, verify everything works: + +- [ ] Can log in with existing credentials +- [ ] All PDF tools work as expected +- [ ] Settings and preferences retained +- [ ] API integrations still function (if applicable) +- [ ] Custom branding appears correctly +- [ ] OCR languages available +- [ ] Pipelines continue working (now called "Automate" in UI) + +--- + +## Troubleshooting + +### Common Issues + +**"Unknown configuration key" warnings** +- **Cause:** Old V1 settings in your `settings.yml` +- **Solution:** See [Settings Changes](./Settings-Changes.md) to remove deprecated settings + +**Users logged out after upgrade** +- **Cause:** JWT token format changed (normal) +- **Solution:** Users just need to log in once + +**Custom templates not loading** +- **Cause:** Template system replaced with React components +- **Solution:** See [Breaking Changes - Template Customization](./Breaking-Changes#-template-customization-system-removed) + +**App name not showing** +- **Cause:** Setting moved to in-app configuration +- **Solution:** Log in as admin → Settings → UI + +--- + +## Rolling Back (If Needed) + +If you need to return to V1: + +```bash +# Restore config backup +cp -r ./configs-backup ./configs + +# Pull V1 image +docker pull stirlingtools/stirling-pdf:1.5.0 + +# Update docker-compose.yml to use 1.5.0 tag +docker-compose up -d +``` + +**Note:** Your data will work if you roll back (database is backward compatible). + +--- + +## Getting Help + +If you encounter issues: + +1. **[Settings Changes](./Settings-Changes.md)** - Update your configuration +2. **[Breaking Changes](./Breaking-Changes.md)** - Review important changes +3. **[New Features](./New-Features.md)** - Learn what's new +4. **[FAQ](../FAQ.md)** - Common questions answered +5. **[GitHub Issues](https://github.com/Stirling-Tools/Stirling-PDF/issues)** - Report problems +6. **[Discord](https://discord.gg/Cn8pWhQRxZ)** - Community support + +--- + +## Summary + +**Upgrading is easy:** +1. Back up your `/configs` folder +2. Pull latest Docker image (or download desktop app) +3. Start with existing configuration +4. Review [Settings Changes](./Settings-Changes.md) for any needed updates +5. Check [Breaking Changes](./Breaking-Changes.md) if you have customizations + +**Welcome to V2!** Enjoy the faster, more modern Stirling-PDF experience. diff --git a/docs/Migration/Settings-Changes.md b/docs/Migration/Settings-Changes.md index 343cd242..e18c9ee7 100644 --- a/docs/Migration/Settings-Changes.md +++ b/docs/Migration/Settings-Changes.md @@ -41,7 +41,7 @@ security: **Migration:** No action needed, defaults are safe for most users. -**Learn more:** [Certificate Signing](../Functionality/Security/Certificate-Signing.md) | [Security Configuration](../Configuration/System%20and%20Security.md#signature-validation) +**Learn more:** [Certificate Signing](../Functionality/Security/Certificate-Signing) | [Security Configuration](../Configuration/System%20and%20Security#signature-validation) --- @@ -62,7 +62,7 @@ system: **Migration:** Works automatically with defaults. -**Learn more:** [Certificate Signing](../Functionality/Security/Certificate-Signing.md) | [Certificate Configuration](../Configuration/System%20and%20Security.md#server-certificates) +**Learn more:** [Certificate Signing](../Functionality/Security/Certificate-Signing) | [Certificate Configuration](../Configuration/System%20and%20Security#server-certificates) --- @@ -89,7 +89,7 @@ system: frontendUrl: 'https://pdf.example.com' ``` -**Learn more:** [Docker Installation - Split Mode](../Installation/Docker%20Install.md#split-deployment-advanced-users) +**Learn more:** [Docker Installation - Split Mode](../Installation/Docker%20Install#split-deployment-advanced-users) --- diff --git a/docs/Migration/_category_.json b/docs/Migration/_category_.json index 5bf84adf..a4a40a5f 100644 --- a/docs/Migration/_category_.json +++ b/docs/Migration/_category_.json @@ -1,8 +1,8 @@ -{ - "label": "Migrating to V2", - "position": 4, - "link": { - "type": "doc", - "id": "Migration/Overview" - } -} +{ + "label": "Migration from V1 to V2", + "position": 4, + "link": { + "type": "doc", + "id": "Migration/Overview" + } +} diff --git a/docs/Pro.md b/docs/Paid-Offerings.md similarity index 96% rename from docs/Pro.md rename to docs/Paid-Offerings.md index c08b9328..39772bcd 100644 --- a/docs/Pro.md +++ b/docs/Paid-Offerings.md @@ -1,17 +1,18 @@ --- sidebar_position: 5 -id: Pro -title: Pro / Enterprise -description: Enterprise/Pro edition for stirling PDF +id: Paid-Offerings +title: Paid Offerings +description: Server and Enterprise paid plans for Stirling-PDF tags: - Enterprise - - Pro - - Premium + - Server + - Paid + - Pricing --- -# Stirling PDF Pro / Enterprise +# Stirling-PDF Paid Offerings -Stirling PDF offers Pro and Enterprise editions of its software. These are the same great software, but with added features, streamlined license management, and support options. +Stirling-PDF offers Server and Enterprise paid plans. These provide the same great software with added features, streamlined license management, and support options. ## Available Plans diff --git a/docs/Server-Admin-Onboarding.md b/docs/Server-Admin-Onboarding.md index b52e8709..115082ae 100644 --- a/docs/Server-Admin-Onboarding.md +++ b/docs/Server-Admin-Onboarding.md @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem'; Welcome! This guide will walk you through deploying Stirling-PDF for your organization, from initial installation to advanced configuration and scaling. :::tip For Organizations & Teams -This guide is designed for server administrators deploying Stirling-PDF for teams, departments, or entire organizations. If you're interested in **Pro or Enterprise features** (SSO, advanced user management, priority support), we'll highlight upgrade paths throughout this guide. +This guide is designed for server administrators deploying Stirling-PDF for teams, departments, or entire organizations. If you're interested in **paid plan features** (external database, Google Drive, SSO, advanced user management, priority support), we'll highlight upgrade paths throughout this guide. ::: --- @@ -27,7 +27,7 @@ By the end of this guide, you'll have: 3. ✅ **Settings customized** for your organization 4. ✅ **Security hardened** with HTTPS and proper access controls 5. ✅ **Monitoring setup** to track usage and performance -6. ✅ **Understanding of Pro/Enterprise** upgrade paths +6. ✅ **Understanding of paid plan** upgrade paths (Server/Enterprise) **Time estimate:** 30-60 minutes for basic setup, 2-3 hours for full enterprise configuration @@ -520,8 +520,8 @@ MAIL_SMTP_TLS_ENABLED=true **Best for:** Large enterprises, existing SSO infrastructure **Single Sign-On (SSO) options:** -- **OAuth2:** Free - Supports Google, GitHub, Keycloak, any OpenID Connect provider -- **SAML2:** Pro/Enterprise only - Supports Okta, Azure AD, etc. +- **OAuth2:** Enterprise only - Supports Google, GitHub, Keycloak, any OpenID Connect provider +- **SAML2:** Enterprise only - Supports Okta, Azure AD, etc. **Key settings:** ```yaml @@ -727,7 +727,7 @@ Stirling-PDF can handle HTTPS directly using built-in SSL configuration. - ⚠️ No load balancing - ⚠️ Port 8443 instead of standard 443 -**Learn more:** [Custom Settings - SSL Configuration](./Configuration/Extra-Settings.md#ssltls-configuration) +**Learn more:** [Custom Settings - SSL Configuration](./Configuration/Extra-Settings#ssltls-configuration) @@ -1100,11 +1100,11 @@ curl http://localhost:8080/api/v1/health - Uptime monitoring (Uptime Robot, Pingdom) - Custom monitoring scripts -#### Prometheus Integration (Pro/Enterprise) +#### Prometheus Integration (Enterprise) -Stirling-PDF Pro/Enterprise supports Prometheus metrics for advanced monitoring. +Stirling-PDF Enterprise plan supports Prometheus metrics for advanced monitoring. -**Learn more:** [Usage Monitoring - Prometheus Setup](./Configuration/Usage%20Monitoring.md#prometheus-monitoring-configuration) +**Learn more:** [Usage Monitoring - Prometheus Setup](./Configuration/Usage%20Monitoring#prometheus-monitoring-configuration) **Features:** - JVM metrics (memory, GC, threads) @@ -1193,10 +1193,10 @@ Protect your users' data and configuration with proper backups. **\*Note on User Database:** - **Free edition:** Uses local H2 database (`stirling-pdf.db`) - must be backed up -- **Pro/Enterprise:** Should use external PostgreSQL database (backed up separately) +- **Server/Enterprise:** Should use external PostgreSQL database (backed up separately) -:::tip Pro/Enterprise Recommendation -Pro and Enterprise users should configure an external PostgreSQL database instead of using the local H2 database. This provides better reliability, scalability, and backup capabilities. +:::tip Server/Enterprise Recommendation +Server and Enterprise plan users should configure an external PostgreSQL database instead of using the local H2 database. This provides better reliability, scalability, and backup capabilities. **Learn more:** [External Database Configuration](./Configuration/External%20Database.md) ::: @@ -1430,15 +1430,15 @@ system: - Redis for session storage - CDN for frontend assets -:::tip Pro/Enterprise Recommended -For large organizations, **Pro or Enterprise editions** provide: +:::tip Server/Enterprise Recommended +For large organizations, **Server or Enterprise plans** provide: - Advanced load balancing - High availability configuration - Database clustering - Performance monitoring - Dedicated support -[Learn more](#step-10-proenterprise-edition) +[Learn more](#step-10-paid-plans-serverenterprise) ::: @@ -1482,18 +1482,18 @@ find ./stirling-data/temp -type f -mtime +1 -delete --- -## Step 10: Pro/Enterprise Edition +## Step 10: Paid Plans (Server/Enterprise) -Stirling-PDF offers **Pro and Enterprise editions** with additional features for organizations. +Stirling-PDF offers **Server and Enterprise paid plans** with additional features for organizations. -### Key Pro/Enterprise Features +### Key Paid Plan Features **Authentication & Security:** - **SAML2 SSO:** Enterprise-grade single sign-on (OAuth2 is free) - Enhanced security features **Database & Infrastructure:** -- **External PostgreSQL Database:** Required for Pro/Enterprise deployments +- **External PostgreSQL Database:** Available for Server/Enterprise deployments - Better reliability and scalability than local H2 database - Professional backup and replication strategies @@ -1505,7 +1505,7 @@ Stirling-PDF offers **Pro and Enterprise editions** with additional features for **For pricing and enterprise inquiries:** - **Email:** support@stirlingtools.com - **Website:** https://stirlingtools.com/pricing -- **Documentation:** [Pro/Enterprise Features](./Pro.md) +- **Documentation:** [Paid Offerings](./Paid-Offerings) - **External Database Setup:** [External Database Guide](./Configuration/External%20Database.md) - **Monitoring Setup:** [Usage Monitoring](./Configuration/Usage%20Monitoring.md) @@ -1605,7 +1605,7 @@ Congratulations! You've successfully deployed and configured Stirling-PDF for yo - Search GitHub Issues: https://github.com/Stirling-Tools/Stirling-PDF/issues **For Priority Support:** -- Upgrade to Pro/Enterprise +- Upgrade to Server or Enterprise plan - Email: support@stirlingtools.com - Get dedicated support team @@ -1613,6 +1613,6 @@ Congratulations! You've successfully deployed and configured Stirling-PDF for yo **You're all set!** 🎉 -Your Stirling-PDF deployment is ready for production use. If you have any questions or need assistance, don't hesitate to reach out to our community or consider upgrading to Pro/Enterprise for dedicated support. +Your Stirling-PDF deployment is ready for production use. If you have any questions or need assistance, don't hesitate to reach out to our community or consider upgrading to a paid plan (Server or Enterprise) for dedicated support. Happy PDF processing! 📄✨ diff --git a/docusaurus.config.js b/docusaurus.config.js index 12531671..ed9dc54f 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -1,208 +1,216 @@ -// @ts-check -// Note: type annotations allow type checking and IDEs autocompletion - -import {themes as prismThemes} from 'prism-react-renderer'; - -const allLanguages = ['yaml', 'bash', 'docker', 'java', 'properties', 'json', 'typescript', 'css', 'markdown', 'sql', 'powershell']; - - -/** @type {import('@docusaurus/types').Config} */ -const config = { - title: 'Stirling-PDF', - tagline: 'Your locally hosted one-stop-shop for all your PDF needs.', - favicon: 'img/favicon.ico', - - // Set the production url of your site here - url: 'https://stirlingtools.com', - // Set the // pathname under which your site is served - baseUrl: '/', - - organizationName: 'Stirling-Tools', // Usually your GitHub org/user name. - projectName: 'Stirling-PDF', // Usually your repo name. - - onBrokenLinks: 'throw', - onBrokenMarkdownLinks: 'warn', - - i18n: { - defaultLocale: 'en', - locales: ['en'], - }, - scripts: [ - { - src: 'https://app.termly.io/resource-blocker/aa66d813-045f-4a28-b465-6aab431924d6', - type: 'text/javascript', - attributes: { - autoBlock: 'on' - } - }, - ], - plugins: [ - [ - "posthog-docusaurus", - { - apiKey: "phc_qy9V53BkvTATJESFrSBvg8Rw5m3KvYuTmmk9IojIjyZ", - appUrl: "https://eu.i.posthog.com", // optional, defaults to "https://us.i.posthog.com" - enableInDevelopment: true, // optional - }, - ], - ], - presets: [ - [ - 'classic', - /** @type {import('@docusaurus/preset-classic').Options} */ - ({ - docs: { - sidebarPath: require.resolve('./sidebars.js'), - routeBasePath: '/', - editUrl: 'https://github.com/Stirling-Tools/Stirling-Tools.github.io/tree/main/', - lastVersion: 'current', - versions: { - current: { - label: '2.0 (Current)', - banner: 'none', - badge: false, - }, - '1.5': { - label: '1.6.0', - banner: 'none', - }, - }, - }, - theme: { - customCss: require.resolve('./src/css/custom.css'), - }, - }), - ], - ], - headTags: [ - { - tagName: 'img', - attributes: { - referrerpolicy: 'no-referrer-when-downgrade', - src: 'https://static.scarf.sh/a.png?x-pxid=5d074971-2ecb-4c54-8397-30c0f91896b3', - height: '1', - width: '1', - style: 'display:none', - alt: 'x', - }, - }, - ], - - themeConfig: - /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ - ({ - algolia: { - // The application ID provided by Algolia - appId: 'NJB9CKQAIT', - - // Public API key: it is safe to commit it - apiKey: 'c67f84bf0cdec4d1962ac4e0d65fb4e5', - - indexName: 'stirlingpdf', - - // Optional: see doc section below - contextualSearch: true, - - // Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them. - externalUrlRegex: 'external\\.com|domain\\.com', - - // Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs - replaceSearchResultPathname: { - from: '/docs/', // or as RegExp: /\/docs\// - to: '/', - }, - - // Optional: Algolia search parameters - searchParameters: {}, - - // Optional: path for search page that enabled by default (`false` to disable it) - searchPagePath: 'search', - - // Optional: whether the insights feature is enabled or not on Docsearch (`false` by default) - insights: false, - - //... other Algolia params - }, - - image: 'img/stirling-social-card.png', - navbar: { - title: 'Stirling-PDF', - logo: { - alt: 'Stirling-PDF Logo', - src: 'img/logo.svg', - }, - items: [{ - type: 'docSidebar', - sidebarId: 'tutorialSidebar', - position: 'left', - label: 'Docs', - }, - { - type: 'docsVersionDropdown', - position: 'right', - dropdownActiveClassDisabled: true, - }, - { - href: 'https://github.com/Stirling-Tools/Stirling-PDF', - label: 'GitHub', - position: 'right', - }, - ], - }, - footer: { - style: 'dark', - links: [{ - title: 'Stirling-PDF', - items: [{ - label: 'Homepage', - to: 'https://www.stirlingpdf.com/', - }, { - label: 'Demo', - to: 'https://stirlingpdf.io/', - }], - }, - { - title: 'Community', - items: [{ - label: 'Discord', - href: 'https://discord.gg/Cn8pWhQRxZ', - }, - { - label: 'Docker', - href: 'https://hub.docker.com/r/frooodle/s-pdf', - }, - { - label: 'GitHub', - href: 'https://github.com/Stirling-Tools/Stirling-PDF', - }, - ], - }, - { - title: 'Legal', - items: [ - { - label: 'Privacy Policy', - href: 'https://app.termly.io/policy-viewer/policy.html?policyUUID=09506b8c-1f83-48e2-bf2e-6fce9df4b61b', - }, - { - label: 'Cookie Policy', - href: 'https://app.termly.io/policy-viewer/policy.html?policyUUID=1bedd860-0cb2-49c1-a9dc-bc0886c1f6ca', - }, - { - label: 'Terms & Conditions', - href: 'https://app.termly.io/policy-viewer/policy.html?policyUUID=de68b39f-5e58-4c09-b260-8bdee9b99500', - }, - ], - }, - ], - copyright: `Copyright © ${new Date().getFullYear()} Stirling-PDF, Inc. Built with Docusaurus.`, - }, - prism: { - theme: prismThemes.github, - darkTheme: prismThemes.dracula, - additionalLanguages: allLanguages - }, - }), -}; - -module.exports = config; +// @ts-check +// Note: type annotations allow type checking and IDEs autocompletion + +import {themes as prismThemes} from 'prism-react-renderer'; + +const allLanguages = ['yaml', 'bash', 'docker', 'java', 'properties', 'json', 'typescript', 'css', 'markdown', 'sql', 'powershell']; + + +/** @type {import('@docusaurus/types').Config} */ +const config = { + title: 'Stirling-PDF', + tagline: 'Your locally hosted one-stop-shop for all your PDF needs.', + favicon: 'img/favicon.ico', + + // Set the production url of your site here + url: 'https://stirlingtools.com', + // Set the // pathname under which your site is served + baseUrl: '/', + + organizationName: 'Stirling-Tools', // Usually your GitHub org/user name. + projectName: 'Stirling-PDF', // Usually your repo name. + + onBrokenLinks: 'throw', + onBrokenMarkdownLinks: 'warn', + + i18n: { + defaultLocale: 'en', + locales: ['en'], + }, + scripts: [ + { + src: 'https://app.termly.io/resource-blocker/aa66d813-045f-4a28-b465-6aab431924d6', + type: 'text/javascript', + attributes: { + autoBlock: 'on' + } + }, + ], + plugins: [ + [ + "posthog-docusaurus", + { + apiKey: "phc_qy9V53BkvTATJESFrSBvg8Rw5m3KvYuTmmk9IojIjyZ", + appUrl: "https://eu.i.posthog.com", // optional, defaults to "https://us.i.posthog.com" + enableInDevelopment: true, // optional + }, + ], + ], + clientModules: [ + require.resolve('./src/clientModules/anchorScroll.js'), + ], + presets: [ + [ + 'classic', + /** @type {import('@docusaurus/preset-classic').Options} */ + ({ + docs: { + sidebarPath: require.resolve('./sidebars.js'), + routeBasePath: '/', + editUrl: 'https://github.com/Stirling-Tools/Stirling-Tools.github.io/tree/main/', + lastVersion: 'current', + versions: { + current: { + label: '2.0 (Current)', + banner: 'none', + badge: false, + }, + '1.5': { + label: '1.6.0', + banner: 'none', + }, + }, + }, + theme: { + customCss: require.resolve('./src/css/custom.css'), + }, + }), + ], + ], + headTags: [ + { + tagName: 'img', + attributes: { + referrerpolicy: 'no-referrer-when-downgrade', + src: 'https://static.scarf.sh/a.png?x-pxid=5d074971-2ecb-4c54-8397-30c0f91896b3', + height: '1', + width: '1', + style: 'display:none', + alt: 'x', + }, + }, + ], + + themeConfig: + /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ + ({ + // Improve anchor scrolling behavior + scrollToTop: true, + scrollToTopOptions: { + smooth: true, + }, + algolia: { + // The application ID provided by Algolia + appId: 'NJB9CKQAIT', + + // Public API key: it is safe to commit it + apiKey: 'c67f84bf0cdec4d1962ac4e0d65fb4e5', + + indexName: 'stirlingpdf', + + // Optional: see doc section below + contextualSearch: true, + + // Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them. + externalUrlRegex: 'external\\.com|domain\\.com', + + // Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs + replaceSearchResultPathname: { + from: '/docs/', // or as RegExp: /\/docs\// + to: '/', + }, + + // Optional: Algolia search parameters + searchParameters: {}, + + // Optional: path for search page that enabled by default (`false` to disable it) + searchPagePath: 'search', + + // Optional: whether the insights feature is enabled or not on Docsearch (`false` by default) + insights: false, + + //... other Algolia params + }, + + image: 'img/stirling-social-card.png', + navbar: { + title: 'Stirling-PDF', + logo: { + alt: 'Stirling-PDF Logo', + src: 'img/logo.svg', + }, + items: [{ + type: 'docSidebar', + sidebarId: 'tutorialSidebar', + position: 'left', + label: 'Docs', + }, + { + type: 'docsVersionDropdown', + position: 'right', + dropdownActiveClassDisabled: true, + }, + { + href: 'https://github.com/Stirling-Tools/Stirling-PDF', + label: 'GitHub', + position: 'right', + }, + ], + }, + footer: { + style: 'dark', + links: [{ + title: 'Stirling-PDF', + items: [{ + label: 'Homepage', + to: 'https://www.stirlingpdf.com/', + }, { + label: 'Demo', + to: 'https://stirlingpdf.io/', + }], + }, + { + title: 'Community', + items: [{ + label: 'Discord', + href: 'https://discord.gg/Cn8pWhQRxZ', + }, + { + label: 'Docker', + href: 'https://hub.docker.com/r/frooodle/s-pdf', + }, + { + label: 'GitHub', + href: 'https://github.com/Stirling-Tools/Stirling-PDF', + }, + ], + }, + { + title: 'Legal', + items: [ + { + label: 'Privacy Policy', + href: 'https://app.termly.io/policy-viewer/policy.html?policyUUID=09506b8c-1f83-48e2-bf2e-6fce9df4b61b', + }, + { + label: 'Cookie Policy', + href: 'https://app.termly.io/policy-viewer/policy.html?policyUUID=1bedd860-0cb2-49c1-a9dc-bc0886c1f6ca', + }, + { + label: 'Terms & Conditions', + href: 'https://app.termly.io/policy-viewer/policy.html?policyUUID=de68b39f-5e58-4c09-b260-8bdee9b99500', + }, + ], + }, + ], + copyright: `Copyright © ${new Date().getFullYear()} Stirling-PDF, Inc. Built with Docusaurus.`, + }, + prism: { + theme: prismThemes.github, + darkTheme: prismThemes.dracula, + additionalLanguages: allLanguages + }, + }), +}; + +module.exports = config; diff --git a/src/clientModules/anchorScroll.js b/src/clientModules/anchorScroll.js new file mode 100644 index 00000000..32a784b4 --- /dev/null +++ b/src/clientModules/anchorScroll.js @@ -0,0 +1,12 @@ +// Fix anchor scrolling on client-side navigation +export function onRouteDidUpdate({location}) { + // Small delay to ensure content is rendered + if (location.hash) { + setTimeout(() => { + const element = document.getElementById(location.hash.slice(1)); + if (element) { + element.scrollIntoView({behavior: 'smooth', block: 'start'}); + } + }, 100); + } +}