Skip to main content
Version: 10.0

LOCAL Provider

The LOCAL provider uses the local filesystem for storing documents, files, and sessions. This is the default provider and requires no additional configuration.

note

This is the default provider for all webPDF Server deployments in standalone mode (no cluster). It is automatically used when no provider.json is present.

Overview​

  • Provider Name: LOCAL
  • Supports: Document Storage, File Storage, Session Storage
  • Configuration File: None required
  • Use Case: Development, small deployments, single-server installations

Features​

  • ✓ Zero configuration required
  • ✓ Fast access for single-server deployments
  • ✓ No external dependencies
  • ✗ No file persistence across server restarts
  • ✗ Not suitable for cluster/multi-node deployments
  • ✗ Limited scalability

Configuration​

provider.json​

{
  "documentStorage": {
    "name": "LOCAL"
  },
  "fileStorage": {
    "name": "LOCAL"
  },
  "sessionStorage": {
    "name": "LOCAL"
  }
}

No additional configuration file is needed for the LOCAL provider.

Storage Locations​

The LOCAL provider stores data in the local directories of the server and in its local memory:

  • Document storage: local memory
  • File storage: local temp/ folder of the server (server directories)
  • Session storage: local memory
tip

For cluster deployments, use distributed storage providers like REDIS, VALKEY, MINIO, AZURE_BLOB, or SMB instead of LOCAL.

Environment Variables​

# Document storage
WEBPDF_PROVIDER_SETTINGS_DOCUMENT_STORAGE_NAME=LOCAL

# File storage
WEBPDF_PROVIDER_SETTINGS_FILE_STORAGE_NAME=LOCAL

# Session storage
WEBPDF_PROVIDER_SETTINGS_SESSION_STORAGE_NAME=LOCAL

Advantages​

  1. Simple Setup – No configuration required
  2. Performance – Direct filesystem access is fast
  3. No Dependencies – No external services needed
  4. Easy Debugging – Direct file access for troubleshooting

Limitations​

  1. Single Server Only – Cannot be shared across cluster nodes
  2. No High Availability – Single point of failure
  3. Limited Scalability – Bounded by local disk capacity
  4. Backup Complexity – Requires filesystem-level backup

When to Use​

Use the LOCAL provider when:

  • Running a single webPDF Server instance
  • Developing or testing locally
  • Small-scale deployments with no clustering requirements
  • Network storage is not available or desired

When NOT to Use​

Avoid the LOCAL provider when:

  • Running in a cluster configuration with multiple nodes
  • High availability is required
  • Horizontal scaling is needed
  • Storage needs to be shared across multiple servers