diff --git a/docs/Analytics-and-telemetry.md b/docs/Analytics-and-telemetry.md index 03628b4..0ddaeb2 100644 --- a/docs/Analytics-and-telemetry.md +++ b/docs/Analytics-and-telemetry.md @@ -214,7 +214,6 @@ system: **Docker Compose example** ```yaml -version: '3.8' services: stirling-pdf: environment: diff --git a/docs/Configuration/Single Sign-On Configuration.md b/docs/Configuration/Single Sign-On Configuration.md index 7b7410b..02ba969 100644 --- a/docs/Configuration/Single Sign-On Configuration.md +++ b/docs/Configuration/Single Sign-On Configuration.md @@ -109,7 +109,7 @@ for Google and GitHub can be found [here](https://developers.google.com/identity [here](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes) - `security.oauth2.provider`: The name of the Provider -The Callback URL (Redirect URL) for entering in your IdP is: `https:///login/oauth2/code/` eg `https:///login/oauth2/code/keycloak`. +The Callback URL (Redirect URL) for entering in your IdP is: `https:///login/oauth2/code/` eg `https:///login/oauth2/code/keycloak`. If you previously used a bare `/login/oauth2/code/` callback, make sure you now include the provider slug (for example, Authentik uses `/login/oauth2/code/authentik`). It is highly recommended to use an SSL-enabled reverse-proxy, if the application is going to be exposed to the internet. After the OAuth 2 login is enabled, a new button will show up on the login page as per the screenshot below. Clicking the diff --git a/docs/Configuration/System and Security.md b/docs/Configuration/System and Security.md index 66c8db0..a38fc74 100644 --- a/docs/Configuration/System and Security.md +++ b/docs/Configuration/System and Security.md @@ -282,7 +282,7 @@ If migrating from V1, note these setting name changes: ## Email Configuration -Configure SMTP for sending email invitations and notifications. +Configure SMTP for sending email invitations and notifications. Enable `mail.enableInvites` to allow invitation links. ### Email Invites @@ -291,7 +291,8 @@ Enable email-based user invitations: ```yaml mail: enabled: true - enableInvites: true # Enable email invitations + from: noreply@example.com + enableInvites: true smtp: host: smtp.example.com port: 587 @@ -304,16 +305,18 @@ mail: **Environment Variables:** ```bash MAIL_ENABLED=true +MAIL_FROM=noreply@example.com MAIL_ENABLEINVITES=true -MAIL_SMTP_HOST=smtp.gmail.com -MAIL_SMTP_PORT=587 -MAIL_SMTP_USERNAME=your-email@gmail.com -MAIL_SMTP_PASSWORD=your-app-password -MAIL_SMTP_TLS_ENABLED=true +MAIL_HOST=smtp.gmail.com +MAIL_PORT=587 +MAIL_USERNAME=your-email@gmail.com +MAIL_PASSWORD=your-app-password +MAIL_TLS_ENABLED=true ``` **Requirements:** - `mail.enabled: true` +- `mail.enableInvites: true` for invitation flows - `security.enableLogin: true` - Valid SMTP configuration - `system.frontendUrl` configured (for invite links) diff --git a/docs/FAQ.md b/docs/FAQ.md index 549cde9..e7ba66e 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -40,3 +40,7 @@ All endpoints provide the same functionality. No, we track no data without your explicit consent. You can see how, when, and why at our [Analytics and Telemetry](./analytics-telemetry) page. +### Q9: When I upload a file, where is it processed? + +Uploads go to the server or desktop instance you're using, not to Stirling servers. The macOS/Windows desktop apps process files locally—even when you pick the Stirling Cloud sign-in today—so your PDFs stay on your device unless you point the app to a remote self-hosted server. Planned SaaS-assisted features (for desktop app) will be opt-in when they arrive. + diff --git a/docs/Installation/Docker Install.md b/docs/Installation/Docker Install.md index 6f53af3..a2cb913 100644 --- a/docs/Installation/Docker Install.md +++ b/docs/Installation/Docker Install.md @@ -29,7 +29,6 @@ docker run -d \ Create `docker-compose.yml`: ```yaml -version: '3.3' services: stirling-pdf: image: stirlingtools/stirling-pdf:latest @@ -163,7 +162,6 @@ docker run -d \ Create `docker-compose.yml`: ```yaml -version: '3.3' services: stirling-pdf: image: stirlingtools/stirling-pdf:latest @@ -208,7 +206,6 @@ Want to scale frontend and backend independently? Use this: Create `docker-compose.yml`: ```yaml -version: '3.3' services: # Backend - PDF processing engine stirling-backend: diff --git a/docs/Installation/Mac.md b/docs/Installation/Mac.md index 8583da2..dfc817f 100644 --- a/docs/Installation/Mac.md +++ b/docs/Installation/Mac.md @@ -14,11 +14,12 @@ Stirling PDF for Mac is available as a **native desktop application** or can run ### What You Get - ✅ **Native macOS application** - Optimized for both Apple Silicon and Intel Macs -- ✅ **Open PDFs directly** - Double-click any PDF to open in Stirling-PDF -- ✅ **Works completely offline** - No internet required after installation +- ✅ **Sign in to start** - Choose Stirling Cloud or your self-hosted server on launch (required before using tools) +- ✅ **Processes files locally after login** - Most tools run offline once signed in +- ✅ **Stirling Cloud login is offline-only today** - SaaS sign-in keeps processing on your Mac; optional cloud assists for advanced tasks are planned for a future release - ✅ **All features included** - Every PDF tool available - ✅ **Better performance** - Native speed on M1/M2/M3 chips -- ✅ **No browser needed** - Standalone application +- ✅ **No external browser needed** - Uses the built-in window - ✅ **Menu bar integration** - Feels like a native Mac app ### Installation Steps @@ -62,11 +63,9 @@ The app will now open normally every time! ### Using the Desktop App -**Opening PDFs:** -- **Double-click any PDF file** - Opens in Stirling-PDF -- **Right-click → Open With → Stirling-PDF** -- **Drag and drop** files into the application -- **File → Open** from the menu bar +1. Launch Stirling-PDF +2. Sign in with your Stirling Cloud account or enter the URL for your self-hosted server. +3. After login, use the in-app interface to upload or drag-and-drop files into the window. **Making Stirling-PDF your default PDF viewer:** 1. Right-click (or Control+click) any PDF file diff --git a/docs/Migration/New-Features.md b/docs/Migration/New-Features.md index 6335bfd..7b30998 100644 --- a/docs/Migration/New-Features.md +++ b/docs/Migration/New-Features.md @@ -595,7 +595,7 @@ security: ```yaml mail: enabled: true - enableInvites: true # NEW in V2 + from: noreply@example.com smtp: host: smtp.example.com port: 587 @@ -627,11 +627,13 @@ mail: ```bash MAIL_ENABLED=true +MAIL_FROM=noreply@example.com MAIL_ENABLEINVITES=true -MAIL_SMTP_HOST=smtp.gmail.com -MAIL_SMTP_PORT=587 -MAIL_SMTP_USERNAME=your-email@gmail.com -MAIL_SMTP_PASSWORD=your-app-password +MAIL_HOST=smtp.gmail.com +MAIL_PORT=587 +MAIL_USERNAME=your-email@gmail.com +MAIL_PASSWORD=your-app-password +MAIL_TLS_ENABLED=true ``` --- diff --git a/docs/Migration/Settings-Changes.md b/docs/Migration/Settings-Changes.md index e18c9ee..21de320 100644 --- a/docs/Migration/Settings-Changes.md +++ b/docs/Migration/Settings-Changes.md @@ -298,7 +298,8 @@ SECURITY_JWT_PERSISTENCE=true SECURITY_JWT_ENABLEKEYROTATION=true SECURITY_JWT_ENABLEKEYCLEANUP=true -# Email invites +# Email configuration +MAIL_FROM=noreply@example.com MAIL_ENABLEINVITES=true # Logo diff --git a/docs/Server-Admin-Onboarding.md b/docs/Server-Admin-Onboarding.md index 115082a..fdab960 100644 --- a/docs/Server-Admin-Onboarding.md +++ b/docs/Server-Admin-Onboarding.md @@ -140,7 +140,6 @@ cd ~/stirling-pdf Create `docker-compose.yml` with this production-ready configuration: ```yaml -version: '3.3' services: stirling-pdf: @@ -488,6 +487,7 @@ If you configure email, admins can send invitation links instead. ```yaml mail: enabled: true + from: noreply@yourcompany.com enableInvites: true smtp: host: smtp.gmail.com @@ -503,12 +503,13 @@ mail: ```bash MAIL_ENABLED=true +MAIL_FROM=noreply@yourcompany.com MAIL_ENABLEINVITES=true -MAIL_SMTP_HOST=smtp.gmail.com -MAIL_SMTP_PORT=587 -MAIL_SMTP_USERNAME=noreply@yourcompany.com -MAIL_SMTP_PASSWORD=your-app-password -MAIL_SMTP_TLS_ENABLED=true +MAIL_HOST=smtp.gmail.com +MAIL_PORT=587 +MAIL_USERNAME=noreply@yourcompany.com +MAIL_PASSWORD=your-app-password +MAIL_TLS_ENABLED=true ``` diff --git a/versioned_docs/version-1.5/Analytics-and-telemetry.md b/versioned_docs/version-1.5/Analytics-and-telemetry.md index 758fcd5..52445fd 100644 --- a/versioned_docs/version-1.5/Analytics-and-telemetry.md +++ b/versioned_docs/version-1.5/Analytics-and-telemetry.md @@ -214,7 +214,6 @@ system: **Docker Compose example** ```yaml -version: '3.8' services: stirling-pdf: environment: diff --git a/versioned_docs/version-1.5/Installation/Docker Install.md b/versioned_docs/version-1.5/Installation/Docker Install.md index 53eec78..2a74249 100644 --- a/versioned_docs/version-1.5/Installation/Docker Install.md +++ b/versioned_docs/version-1.5/Installation/Docker Install.md @@ -36,7 +36,6 @@ docker run -d \ - `docker-compose.yml` ```yaml -version: '3.3' services: stirling-pdf: image: docker.stirlingpdf.com/stirlingtools/stirling-pdf:latest