Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/Configuration/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)**
Expand Down
4 changes: 2 additions & 2 deletions docs/Configuration/DATABASE.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/Configuration/External Database.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/Configuration/Google Drive File Picker.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/Configuration/Single Sign-On Configuration.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/Configuration/System and Security.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

---

Expand Down Expand Up @@ -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)

---

Expand Down Expand Up @@ -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)

---

Expand Down
4 changes: 2 additions & 2 deletions docs/Configuration/Usage Monitoring.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/Functionality/OCR.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

---

Expand Down
8 changes: 4 additions & 4 deletions docs/Functionality/Security/Certificate-Signing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/Functionality/Security/Security.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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)

---

Expand Down Expand Up @@ -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)

---

Expand Down
26 changes: 13 additions & 13 deletions docs/Functionality/Security/Sign.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

---

Expand All @@ -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)

---

Expand Down Expand Up @@ -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)

---

Expand Down Expand Up @@ -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 |
Expand All @@ -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
Expand Down Expand Up @@ -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)

---

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

---

Expand All @@ -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.
4 changes: 2 additions & 2 deletions docs/Getting Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading