Skip to content

Improve environment configuration docs #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pasharayan wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve environment configuration docs #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,18 +75,21 @@ Whether you're creating customer support bots, virtual assistants, or interactiv
cp .env.example .env.local
```

Update `.env.local` with your credentials:

```env
A1BASE_API_KEY=your_api_key # From A1Base Dashboard
A1BASE_API_SECRET=your_api_secret # From A1Base Dashboard
A1BASE_ACCOUNT_ID=your_account_id # From A1Base Dashboard
A1BASE_AGENT_NUMBER=your_agent_number # From A1Base Dashboard
A1BASE_AGENT_NAME=your_agent_name # From A1Base Dashboard
A1BASE_AGENT_EMAIL=email@a1send.com # From A1Base Dashboard
OPENAI_API_KEY=your_openai_key # From OpenAI Dashboard
CRON_SECRET=your_generated_secret # Generate your own secure random string
```
Edit `.env.local` and provide the values from your dashboards:

- `A1BASE_API_KEY` – your A1Base API key (**required**)
- `A1BASE_API_SECRET` – your A1Base API secret (**required**)
- `A1BASE_ACCOUNT_ID` – your A1Base account ID (**required**)
- `A1BASE_AGENT_NUMBER` – WhatsApp number connected to your agent (**required**)
- `A1BASE_AGENT_NAME` – display name for the agent (**optional**)
- `A1BASE_AGENT_EMAIL` – email address used when the agent sends emails (**required**)
- `OPENAI_API_KEY` – API key for OpenAI (**required**)
- `PERPLEXITY_API_KEY` – API key for Perplexity (**optional**)
- `CRON_SECRET` – secret token to secure the cron route (**optional**)
- `SUPABASE_URL` / `SUPABASE_KEY` – Supabase project credentials (**optional**)

If you enable Supabase, open the SQL editor in your Supabase project and run
the commands from `supabase.sql` to create the required tables.

4. **Set up A1Base credentials**
- Register at [A1Base Dashboard](https://dashboard.a1base.com)
Expand Down