Veja o arquivo de exemplo do env no repositório oficial.

Principais variáveis

VariávelValorExemplo
SERVER_URLO endereço para seu servidor em execução. Esse endereço é utilizado para retornar dados de requisição interna, como links de webhook.https://exemplo.evolution-api.com
WEBSOCKET_ENABLEDHabilitar ou não o WebSockettrue
WEBSOCKET_GLOBAL_EVENTSHabilita os WebSocket de forma globaltrue
CONFIG_SESSION_PHONE_CLIENTNome que será exibido na conexão do smartphoneEvolutionAPI
CONFIG_SESSION_PHONE_NAMENome do navegador que será exibido na conexão do smartphoneChrome

Logs

VariávelValorExemplo
LOG_LEVELLogs que serão mostrados entre: ERROR,WARN,DEBUG,INFO,LOG,VERBOSE,DARK,WEBHOOKSERROR,WARN,DEBUG,INFO,LOG,VERBOSE,DARK,WEBHOOKS
LOG_COLORMostrar ou não cores nos Logs (true ou false)true
LOG_BAILEYSQuais logs da Baileys serão mostrados entre: “fatal”, “error”, “warn”, “info”, “debug” e “trace”error

Storage Temporáreo

Armazenamento temporáreo de dados. Valores são true ou false para armazena ou não.

VariávelValor
STORE_MESSAGESGuarda mensagens
STORE_MESSAGE_UPGuarda atualização das mensagens
STORE_CONTACTSGuarda contatos
STORE_CHATSGuarda conversas

Limpeza do Storage Temporáreo

Limpeza do armazenamento temporáreo.

VariávelValor
CLEAN_STORE_CLEANING_INTERVALIntervalo de limpeza em segundos
CLEAN_STORE_MESSAGESSe excluirá as mensagens (true ou false)
CLEAN_STORE_MESSAGE_UPSe excluirá as atualizações de mensagens (true ou false)
CLEAN_STORE_CONTACTSSe excluirá os contatos (true ou false)
CLEAN_STORE_CHATSSe excluirá as conversas (true ou false)

Storage Persistente

Configurações de conexão:

VariávelValorExemplo
DATABASE_ENABLEDSe o armazenamento persistente está habilitadotrue
DATABASE_CONNECTION_URIA URI de conexão do MongoDBtrue
DATABASE_CONNECTION_DB_PREFIX_NAMEQuais logs da Baileys serão mostrados entre: “fatal”, “error”, “warn”, “info”, “debug” e “trace”error

Quais dados serão salvos (true ou false)

VariávelValor
DATABASE_SAVE_DATA_INSTANCESalva dados de instâncias
DATABASE_SAVE_DATA_NEW_MESSAGESalva novas mensagens
DATABASE_SAVE_MESSAGE_UPDATESalva atualizações de mensagens
DATABASE_SAVE_DATA_CONTACTSSalva contatos
DATABASE_SAVE_DATA_CHATSSalva conversas

Redis

VariávelValorExemplo
CACHE_REDIS_ENABLEDSe o Redis está habilitado (true ou false)true
CACHE_REDIS_URIA URI de conexão do Redisredis://redis:6379
CACHE_REDIS_PREFIX_KEYPrefixo do nome de chaveevolution
CACHE_REDIS_TTLTempo para manter os dados no Redis604800
CACHE_REDIS_SAVE_INSTANCESSalva as credencias de conexão do whatsapp no Redisfalse
CACHE_LOCAL_ENABLEDFaz cache em memória, alternativa ao Redisfalse
CACHE_LOCAL_TTLTempo para manter os dados localmente604800

RabbitMQ

VariávelValorExemplo
RABBITMQ_ENABLEDHabilita o RabbitMQ (true ou false)true
RABBITMQ_GLOBAL_ENABLEDHabilita o RabbitMQ de forma global (true ou false)false
RABBITMQ_URIURI de conexão do RabbitMQamqp://guest:guest@rabbitmq:5672
RABBITMQ_EXCHANGE_NAMENome do exchangeevolution_exchange
RABBITMQ_EVENTS_APPLICATION_STARTUPEnvia um evento na inicialização do appfalse
RABBITMQ_EVENTS_QRCODE_UPDATEDEnvia eventos de Atualização do QR Codetrue
RABBITMQ_EVENTS_MESSAGES_SETEnvia eventos de Criação de Mensagens (recuperação de mensagens)true
RABBITMQ_EVENTS_MESSAGES_UPSERTEnvia eventos de Recebimento de Mensagenstrue
RABBITMQ_EVENTS_MESSAGES_UPDATEEnvia eventos de Atualização de Mensagenstrue
RABBITMQ_EVENTS_MESSAGES_DELETEEnvia eventos de Deleção de Mensagenstrue
RABBITMQ_EVENTS_SEND_MESSAGEEnvia eventos de Envio de Mensagenstrue
RABBITMQ_EVENTS_CONTACTS_SETEnvia eventos de Criação de Contatostrue
RABBITMQ_EVENTS_CONTACTS_UPSERTEnvia eventos de Criação de Contatos (recuperação de contatos)true
RABBITMQ_EVENTS_CONTACTS_UPDATEEnvia eventos de Atualização de Contatostrue
RABBITMQ_EVENTS_PRESENCE_UPDATEEnvia eventos de Atualização de presença (“digitando…” ou “gravando…“)true
RABBITMQ_EVENTS_CHATS_SETEnvia eventos de Criação de Conversas (recuperação de conversas)true
RABBITMQ_EVENTS_CHATS_UPSERTEnvia eventos de Criação de Conversas (recebimento ou envio de mensagens em novos chats)true
RABBITMQ_EVENTS_CHATS_UPDATEEnvia eventos de Atualização de Conversastrue
RABBITMQ_EVENTS_CHATS_DELETEEnvia eventos de Deleção de Conversastrue
RABBITMQ_EVENTS_GROUPS_UPSERTEnvia eventos de Criação de Grupostrue
RABBITMQ_EVENTS_GROUPS_UPDATEEnvia eventos de Atualização de Grupostrue
RABBITMQ_EVENTS_GROUP_PARTICIPANTS_UPDATEEnvia eventos de Atualização nos Participantes de Grupostrue
RABBITMQ_EVENTS_CONNECTION_UPDATEEnvia eventos de Atualização de Conexãotrue
RABBITMQ_EVENTS_LABELS_EDITEnvia eventos de Edição de Etiquetastrue
RABBITMQ_EVENTS_LABELS_ASSOCIATIONEnvia eventos de Associação de Etiquetastrue
RABBITMQ_EVENTS_CALLEnvia eventos de Chamadastrue
RABBITMQ_EVENTS_TYPEBOT_STARTEnvia eventos de Início de fluxo do Typebotfalse
RABBITMQ_EVENTS_TYPEBOT_CHANGE_STATUSEnvia eventos de Atualização no status do Typebotfalse

