Skip to content

Commit 372daf4

Browse files
authored
fixes (#95)
* init * Update Mac.md
1 parent 26cf85d commit 372daf4

File tree

11 files changed

+38
-34
lines changed

11 files changed

+38
-34
lines changed

docs/Analytics-and-telemetry.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,6 @@ system:
214214

215215
**Docker Compose example**
216216
```yaml
217-
version: '3.8'
218217
services:
219218
stirling-pdf:
220219
environment:

docs/Configuration/Single Sign-On Configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ for Google and GitHub can be found [here](https://developers.google.com/identity
109109
[here](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes)
110110
- `security.oauth2.provider`: The name of the Provider
111111

112-
The Callback URL (Redirect URL) for entering in your IdP is: `https://<striling-pdf.yourdomain>/login/oauth2/code/<oidc-provider>` eg `https://<striling-pdf.yourdomain>/login/oauth2/code/keycloak`.
112+
The Callback URL (Redirect URL) for entering in your IdP is: `https://<striling-pdf.yourdomain>/login/oauth2/code/<oidc-provider>` eg `https://<striling-pdf.yourdomain>/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`).
113113
It is highly recommended to use an SSL-enabled reverse-proxy, if the application is going to be exposed to the internet.
114114

115115
After the OAuth 2 login is enabled, a new button will show up on the login page as per the screenshot below. Clicking the

docs/Configuration/System and Security.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ If migrating from V1, note these setting name changes:
282282

283283
## Email Configuration
284284

285-
Configure SMTP for sending email invitations and notifications.
285+
Configure SMTP for sending email invitations and notifications. Enable `mail.enableInvites` to allow invitation links.
286286

287287
### Email Invites
288288

@@ -291,7 +291,8 @@ Enable email-based user invitations:
291291
```yaml
292292
mail:
293293
enabled: true
294-
enableInvites: true # Enable email invitations
294+
from: noreply@example.com
295+
enableInvites: true
295296
smtp:
296297
host: smtp.example.com
297298
port: 587
@@ -304,16 +305,18 @@ mail:
304305
**Environment Variables:**
305306
```bash
306307
MAIL_ENABLED=true
308+
MAIL_FROM=noreply@example.com
307309
MAIL_ENABLEINVITES=true
308-
MAIL_SMTP_HOST=smtp.gmail.com
309-
MAIL_SMTP_PORT=587
310-
MAIL_SMTP_USERNAME=your-email@gmail.com
311-
MAIL_SMTP_PASSWORD=your-app-password
312-
MAIL_SMTP_TLS_ENABLED=true
310+
MAIL_HOST=smtp.gmail.com
311+
MAIL_PORT=587
312+
MAIL_USERNAME=your-email@gmail.com
313+
MAIL_PASSWORD=your-app-password
314+
MAIL_TLS_ENABLED=true
313315
```
314316

315317
**Requirements:**
316318
- `mail.enabled: true`
319+
- `mail.enableInvites: true` for invitation flows
317320
- `security.enableLogin: true`
318321
- Valid SMTP configuration
319322
- `system.frontendUrl` configured (for invite links)

docs/FAQ.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,7 @@ All endpoints provide the same functionality.
4040

4141
No, we track no data without your explicit consent. You can see how, when, and why at our [Analytics and Telemetry](./analytics-telemetry) page.
4242

43+
### Q9: When I upload a file, where is it processed?
44+
45+
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.
46+

docs/Installation/Docker Install.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ docker run -d \
2929
Create `docker-compose.yml`:
3030

3131
```yaml
32-
version: '3.3'
3332
services:
3433
stirling-pdf:
3534
image: stirlingtools/stirling-pdf:latest
@@ -163,7 +162,6 @@ docker run -d \
163162
Create `docker-compose.yml`:
164163

165164
```yaml
166-
version: '3.3'
167165
services:
168166
stirling-pdf:
169167
image: stirlingtools/stirling-pdf:latest
@@ -208,7 +206,6 @@ Want to scale frontend and backend independently? Use this:
208206
Create `docker-compose.yml`:
209207

210208
```yaml
211-
version: '3.3'
212209
services:
213210
# Backend - PDF processing engine
214211
stirling-backend:

docs/Installation/Mac.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@ Stirling PDF for Mac is available as a **native desktop application** or can run
1414
### What You Get
1515

