Variáveis de Ambiente

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

​

Principais variáveis

Variável	Valor	Exemplo
SERVER_URL	O 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_ENABLED	Habilitar ou não o WebSocket	true
WEBSOCKET_GLOBAL_EVENTS	Habilita os WebSocket de forma global	true
CONFIG_SESSION_PHONE_CLIENT	Nome que será exibido na conexão do smartphone	EvolutionAPI
CONFIG_SESSION_PHONE_NAME	Nome do navegador que será exibido na conexão do smartphone	Chrome

​

Logs

Variável	Valor	Exemplo
LOG_LEVEL	Logs que serão mostrados entre: ERROR,WARN,DEBUG,INFO,LOG,VERBOSE,DARK,WEBHOOKS	ERROR,WARN,DEBUG,INFO,LOG,VERBOSE,DARK,WEBHOOKS
LOG_COLOR	Mostrar ou não cores nos Logs (true ou false)	true
LOG_BAILEYS	Quais 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ável	Valor
STORE_MESSAGES	Guarda mensagens
STORE_MESSAGE_UP	Guarda atualização das mensagens
STORE_CONTACTS	Guarda contatos
STORE_CHATS	Guarda conversas

​

Limpeza do Storage Temporáreo

Limpeza do armazenamento temporáreo.

Variável	Valor
CLEAN_STORE_CLEANING_INTERVAL	Intervalo de limpeza em segundos
CLEAN_STORE_MESSAGES	Se excluirá as mensagens (true ou false)
CLEAN_STORE_MESSAGE_UP	Se excluirá as atualizações de mensagens (true ou false)
CLEAN_STORE_CONTACTS	Se excluirá os contatos (true ou false)
CLEAN_STORE_CHATS	Se excluirá as conversas (true ou false)

​

Storage Persistente

Configurações de conexão:

Variável	Valor	Exemplo
DATABASE_ENABLED	Se o armazenamento persistente está habilitado	true
DATABASE_CONNECTION_URI	A URI de conexão do MongoDB	true
DATABASE_CONNECTION_DB_PREFIX_NAME	Quais logs da Baileys serão mostrados entre: “fatal”, “error”, “warn”, “info”, “debug” e “trace”	error

Quais dados serão salvos (true ou false)

Variável	Valor
DATABASE_SAVE_DATA_INSTANCE	Salva dados de instâncias
DATABASE_SAVE_DATA_NEW_MESSAGE	Salva novas mensagens
DATABASE_SAVE_MESSAGE_UPDATE	Salva atualizações de mensagens
DATABASE_SAVE_DATA_CONTACTS	Salva contatos
DATABASE_SAVE_DATA_CHATS	Salva conversas

​

Redis

Variável	Valor	Exemplo
CACHE_REDIS_ENABLED	Se o Redis está habilitado (true ou false)	true
CACHE_REDIS_URI	A URI de conexão do Redis	redis://redis:6379
CACHE_REDIS_PREFIX_KEY	Prefixo do nome de chave	evolution
CACHE_REDIS_TTL	Tempo para manter os dados no Redis	604800
CACHE_REDIS_SAVE_INSTANCES	Salva as credencias de conexão do whatsapp no Redis	false
CACHE_LOCAL_ENABLED	Faz cache em memória, alternativa ao Redis	false
CACHE_LOCAL_TTL	Tempo para manter os dados localmente	604800

​

RabbitMQ

