Skip to content

feat(env): added more optional env var examples - #2138

Merged
waleedlatif1 merged 1 commit into
stagingfrom
feat/envexample
Nov 30, 2025
Merged

feat(env): added more optional env var examples#2138
waleedlatif1 merged 1 commit into
stagingfrom
feat/envexample

Conversation

@waleedlatif1

Copy link
Copy Markdown
Collaborator

Summary

  • added more optional env var examples

Type of Change

  • New feature

Testing

Tested manually

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

@vercel

vercelBot commented Nov 30, 2025

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
ProjectDeploymentPreviewCommentsUpdated (UTC)
docsSkippedSkippedNov 30, 2025 5:13pm

@waleedlatif1
waleedlatif1 merged commit 08d57b4 into stagingNov 30, 2025
5 checks passed
@waleedlatif1
waleedlatif1 deleted the feat/envexample branch November 30, 2025 17:13
@greptile-apps

Copy link
Copy Markdown
Contributor

Greptile Overview

Greptile Summary

Added API_ENCRYPTION_KEY environment variable example to the .env.example file in the Security section.

  • The variable is correctly documented with usage instructions (openssl rand -hex 32) and purpose (encrypting API keys)
  • The implementation is already present in the codebase (apps/sim/lib/api-key/crypto.ts and apps/sim/lib/env.ts)
  • The variable is properly marked as optional in the schema validation
  • Placement in the Security section is appropriate and follows existing patterns

Confidence Score: 5/5

  • This PR is safe to merge with no risk
  • This is a documentation-only change that adds an example for an optional environment variable that is already implemented and validated in the codebase. The variable is properly documented with generation instructions and usage context. No code logic is affected.
  • No files require special attention

Important Files Changed

File Analysis

FilenameScoreOverview
apps/sim/.env.example5/5Added API_ENCRYPTION_KEY example to security section for encrypting API keys

Sequence Diagram

sequenceDiagram
participant Dev as Developer
participant Env as .env.example
participant EnvFile as .env File
participant EnvSchema as lib/env.ts
participant Crypto as lib/api-key/crypto.ts
participant DB as Database
Dev->>Env: Review environment variable examples
Note over Env: API_ENCRYPTION_KEY example<br/>with generation instructions
Dev->>EnvFile: Create/update local env file
Dev->>EnvFile: Add generated encryption key
Note over EnvSchema: Validate API_ENCRYPTION_KEY<br/>(optional, min 32 chars)
EnvSchema->>EnvFile: Load and validate environment
alt Encryption key is configured
Crypto->>EnvSchema: Read encryption key
Crypto->>Crypto: Encrypt API keys using AES-256-GCM
Crypto->>DB: Store encrypted API keys
else Encryption key not configured
Note over Crypto: Log warning about plain text storage
Crypto->>DB: Store plain text API keys
end
Loading

@greptile-appsgreptile-appsBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

waleedlatif1 added a commit that referenced this pull request Dec 1, 2025
… sendgrid, linkedin, more tools (#2148)
* feat(tools): added smtp, sendgrid, mailgun, linkedin, fixed permissions in context menu (#2133)
* feat(tools): added twilio sendgrid integration
* feat(tools): added smtp, sendgrid, mailgun, fixed permissions in context menu
* added top level mocks for sporadically failing tests
* incr type safety
* fix(team-plans): track departed member usage so value not lost (#2118)
* fix(team-plans): track departed member usage so value not lost
* reset usage to 0 when they leave team
* prep merge with stagig
* regen migrations
* fix org invite + ws selection'
---------
Co-authored-by: Waleed <walif6@gmail.com>
* feat(i18n): update translations (#2134)
Co-authored-by: waleedlatif1 <waleedlatif1@users.noreply.github.com>
* feat(creators): add verification for creators (#2135)
* feat(tools): added apify block/tools (#2136)
* feat(tools): added apify
* cleanup
* feat(i18n): update translations (#2137)
Co-authored-by: waleedlatif1 <waleedlatif1@users.noreply.github.com>
* feat(env): added more optional env var examples (#2138)
* feat(statuspage): added statuspage, updated list of tools in footer, renamed routes (#2139)
* feat(statuspage): added statuspage, updated list of tools in footer, renamed routes
* ack PR comments
* feat(tools): add generic search tool (#2140)
* feat(i18n): update translations (#2141)
* fix(sdks): bump sdk versions (#2142)
* fix(webhooks): count test webhooks towards usage limit (#2143)
* fix(bill): add requestId to webhook processing (#2144)
* improvement(subflow): remove all associated edges when moving a block into a subflow (#2145)
* improvement(subflow): remove all associated edges when moving a block into a subflow
* ack PR comments
* fix(polling): mark webhook failed on webhook trigger errors (#2146)
* fix(deps): declare core transient deps explicitly (#2147)
* fix(deps): declare core transient deps explicitly
* ack PR comments
---------
Co-authored-by: Vikhyath Mondreti <vikhyathvikku@gmail.com>
Co-authored-by: waleedlatif1 <waleedlatif1@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@waleedlatif1