1616
-**Native macOS application** - Optimized for both Apple Silicon and Intel Macs
17-
-**Open PDFs directly** - Double-click any PDF to open in Stirling-PDF
18-
-**Works completely offline** - No internet required after installation
17+
-**Sign in to start** - Choose Stirling Cloud or your self-hosted server on launch (required before using tools)
18+
-**Processes files locally after login** - Most tools run offline once signed in
19+
-**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
1920
-**All features included** - Every PDF tool available
2021
-**Better performance** - Native speed on M1/M2/M3 chips
21-
-**No browser needed** - Standalone application
22+
-**No external browser needed** - Uses the built-in window
2223
-**Menu bar integration** - Feels like a native Mac app
2324

2425
### Installation Steps
@@ -62,11 +63,9 @@ The app will now open normally every time!
6263

6364
### Using the Desktop App
6465

65-
**Opening PDFs:**
66-
- **Double-click any PDF file** - Opens in Stirling-PDF
67-
- **Right-click → Open With → Stirling-PDF**
68-
- **Drag and drop** files into the application
69-
- **File → Open** from the menu bar
66+
1. Launch Stirling-PDF
67+
2. Sign in with your Stirling Cloud account or enter the URL for your self-hosted server.
68+
3. After login, use the in-app interface to upload or drag-and-drop files into the window.
7069

7170
**Making Stirling-PDF your default PDF viewer:**
7271
1. Right-click (or Control+click) any PDF file

docs/Migration/New-Features.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -595,7 +595,7 @@ security:
595595
```yaml
596596
mail:
597597
enabled: true
598-
enableInvites: true # NEW in V2
598+
from: noreply@example.com
599599
smtp:
600600
host: smtp.example.com
601601
port: 587
@@ -627,11 +627,13 @@ mail:
627627

628628
```bash
629629
MAIL_ENABLED=true
630+
MAIL_FROM=noreply@example.com
630631
MAIL_ENABLEINVITES=true
631-
MAIL_SMTP_HOST=smtp.gmail.com
632-
MAIL_SMTP_PORT=587
633-
MAIL_SMTP_USERNAME=your-email@gmail.com
634-
MAIL_SMTP_PASSWORD=your-app-password
632+
MAIL_HOST=smtp.gmail.com
633+
MAIL_PORT=587
634+
MAIL_USERNAME=your-email@gmail.com
635+
MAIL_PASSWORD=your-app-password
636+
MAIL_TLS_ENABLED=true
635637
```
636638

637639
---

docs/Migration/Settings-Changes.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,8 @@ SECURITY_JWT_PERSISTENCE=true
298298
SECURITY_JWT_ENABLEKEYROTATION=true
299299
SECURITY_JWT_ENABLEKEYCLEANUP=true
300300
301-
# Email invites
301+
# Email configuration
302+
MAIL_FROM=noreply@example.com
302303
MAIL_ENABLEINVITES=true
303304
304305
# Logo

docs/Server-Admin-Onboarding.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,6 @@ cd ~/stirling-pdf
140140
Create `docker-compose.yml` with this production-ready configuration:
141141

142142
```yaml
143-
version: '3.3'
144143

145144
services:
146145
stirling-pdf:
@@ -488,6 +487,7 @@ If you configure email, admins can send invitation links instead.
488487
```yaml
489488
mail:
490489
enabled: true
490+
from: noreply@yourcompany.com
491491
enableInvites: true
492492
smtp:
493493
host: smtp.gmail.com
@@ -503,12 +503,13 @@ mail:
503503

504504
```bash
505505
MAIL_ENABLED=true
506+
MAIL_FROM=noreply@yourcompany.com
506507
MAIL_ENABLEINVITES=true
507-
MAIL_SMTP_HOST=smtp.gmail.com
508-
MAIL_SMTP_PORT=587
509-
MAIL_SMTP_USERNAME=noreply@yourcompany.com
510-
MAIL_SMTP_PASSWORD=your-app-password
511-
MAIL_SMTP_TLS_ENABLED=true
508+
MAIL_HOST=smtp.gmail.com
509+
MAIL_PORT=587
510+
MAIL_USERNAME=noreply@yourcompany.com
511+
MAIL_PASSWORD=your-app-password
512+
MAIL_TLS_ENABLED=true
512513
```
513514

514515
</TabItem>

versioned_docs/version-1.5/Analytics-and-telemetry.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,6 @@ system:
214214

215215
**Docker Compose example**
216216
```yaml
217-
version: '3.8'
218217
services:
219218
stirling-pdf:
220219
environment:

0 commit comments

Comments
 (0)