Variável	Valor	Exemplo
RABBITMQ_ENABLED	Habilita o RabbitMQ (true ou false)	true
RABBITMQ_GLOBAL_ENABLED	Habilita o RabbitMQ de forma global (true ou false)	false
RABBITMQ_URI	URI de conexão do RabbitMQ	amqp://guest:guest@rabbitmq:5672
RABBITMQ_EXCHANGE_NAME	Nome do exchange	evolution_exchange
RABBITMQ_EVENTS_APPLICATION_STARTUP	Envia um evento na inicialização do app	false
RABBITMQ_EVENTS_QRCODE_UPDATED	Envia eventos de Atualização do QR Code	true
RABBITMQ_EVENTS_MESSAGES_SET	Envia eventos de Criação de Mensagens (recuperação de mensagens)	true
RABBITMQ_EVENTS_MESSAGES_UPSERT	Envia eventos de Recebimento de Mensagens	true
RABBITMQ_EVENTS_MESSAGES_UPDATE	Envia eventos de Atualização de Mensagens	true
RABBITMQ_EVENTS_MESSAGES_DELETE	Envia eventos de Deleção de Mensagens	true
RABBITMQ_EVENTS_SEND_MESSAGE	Envia eventos de Envio de Mensagens	true
RABBITMQ_EVENTS_CONTACTS_SET	Envia eventos de Criação de Contatos	true
RABBITMQ_EVENTS_CONTACTS_UPSERT	Envia eventos de Criação de Contatos (recuperação de contatos)	true
RABBITMQ_EVENTS_CONTACTS_UPDATE	Envia eventos de Atualização de Contatos	true
RABBITMQ_EVENTS_PRESENCE_UPDATE	Envia eventos de Atualização de presença (“digitando…” ou “gravando…“)	true
RABBITMQ_EVENTS_CHATS_SET	Envia eventos de Criação de Conversas (recuperação de conversas)	true
RABBITMQ_EVENTS_CHATS_UPSERT	Envia eventos de Criação de Conversas (recebimento ou envio de mensagens em novos chats)	true
RABBITMQ_EVENTS_CHATS_UPDATE	Envia eventos de Atualização de Conversas	true
RABBITMQ_EVENTS_CHATS_DELETE	Envia eventos de Deleção de Conversas	true
RABBITMQ_EVENTS_GROUPS_UPSERT	Envia eventos de Criação de Grupos	true
RABBITMQ_EVENTS_GROUPS_UPDATE	Envia eventos de Atualização de Grupos	true
RABBITMQ_EVENTS_GROUP_PARTICIPANTS_UPDATE	Envia eventos de Atualização nos Participantes de Grupos	true
RABBITMQ_EVENTS_CONNECTION_UPDATE	Envia eventos de Atualização de Conexão	true
RABBITMQ_EVENTS_LABELS_EDIT	Envia eventos de Edição de Etiquetas	true
RABBITMQ_EVENTS_LABELS_ASSOCIATION	Envia eventos de Associação de Etiquetas	true
RABBITMQ_EVENTS_CALL	Envia eventos de Chamadas	true
RABBITMQ_EVENTS_TYPEBOT_START	Envia eventos de Início de fluxo do Typebot	false
RABBITMQ_EVENTS_TYPEBOT_CHANGE_STATUS	Envia eventos de Atualização no status do Typebot	false

​

SQS

Variável	Valor
SQS_ENABLED	Se o SQS está habilitado (true ou false)
SQS_ACCESS_KEY_ID	O ID de chave do SQS
SQS_SECRET_ACCESS_KEY	Chave de acesso
SQS_ACCOUNT_ID	ID da conta
SQS_REGION	Região do SQS

​

Instâncias

Variável	Valor	Exemplo
DEL_INSTANCE	Em quantos minutos uma instânica será excluída se não conectada. Use “false” para nunca excluir.	5
DEL_TEMP_INSTANCES	Deleta instâncias fechadas na inicialização	true

​

CORS

Variável	Valor	Exemplo
CORS_ORIGIN	As 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_METHODS	Métodos HTTP permitidos separados por vírgula.	POST,GET,PUT,DELETE
CORS_CREDENTIALS	Permisão de cookies em requisições (true ou false).	true

​

Webhook

Variável	Valor
WEBHOOK_GLOBAL_URL	Url que receberá as requisições de webhook
WEBHOOK_GLOBAL_ENABLED	Se 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ável	Valor
QRCODE_LIMIT	Por quanto tempo o QR code durará
QRCODE_COLOR	Cor do QR code gerado

​

Typebot

Variável	Valor
TYPEBOT_API_VERSION	Versão da API (versão fixa ou latest)
TYPEBOT_KEEP_OPEN	Mantém o Typebot aberto (true ou false)

​

Autenticação

Variável	Valor
AUTHENTICATION_TYPE	Tipo de autenticação (jwt ou apikey)
AUTHENTICATION_API_KEY	Chave da API que será usada para autenticação
AUTHENTICATION_EXPOSE_IN_FETCH_INSTANCES
AUTHENTICATION_JWT_EXPIRIN_IN	Tempo de expiração do token JWT
AUTHENTICATION_JWT_SECRET	Segredo usado para gerar o JWT