eliza/.env.example at develop · elizaOS/eliza · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
####################################
#### Server Configuration ####
####################################

# Server Port
SERVER_PORT=3000

# Server Host (default: 0.0.0.0)
SERVER_HOST=

# Environment Mode (development/production - affects UI and security)
NODE_ENV=development

# Controls whether the web UI is available
# Set to "true" to force enable, "false" to force disable, or leave unset for automatic behavior
# Default: enabled in development, disabled in production
ELIZA_UI_ENABLE=

# Server authentication token for API access
# When set, all /api/* routes require X-API-KEY header with this value
ELIZA_SERVER_AUTH_TOKEN=

# Express Maximum Payload Size (default: 2mb)
EXPRESS_MAX_PAYLOAD=2mb

####################################
#### Provider Configuration ####
####################################

# Total timeout for all providers running in parallel (in milliseconds)
# When providers exceed this timeout, the pipeline aborts and returns an error message
# Default: 1000 (1 second)
PROVIDERS_TOTAL_TIMEOUT_MS=1000

####################################
#### Database Configuration ####
####################################

# PostgreSQL Connection URL
POSTGRES_URL=

# PGLite Database Directory (or use memory:// for in-memory)
# Alternative to Postgres
PGLITE_DATA_DIR=

####################################
#### AI Model Provider APIs ####
####################################

# OpenAI API Key
OPENAI_API_KEY=

# Google Generative AI API Key
GOOGLE_GENERATIVE_AI_API_KEY=


# Anthropic Claude API Key (Embedding Provider required; will default to local embedding if not provided)
ANTHROPIC_API_KEY=

# OpenRouter API Key (Embedding Provider required; will default to local embedding if not provided)
OPENROUTER_API_KEY=

# Ollama API Endpoint (for local LLM hosting, supports embedding)
OLLAMA_API_ENDPOINT=

####################################
#### Character & Content Loading ####
####################################

# Remote Character URLs (comma-separated)
REMOTE_CHARACTER_URLS=


####################################
#### Development & Build Control ####
####################################

# Non-interactive CLI Mode (true/false)
ELIZA_NONINTERACTIVE=

####################################
#### Data Directory Configuration ####
####################################

# Base data directory (default: .eliza)
# ELIZA_DATA_DIR=.eliza

# Database directory (default: {ELIZA_DATA_DIR}/.elizadb)
# ELIZA_DATABASE_DIR=

# Characters storage directory (default: {ELIZA_DATA_DIR}/data/characters)
# ELIZA_DATA_DIR_CHARACTERS=

# AI-generated content directory (default: {ELIZA_DATA_DIR}/data/generated)
# ELIZA_DATA_DIR_GENERATED=

# Agent uploads directory (default: {ELIZA_DATA_DIR}/data/uploads/agents)
# ELIZA_DATA_DIR_UPLOADS_AGENTS=

# Channel uploads directory (default: {ELIZA_DATA_DIR}/data/uploads/channels)
# ELIZA_DATA_DIR_UPLOADS_CHANNELS=

####################################
#### Plugin Control ####
####################################
# Note: for all available / required configuration for specific plugins
# Check agentConfig property on their package.json

####################################
#### Coding Sandbox Routing ####
####################################

# Active options: e2b, eliza-cloud, home
ELIZA_CODING_REMOTE_RUNNER=

# Shared sandbox settings
ELIZA_SANDBOX_WORKDIR=
ELIZA_SANDBOX_HOST_WORKSPACE_ROOT=
ELIZA_SANDBOX_AGENT_RUNNERS=

# E2B sandbox
E2B_API_KEY=
E2B_ACCESS_TOKEN=
E2B_SANDBOX_ID=
E2B_TEMPLATE=

# Eliza Cloud sandbox runner
ELIZA_CLOUD_SANDBOX_API_BASE_URL=
ELIZA_CLOUD_SANDBOX_BASE_URL=
ELIZA_CLOUD_SANDBOX_TOKEN=
ELIZA_CLOUD_SANDBOX_ACCESS_URL=
ELIZA_CLOUD_SANDBOX_IMAGE=
ELIZA_CLOUD_REMOTE_RUNNER_IMAGE=
ELIZA_CLOUD_CODING_REMOTE_RUNNER_IMAGE=

# Home Remote runner
ELIZA_HOME_REMOTE_RUNNER_URL=
ELIZA_HOME_REMOTE_RUNNER_TOKEN=
ELIZA_HOME_REMOTE_RUNNER_ACCESS_URL=

# Optional home SSH tunnel metadata for Settings copy button
ELIZA_HOME_REMOTE_RUNNER_SSH_TARGET=
ELIZA_HOME_REMOTE_RUNNER_SSH_IDENTITY=
ELIZA_HOME_REMOTE_RUNNER_SSH_LOCAL_PORT=
OPENCODE_SERVER_USERNAME=
OPENCODE_SERVER_PASSWORD=

# Codex runner mode
CODEX_BIN=
CODEX_APP_SERVER_LISTEN=
CODEX_APP_SERVER_WS_TOKEN_FILE=
CODEX_APP_SERVER_WS_SHARED_SECRET_FILE=