mirror of
https://github.com/langchain-ai/open-canvas.git
synced 2026-07-01 19:55:05 -04:00
fix: Proper env.example files and documentation
This commit is contained in:
bracesproul
+28
-40
@@ -1,45 +1,33 @@
|
||||
# This file should contain secrets which are used inside the agent (apps/agents)
|
||||
|
||||
# LangSmith tracing
|
||||
# Set this to `false` to disable tracing to LangSmith
|
||||
LANGCHAIN_TRACING_V2=true
|
||||
LANGCHAIN_API_KEY=
|
||||
LANGCHAIN_TRACING_V2="true"
|
||||
LANGCHAIN_API_KEY=""
|
||||
# Optional, unless using a non default project
|
||||
# LANGCHAIN_PROJECT=""
|
||||
|
||||
# LLM API keys
|
||||
# Anthropic used for reflection
|
||||
ANTHROPIC_API_KEY=
|
||||
# OpenAI used for content generation
|
||||
OPENAI_API_KEY=
|
||||
# Optional, only required if using `Gemini 1.5 Flash` as the model.
|
||||
GOOGLE_API_KEY=
|
||||
# Optional, only required if using `Fireworks` as the model.
|
||||
FIREWORKS_API_KEY=
|
||||
# ---LLM API Keys---
|
||||
|
||||
# Feature flags for hiding/showing specific models
|
||||
NEXT_PUBLIC_FIREWORKS_ENABLED=true
|
||||
NEXT_PUBLIC_GEMINI_ENABLED=true
|
||||
NEXT_PUBLIC_ANTHROPIC_ENABLED=true
|
||||
NEXT_PUBLIC_OPENAI_ENABLED=true
|
||||
# Set to false by default since the base OpenAI API is more common than the Azure OpenAI API.
|
||||
NEXT_PUBLIC_AZURE_ENABLED=false
|
||||
NEXT_PUBLIC_OLLAMA_ENABLED=false
|
||||
# Anthropic
|
||||
ANTHROPIC_API_KEY=""
|
||||
# OpenAI
|
||||
OPENAI_API_KEY=""
|
||||
# Azure OpenAI
|
||||
_AZURE_OPENAI_API_KEY=""
|
||||
_AZURE_OPENAI_API_DEPLOYMENT_NAME=""
|
||||
_AZURE_OPENAI_API_VERSION=""
|
||||
_AZURE_OPENAI_API_BASE_PATH=""
|
||||
# Fireworks
|
||||
FIREWORKS_API_KEY=""
|
||||
# Gemini
|
||||
GOOGLE_API_KEY=""
|
||||
# Groq - STT
|
||||
GROQ_API_KEY=""
|
||||
# ------------------
|
||||
|
||||
# If using Ollama, set the API URL here. Only needs to be set if using the non default Ollama server port.
|
||||
# It will default to `http://host.docker.internal:11434` if not set.
|
||||
# OLLAMA_API_URL="http://host.docker.internal:11434"
|
||||
# Supabase
|
||||
NEXT_PUBLIC_SUPABASE_URL=""
|
||||
NEXT_PUBLIC_SUPABASE_ANON_KEY=""
|
||||
SUPABASE_SERVICE_ROLE=""
|
||||
|
||||
# LangGraph Deployment, or local development server via LangGraph Studio.
|
||||
# If running locally, this URL should be set in the `constants.ts` file.
|
||||
# LANGGRAPH_API_URL=
|
||||
|
||||
# Supabase for authentication
|
||||
# Public keys
|
||||
NEXT_PUBLIC_SUPABASE_URL=
|
||||
NEXT_PUBLIC_SUPABASE_ANON_KEY=
|
||||
|
||||
# Azure OpenAI Configuration
|
||||
# ENSURE THEY ARE PREFIXED WITH AN UNDERSCORE.
|
||||
_AZURE_OPENAI_API_KEY=your-azure-openai-api-key
|
||||
_AZURE_OPENAI_API_INSTANCE_NAME=your-instance-name
|
||||
_AZURE_OPENAI_API_DEPLOYMENT_NAME=your-deployment-name
|
||||
_AZURE_OPENAI_API_VERSION=2024-08-01-preview
|
||||
# Optional: Azure OpenAI Base Path (if using a different domain)
|
||||
# _AZURE_OPENAI_API_BASE_PATH=https://your-custom-domain.com/openai/deployments
|
||||
FIRECRAWL_API_KEY=""
|
||||
|
||||
@@ -69,15 +69,16 @@ Next, install the dependencies:
|
||||
yarn install
|
||||
```
|
||||
|
||||
After installing dependencies, copy the `.env.example` files in `apps/web` and `apps/agents` contents into `.env` and set the required values:
|
||||
After installing dependencies, copy the contents of both `.env.example` files in the root of the project, and in `apps/web` into `.env` and set the required values:
|
||||
|
||||
```bash
|
||||
cd apps/web/
|
||||
# The root `.env` file will be read by the LangGraph server for the agents.
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
```bash
|
||||
cd apps/agents/
|
||||
# The `apps/web/.env` file will be read by the frontend.
|
||||
cd apps/web/
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
@@ -87,7 +88,7 @@ Then, setup authentication with Supabase.
|
||||
|
||||
After creating a Supabase account, visit your [dashboard](https://supabase.com/dashboard/projects) and create a new project.
|
||||
|
||||
Next, navigate to the `Project Settings` page inside your project, and then to the `API` tag. Copy the `Project URL`, and `anon public` project API key. Paste them into the `NEXT_PUBLIC_SUPABASE_URL` and `NEXT_PUBLIC_SUPABASE_ANON_KEY` environment variables in the `.env` file.
|
||||
Next, navigate to the `Project Settings` page inside your project, and then to the `API` tag. Copy the `Project URL`, and `anon public` project API key. Paste them into the `NEXT_PUBLIC_SUPABASE_URL` and `NEXT_PUBLIC_SUPABASE_ANON_KEY` environment variables in the `apps/web/.env` file.
|
||||
|
||||
After this, navigate to the `Authentication` page, and the `Providers` tab. Make sure `Email` is enabled (also ensure you've enabled `Confirm Email`). You may also enable `GitHub`, and/or `Google` if you'd like to use those for authentication. (see these pages for documentation on how to setup each provider: [GitHub](https://supabase.com/docs/guides/auth/social-login/auth-github), [Google](https://supabase.com/docs/guides/auth/social-login/auth-google))
|
||||
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
# LangSmith tracing
|
||||
LANGCHAIN_TRACING_V2="true"
|
||||
LANGCHAIN_API_KEY=""
|
||||
# Optional, unless using a non default project
|
||||
# LANGCHAIN_PROJECT=""
|
||||
|
||||
# ---LLM API Keys---
|
||||
|
||||
# Anthropic
|
||||
ANTHROPIC_API_KEY=""
|
||||
# OpenAI
|
||||
OPENAI_API_KEY=""
|
||||
# Azure OpenAI
|
||||
_AZURE_OPENAI_API_KEY=""
|
||||
_AZURE_OPENAI_API_DEPLOYMENT_NAME=""
|
||||
_AZURE_OPENAI_API_VERSION=""
|
||||
_AZURE_OPENAI_API_BASE_PATH=""
|
||||
# Fireworks
|
||||
FIREWORKS_API_KEY=""
|
||||
# Gemini
|
||||
GOOGLE_API_KEY=""
|
||||
# Groq - STT
|
||||
GROQ_API_KEY=""
|
||||
# ------------------
|
||||
|
||||
# Supabase
|
||||
NEXT_PUBLIC_SUPABASE_URL=""
|
||||
NEXT_PUBLIC_SUPABASE_ANON_KEY=""
|
||||
SUPABASE_SERVICE_ROLE=""
|
||||
|
||||
FIRECRAWL_API_KEY=""
|
||||
Reference in New Issue
Block a user