SQS

VariávelValor
SQS_ENABLEDSe o SQS está habilitado (true ou false)
SQS_ACCESS_KEY_IDO ID de chave do SQS
SQS_SECRET_ACCESS_KEYChave de acesso
SQS_ACCOUNT_IDID da conta
SQS_REGIONRegião do SQS

Instâncias

VariávelValorExemplo
DEL_INSTANCEEm quantos minutos uma instânica será excluída se não conectada. Use “false” para nunca excluir.5
DEL_TEMP_INSTANCESDeleta instâncias fechadas na inicializaçãotrue

CORS

VariávelValorExemplo
CORS_ORIGINAs origens permitidas pela API separadas por vírgula (utilize ”*” para aceiteitar requisições de qualquer origem).https://meu-frontend.com,https://meu-outro-frontend.com
CORS_METHODSMétodos HTTP permitidos separados por vírgula.POST,GET,PUT,DELETE
CORS_CREDENTIALSPermisão de cookies em requisições (true ou false).true

Webhook

VariávelValor
WEBHOOK_GLOBAL_URLUrl que receberá as requisições de webhook
WEBHOOK_GLOBAL_ENABLEDSe os webhooks estão habilitados (true ou false)
WEBHOOK_GLOBAL_WEBHOOK_BY_EVENTS

Eventos de webhook com valor true ou false:

Variável
WEBHOOK_EVENTS_APPLICATION_STARTUP
WEBHOOK_EVENTS_QRCODE_UPDATED
WEBHOOK_EVENTS_MESSAGES_SET
WEBHOOK_EVENTS_MESSAGES_UPSERT
WEBHOOK_EVENTS_MESSAGES_UPDATE
WEBHOOK_EVENTS_MESSAGES_DELETE
WEBHOOK_EVENTS_SEND_MESSAGE
WEBHOOK_EVENTS_CONTACTS_SET
WEBHOOK_EVENTS_CONTACTS_UPSERT
WEBHOOK_EVENTS_CONTACTS_UPDATE
WEBHOOK_EVENTS_PRESENCE_UPDATE
WEBHOOK_EVENTS_CHATS_SET
WEBHOOK_EVENTS_CHATS_UPSERT
WEBHOOK_EVENTS_CHATS_UPDATE
WEBHOOK_EVENTS_CHATS_DELETE
WEBHOOK_EVENTS_GROUPS_UPSERT
WEBHOOK_EVENTS_GROUPS_UPDATE
WEBHOOK_EVENTS_GROUP_PARTICIPANTS_UPDATE
WEBHOOK_EVENTS_CONNECTION_UPDATE
WEBHOOK_EVENTS_LABELS_EDIT
WEBHOOK_EVENTS_LABELS_ASSOCIATION
WEBHOOK_EVENTS_CALL
WEBHOOK_EVENTS_NEW_JWT_TOKEN
WEBHOOK_EVENTS_TYPEBOT_START
WEBHOOK_EVENTS_TYPEBOT_CHANGE_STATUS
WEBHOOK_EVENTS_CHAMA_AI_ACTION
WEBHOOK_EVENTS_ERRORS
WEBHOOK_EVENTS_ERRORS_WEBHOOK

QR Code

VariávelValor
QRCODE_LIMITPor quanto tempo o QR code durará
QRCODE_COLORCor do QR code gerado

Typebot

VariávelValor
TYPEBOT_API_VERSIONVersão da API (versão fixa ou latest)
TYPEBOT_KEEP_OPENMantém o Typebot aberto (true ou false)

Autenticação

VariávelValor
AUTHENTICATION_TYPETipo de autenticação (jwt ou apikey)
AUTHENTICATION_API_KEYChave da API que será usada para autenticação
AUTHENTICATION_EXPOSE_IN_FETCH_INSTANCES
AUTHENTICATION_JWT_EXPIRIN_INTempo de expiração do token JWT
AUTHENTICATION_JWT_SECRETSegredo usado para gerar o JWT