fix: Update env example files with required vars (#379)

apps/open-swe/.env.example

@@ -1,23 +1,52 @@
 # ------------------LangSmith tracing------------------
 LANGCHAIN_PROJECT="default"
-LANGCHAIN_API_KEY=""
+LANGCHAIN_API_KEY="lsv2_pt_..."
-LANGCHAIN_TRACING_V2=true
+LANGCHAIN_TRACING_V2="true"
-# -----------------------------------------------------
+# Set to true when ready to run evals, _and_ have the results uploaded to LangSmith.
+# If false, evals will still run, but results will not be saved in LangSmith.
+LANGCHAIN_TEST_TRACKING="false"
 
-# Defaults to Anthropic models, OpenAI & Google keys are optional, unless using those models
+
+# ------------------LLM Provider Keys------------------
+# Defaults to Anthropic models.
 ANTHROPIC_API_KEY=""
 OPENAI_API_KEY=""
 GOOGLE_API_KEY=""
 
-# Daytona API key for accessing and modifying the code in the cloud sandbox.
+
+# ------------------Infrastructure---------------------
+# Daytona API key for creating & accessing the cloud sandbox.
 DAYTONA_API_KEY=""
 
+
+# ------------------------Tools------------------------
+# Firecrawl API key for calling the get URL contents tool.
+FIRECRAWL_API_KEY=""
+
+
+# ------------------Github App Secrets-----------------
 # Encryption key for GitHub tokens (32-byte hex string for AES-256)
-# Should be the same value as the one used in the web app.
+# Should be the same value as the one used in the web app, so that tokens
+# encrypted in the web app can be decrypted in the agent.
 GITHUB_TOKEN_ENCRYPTION_KEY=""
 # Used for setting the git user name & email for commits.
+# Can modify to whatever string you want.
 GITHUB_APP_NAME="open-swe-dev"
+GITHUB_APP_ID=""
+# App secret key. Should be multi-line.
+GITHUB_APP_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
+...add your private key here...
+-----END RSA PRIVATE KEY-----
+"
+# Secret key for verifying GitHub webhook events.
+GITHUB_WEBHOOK_SECRET=""
 
+
+# ------------------------Other------------------------
 # Defaults to 2024 if not set.
 # LGP will automatically set this for you in production.
-# PORT="2024"
+PORT="2024"
+# Used to create a run URL when replying to a GitHub issue comment.
+# Should be the URL of the web app. Localhost in dev, production URL
+# in production.
+OPEN_SWE_APP_URL="http://localhost:3000"

apps/web/.env.example

@@ -1,18 +1,33 @@
-# Change both to production URLs when deployed
+# ------------------Github App Secrets-----------------
-NEXT_PUBLIC_API_URL="http://localhost:3000/api"
+# GitHub app client secrets. Used for the GitHub OAuth login flow.
-LANGGRAPH_API_URL="http://localhost:2024"
-NEXT_PUBLIC_ASSISTANT_ID="open-swe"
-
-# For the GitHub OAuth flow
 GITHUB_APP_CLIENT_ID=""
 GITHUB_APP_CLIENT_SECRET=""
+# Should be updated to your production URL when deployed.
+# This value should match the redirect URL you have configured in
+# your GitHub app settings.
 GITHUB_APP_REDIRECT_URI="http://localhost:3000/api/auth/github/callback"
 
+# Encryption key for GitHub tokens (32-byte hex string for AES-256)
+# Should be the same value as the one used in the web app, so that tokens
+# encrypted in the web app can be decrypted in the agent.
+GITHUB_TOKEN_ENCRYPTION_KEY=""
+# Used for setting the git user name & email for commits.
+# Can modify to whatever string you want.
 GITHUB_APP_NAME="open-swe-dev"
 GITHUB_APP_ID=""
-GITHUB_APP_PRIVATE_KEY=""
+# App secret key. Should be multi-line.
+GITHUB_APP_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
+...add your private key here...
+-----END RSA PRIVATE KEY-----
+"
+# Secret key for verifying GitHub webhook events.
+GITHUB_WEBHOOK_SECRET=""
 
-# Encryption key for GitHub tokens (32-byte hex string for AES-256)
+
-# Should be the same value as the one used in the open-swe app.
+# ------------------------Other------------------------
-# Can be generated via: `openssl rand -hex 32`
+# The API URL of the proxy route in the Next.js app. This route forwards
-GITHUB_TOKEN_ENCRYPTION_KEY=""
+# requests to the LangGraph server, injecting some secrets.
+NEXT_PUBLIC_API_URL="http://localhost:3000/api"
+# The API URL of the LangGraph server. Used in the proxy route to forward
+# requests to the LangGraph server.
+LANGGRAPH_API_URL="http://localhost:2024"