Skip to content

Commit c8be9db

Browse files
Update .env.example for better clarity
- Revised comments for consistency and improved guidance. - Simplified descriptions for optional variables. - Added note to avoid committing the `.env` file.
1 parent bfa35dd commit c8be9db

1 file changed

Lines changed: 7 additions & 12 deletions

File tree

CPlusPlus/.env.example

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
1-
# Copy to ".env" and set your values.
1+
# pdfRest configuration for C++ samples
2+
# Copy to .env and set your values. Do not commit .env.
23

3-
# Required: pdfRest API key
4+
# Required: API key from https://pdfrest.com/getstarted/
45
PDFREST_API_KEY=your_api_key_here
56

6-
# Optional: API base URL
7-
# - Default (US): https://api.pdfrest.com
8-
# - EU/GDPR region: https://eu-api.pdfrest.com
9-
PDFREST_URL=https://api.pdfrest.com
10-
# For more information visit https://pdfrest.com/pricing#how-do-eu-gdpr-api-calls-work
7+
# Optional: region override for EU/GDPR routing
8+
# PDFREST_URL=https://eu-api.pdfrest.com
119

12-
# Optional: Immediate deletion of sensitive files
13-
# - Default behavior: files are retained per the File Retention Period.
14-
# - Set to true to immediately delete uploaded/generated files in samples that support it.
15-
# Valid values: true|false (case-insensitive)
16-
PDFREST_DELETE_SENSITIVE_FILES=false
10+
# Optional: immediate deletion of uploaded/generated files when supported
11+
# PDFREST_DELETE_SENSITIVE_FILES=true

0 commit comments

Comments
 (0)