Skip to content

Commit

Permalink
doc: Add some more documentation to .env.example
Browse files Browse the repository at this point in the history
Signed-off-by: Diwank Singh Tomer <[email protected]>
  • Loading branch information
creatorrr committed Oct 13, 2024
1 parent 0ac6dc8 commit 8e25bee
Showing 1 changed file with 37 additions and 28 deletions.
65 changes: 37 additions & 28 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
# Note: For just testing, you can set them to the same value.

# On Linux, you can generate a random key with:
# openssl rand -base64 32
# > openssl rand -base64 32
# OR
# tr -dc 'A-Za-z0-9+_/' </dev/urandom | head -c 32; echo
# > tr -dc 'A-Za-z0-9+_/' </dev/urandom | head -c 32; echo

JWT_SHARED_KEY=<your_jwt_shared_key>
AGENTS_API_KEY=<your_agents_api_key>
Expand All @@ -18,37 +18,60 @@ LITELLM_MASTER_KEY=<your_litellm_master_key>
LITELLM_SALT_KEY=<your_litellm_salt_key>
LITELLM_REDIS_PASSWORD=<your_litellm_redis_password>

# Memory Store
# -----------
# LLM Providers
# --------------

# COZO_HOST=http://memory-store:9070
# COZO_PORT=9070
# COZO_ROCKSDB_DIR=cozo.db
# COZO_BACKUP_DIR=/backup
# COZO_MNT_DIR=/data
### Recommended LLM Providers

# Gateway
# ------
# OPENAI_API_KEY=<your_openai_api_key>
# VOYAGE_API_KEY=<your_voyage_api_key>

# GATEWAY_PORT=80
# TRAEFIK_LOG_LEVEL=INFO
# HUGGING_FACE_HUB_TOKEN=<your_hugging_face_hub_token>
# ANTHROPIC_API_KEY=<your_anthropic_api_key>
# GROQ_API_KEY=<your_groq_api_key>
# CLOUDFLARE_API_KEY=<your_cloudflare_api_key>
# CLOUDFLARE_ACCOUNT_ID=<your_cloudflare_account_id>
# NVIDIA_NIM_API_KEY=<your_nvidia_nim_api_key>
# GITHUB_API_KEY=<your_github_api_key>
# GOOGLE_APPLICATION_CREDENTIALS=.keys/julep-vertexai-svc.json

# Agents API
# ---------

### Embedding Model
### > Set to either "voyage/voyage-3" or "Alibaba-NLP/gte-large-en-v1.5"
### > Use Alibaba-NLP/gte-large-en-v1.5 with local embedding server

# EMBEDDING_MODEL_ID=voyage/voyage-3
# EMBEDDING_MODEL_ID=Alibaba-NLP/gte-large-en-v1.5

# AGENTS_API_HOSTNAME=localhost
# AGENTS_API_PROTOCOL=http
# AGENTS_API_KEY_HEADER_NAME=Authorization
# AGENTS_API_URL=http://agents-api:8080
# TRUNCATE_EMBED_TEXT=true
# WORKER_URL=temporal:7233
# AGENTS_API_DEBUG=false
# EMBEDDING_MODEL_ID=Alibaba-NLP/gte-large-en-v1.5
# NUM_GPUS=1
# INTEGRATION_SERVICE_URL=http://integrations:8000
# USE_BLOB_STORE_FOR_TEMPORAL=false
# BLOB_STORE_CUTOFF_KB=1024

# Memory Store
# -----------

# COZO_HOST=http://memory-store:9070
# COZO_PORT=9070
# COZO_ROCKSDB_DIR=cozo.db
# COZO_BACKUP_DIR=/backup
# COZO_MNT_DIR=/data

# Gateway
# ------

# GATEWAY_PORT=80
# TRAEFIK_LOG_LEVEL=INFO

# Temporal
# --------

Expand All @@ -67,20 +90,6 @@ LITELLM_REDIS_PASSWORD=<your_litellm_redis_password>
# LITELLM_REDIS_HOST=litellm-redis
# LITELLM_REDIS_PORT=6379

# LLM Providers
# --------------

# OPENAI_API_KEY=<your_openai_api_key>
# HUGGING_FACE_HUB_TOKEN=<your_hugging_face_hub_token>
# ANTHROPIC_API_KEY=<your_anthropic_api_key>
# GROQ_API_KEY=<your_groq_api_key>
# CLOUDFLARE_API_KEY=<your_cloudflare_api_key>
# CLOUDFLARE_ACCOUNT_ID=<your_cloudflare_account_id>
# NVIDIA_NIM_API_KEY=<your_nvidia_nim_api_key>
# GITHUB_API_KEY=<your_github_api_key>
# VOYAGE_API_KEY=<your_voyage_api_key>
# GOOGLE_APPLICATION_CREDENTIALS=.keys/julep-vertexai-svc.json

# Blob Store
# -----------

Expand Down

0 comments on commit 8e25bee

Please sign in to comment.