How stirling-tools/stirling-pdf works
Stirling PDF is an open-source PDF editing platform for browser, desktop, and self-hosted use. Its principal workflow is submitting documents to a PDF tool or pipeline and receiving processed files; the sampled pipeline controller shows input preparation, pipeline execution, and single-file or ZIP responses. The README also documents editing, signing, redaction, conversion, OCR, REST APIs, and no-code workflows. Several of those capabilities are represented at directory level because their implementation was not sampled; those relationships are documented rather than inferred from imports.
Main entry points: PipelineController.java Pipeline API · api PDF tools · StorageEncryptionMigrationService.java Storage encryption · service PDF services
Components 18
PDF processing
- Pipeline API
app/core/src/main/java/stirling/software/SPDF/controller/api/pipeline/PipelineController.java - Pipeline processor
app/core/src/main/java/stirling/software/SPDF/controller/api/pipeline - PDF tools
app/core/src/main/java/stirling/software/SPDF/controller/api - PDF JSON conversion
app/core/src/main/java/stirling/software/SPDF/service/PdfJsonConversionService.java - PDF services
app/common/src/main/java/stirling/software/common/service
Automation
- Workflow UI
frontend/editor/src/proprietary/components/policies/useEditorPipelines.ts - Workflow sessions
app/proprietary/src/main/java/stirling/software/proprietary/workflow/service/WorkflowSessionService.java
Enterprise services
- Accounts and teams
app/proprietary/src/main/java/stirling/software/proprietary/security/model/User.java - File storage
app/proprietary/src/main/java/stirling/software/proprietary/storage/service/FileStorageService.java - Storage backend
app/proprietary/src/main/java/stirling/software/proprietary/storage/provider/StorageProvider.java - Storage encryption
app/proprietary/src/main/java/stirling/software/proprietary/storage/service/StorageEncryptionMigrationService.java - Audit service
app/proprietary/src/main/java/stirling/software/proprietary/service/AuditService.java - Usage billing
app/saas/src/main/java/stirling/software/saas/payg/instance/InstanceUsageIngestService.java
Platform services
- Temporary files
app/common/src/main/java/stirling/software/common/util/TempFileManager.java - REST API
app/core/src/main/java/stirling/software/SPDF/controller/api - Application configuration
app/common/src/main/java/stirling/software/common/model/ApplicationProperties.java - Process execution
app/common/src/main/java/stirling/software/common/util/ProcessExecutor.java
Other components
- PDF user
Connections 16
- PDF user → Pipeline API: submits documents
README.md - Pipeline API → Pipeline processor: runs pipeline
app/core/src/main/java/stirling/software/SPDF/controller/api/pipeline/PipelineController.java - Pipeline API → PDF user: returns files
app/core/src/main/java/stirling/software/SPDF/controller/api/pipeline/PipelineController.java - PDF user → PDF tools: uses PDF tools
README.md - PDF user → REST API: integrates by API
README.md - PDF user → Workflow UI: configures workflows
README.md - PDF user → Workflow sessions: signs documents
README.md - PDF user → File storage: manages files
- File storage → Storage backend: stores objects
app/proprietary/src/main/java/stirling/software/proprietary/storage/service/FileStorageService.java - Storage encryption → Storage backend: migrates blobs
app/proprietary/src/main/java/stirling/software/proprietary/storage/service/StorageEncryptionMigrationService.java - Storage encryption → Audit service: records events
app/proprietary/src/main/java/stirling/software/proprietary/storage/service/StorageEncryptionMigrationService.java - Pipeline API → Temporary files: creates temp files
app/core/src/main/java/stirling/software/SPDF/controller/api/pipeline/PipelineController.java - PDF tools → PDF services: uses PDF services
app/core/src/main/java/stirling/software/SPDF/controller/api/pipeline/PipelineController.java - PDF tools → PDF JSON conversion: converts PDF data
- PDF services → Process execution: runs external tools
- PDF user → Usage billing: incurs usage charges
app/saas/src/main/java/stirling/software/saas/payg/instance/InstanceUsageIngestService.java