{ "manifest_version": "1.0.0", "template": { "id": "fbb7b1c9-351c-4905-b89a-3942a09ea9a3", "slug": "evolution-whatsapp-api", "name": "Evolution API | Open Source WhatsApp API", "description": "Self-hosted WhatsApp REST API with Postgres, Redis and webhooks.", "url": "https://railway.com/deploy/evolution-whatsapp-api", "upstream": { "image": "evoapicloud/evolution-api:v2.3.7" } }, "services": [ { "name": "Postgres", "source": { "image": "postgres:18.6-alpine" }, "needs_volume": true, "volume_mount_path": "/var/lib/postgresql", "http": false }, { "name": "EvolutionAPI", "source": { "image": "evoapicloud/evolution-api:v2.3.7" }, "needs_volume": false, "http": true }, { "name": "Redis", "source": { "image": "redis:8.10.1-alpine" }, "needs_volume": false, "http": false } ], "required_inputs": [ { "key": "PORT", "service": "Postgres", "description": "Port Postgres listens on inside the private network.", "secret": false, "strategy": "default", "default": "5432" }, { "key": "POSTGRES_DB", "service": "Postgres", "description": "Database created on first boot. Must match the database name in DATABASE_CONNECTION_URI.", "secret": false, "strategy": "default", "default": "evolution" }, { "key": "POSTGRES_USER", "service": "Postgres", "description": "Superuser role created on first boot.", "secret": false, "strategy": "default", "default": "postgres" }, { "key": "POSTGRES_PASSWORD", "service": "Postgres", "description": "Generated once on deploy. Changing it here does not change it in the database.", "secret": true, "strategy": "generate", "generate": "strong_password" }, { "key": "TZ", "service": "EvolutionAPI", "description": "Container timezone. The image bakes in America/Sao_Paulo, which shifts every timestamp the API prints.", "secret": false, "strategy": "default", "default": "UTC" }, { "key": "PORT", "service": "EvolutionAPI", "description": "Port Railway routes public traffic and healthchecks to. Must match SERVER_PORT — the application itself never reads PORT.", "secret": false, "strategy": "default", "default": "8080" }, { "key": "LANGUAGE", "service": "EvolutionAPI", "description": "Language of API messages, for example en or pt-BR.", "secret": false, "strategy": "default", "default": "en" }, { "key": "LOG_COLOR", "service": "EvolutionAPI", "description": "ANSI colours in the log. Off, because Railway's log viewer shows them as escape sequences.", "secret": false, "strategy": "default", "default": "false" }, { "key": "LOG_LEVEL", "service": "EvolutionAPI", "description": "Which log channels to print. Upstream turns on every one of them including VERBOSE and WEBSOCKET, which on Railway hits the per-deployment log rate limit and drops the lines that matter. Add DEBUG and VERBOSE while troubleshooting.", "secret": false, "strategy": "default", "default": "ERROR,WARN,INFO,LOG" }, { "key": "SERVER_URL", "service": "EvolutionAPI", "description": "Public URL of this API. It goes into every webhook payload and QR-code callback, so it has to be the address clients actually reach — with the scheme.", "secret": false, "strategy": "railway_provided", "railway_source": "railway_domain" }, { "key": "LOG_BAILEYS", "service": "EvolutionAPI", "description": "Log level of the WhatsApp library itself: fatal, error, warn, info, debug or trace.", "secret": false, "strategy": "default", "default": "error" }, { "key": "SERVER_PORT", "service": "EvolutionAPI", "description": "Port the API binds. Must match PORT.", "secret": false, "strategy": "default", "default": "8080" }, { "key": "SERVER_TYPE", "service": "EvolutionAPI", "description": "The API speaks plain HTTP; Railway terminates TLS in front of it. Setting this to https makes the app look for certificate files that are not there.", "secret": false, "strategy": "default", "default": "http" }, { "key": "DB_WAIT_HOST", "service": "EvolutionAPI", "description": "Read by the start command, not by the application: the API runs database migrations on boot and exits if Postgres is not answering yet, so it waits for this host first.", "secret": false, "strategy": "railway_provided", "railway_source": "railway_private_domain" }, { "key": "DB_WAIT_PORT", "service": "EvolutionAPI", "description": "Port checked by that same wait loop.", "secret": false, "strategy": "default", "default": "5432" }, { "key": "DEL_INSTANCE", "service": "EvolutionAPI", "description": "Minutes of inactivity after which a disconnected instance is dropped from memory, or false to never drop it. Off here — the alternative silently disconnects a number that simply had a quiet day.", "secret": false, "strategy": "default", "default": "false" }, { "key": "QRCODE_LIMIT", "service": "EvolutionAPI", "description": "How many times a QR code is regenerated before the connection attempt gives up.", "secret": false, "strategy": "default", "default": "30" }, { "key": "CACHE_REDIS_TTL", "service": "EvolutionAPI", "description": "Cache lifetime in seconds (7 days).", "secret": false, "strategy": "default", "default": "604800" }, { "key": "CACHE_REDIS_URI", "service": "EvolutionAPI", "description": "Connection string for the Redis service on the private network. The trailing number is the Redis database index.", "secret": false, "strategy": "railway_provided", "railway_source": "railway_private_domain" }, { "key": "DATABASE_PROVIDER", "service": "EvolutionAPI", "description": "Database engine. Changing it means changing the connection URI and the migration set with it.", "secret": false, "strategy": "default", "default": "postgresql" }, { "key": "TELEMETRY_ENABLED", "service": "EvolutionAPI", "description": "Send usage data to the upstream project. Off here; set to true to opt back in.", "secret": false, "strategy": "default", "default": "false" }, { "key": "CACHE_LOCAL_ENABLED", "service": "EvolutionAPI", "description": "In-process cache. Redundant while Redis is on, and it does not survive a deploy.", "secret": false, "strategy": "default", "default": "false" }, { "key": "CACHE_REDIS_ENABLED", "service": "EvolutionAPI", "description": "Use Redis for caching. Turning this off makes the Redis service dead weight.", "secret": false, "strategy": "default", "default": "true" }, { "key": "AUTHENTICATION_API_KEY", "service": "EvolutionAPI", "description": "The master key for the whole API — it creates instances and reads every message. Sent as the `apikey` header. Generated once on deploy; treat it like a password.", "secret": true, "strategy": "generate", "generate": "random_base64_32" }, { "key": "CACHE_REDIS_PREFIX_KEY", "service": "EvolutionAPI", "description": "Key prefix, so two installations can share one Redis.", "secret": true, "strategy": "default", "default": "evolution" }, { "key": "DATABASE_CONNECTION_URI", "service": "EvolutionAPI", "description": "Postgres connection string. Prisma reads this variable directly, which is why no separate DATABASE_URL exists. Do not add a ?schema= parameter — that is what the open upstream migration reports have in common.", "secret": false, "strategy": "railway_provided", "railway_source": "railway_private_domain" }, { "key": "DATABASE_DELETE_MESSAGE", "service": "EvolutionAPI", "description": "Remove messages from the database when they are deleted on WhatsApp.", "secret": false, "strategy": "default", "default": "true" }, { "key": "DATABASE_SAVE_DATA_CHATS", "service": "EvolutionAPI", "description": "Store the chat list of connected numbers.", "secret": false, "strategy": "default", "default": "true" }, { "key": "CONFIG_SESSION_PHONE_NAME", "service": "EvolutionAPI", "description": "Browser shown next to it: Chrome, Firefox, Edge, Opera or Safari.", "secret": false, "strategy": "default", "default": "Chrome" }, { "key": "DATABASE_SAVE_DATA_LABELS", "service": "EvolutionAPI", "description": "Store WhatsApp Business labels.", "secret": false, "strategy": "default", "default": "true" }, { "key": "CACHE_REDIS_SAVE_INSTANCES", "service": "EvolutionAPI", "description": "Keeps session credentials in Postgres rather than Redis. Redis here is a cache by intent; Postgres is what gets backed up.", "secret": false, "strategy": "default", "default": "false" }, { "key": "CONFIG_SESSION_PHONE_CLIENT", "service": "EvolutionAPI", "description": "Name shown on the phone under Linked Devices.", "secret": false, "strategy": "default", "default": "Evolution API" }, { "key": "DATABASE_SAVE_DATA_CONTACTS", "service": "EvolutionAPI", "description": "Store the contact list of connected numbers.", "secret": false, "strategy": "default", "default": "true" }, { "key": "DATABASE_SAVE_DATA_HISTORIC", "service": "EvolutionAPI", "description": "Import the entire past conversation history of every number that connects. Upstream ships this on; here it is off, because on a metered volume it is the difference between a database that grows with your traffic and one that arrives full the day someone links a busy account.", "secret": false, "strategy": "default", "default": "false" }, { "key": "DATABASE_SAVE_DATA_INSTANCE", "service": "EvolutionAPI", "description": "Do not turn this off. Besides storing instances, this is the flag that puts WhatsApp session credentials in Postgres — with it off and no other store configured, no number can connect at all.", "secret": false, "strategy": "default", "default": "true" }, { "key": "DATABASE_SAVE_IS_ON_WHATSAPP", "service": "EvolutionAPI", "description": "Cache which numbers are registered on WhatsApp, so repeat checks cost nothing.", "secret": false, "strategy": "default", "default": "true" }, { "key": "DATABASE_SAVE_MESSAGE_UPDATE", "service": "EvolutionAPI", "description": "Store delivery and read receipts.", "secret": false, "strategy": "default", "default": "true" }, { "key": "DATABASE_SAVE_DATA_NEW_MESSAGE", "service": "EvolutionAPI", "description": "Store incoming messages. Turn off if you only send.", "secret": false, "strategy": "default", "default": "true" }, { "key": "DATABASE_CONNECTION_CLIENT_NAME", "service": "EvolutionAPI", "description": "Separates one installation from another when several share a database.", "secret": false, "strategy": "default", "default": "evolution" }, { "key": "ENABLE_ALPINE_PRIVATE_NETWORKING", "service": "EvolutionAPI", "description": "Required on Alpine-based images for *.railway.internal to resolve at all.", "secret": false, "strategy": "default", "default": "true" }, { "key": "DATABASE_SAVE_IS_ON_WHATSAPP_DAYS", "service": "EvolutionAPI", "description": "How long that cache stays valid, in days.", "secret": false, "strategy": "default", "default": "7" }, { "key": "AUTHENTICATION_EXPOSE_IN_FETCH_INSTANCES", "service": "EvolutionAPI", "description": "Include each instance's own token in fetchInstances responses. That endpoint already requires the master key.", "secret": false, "strategy": "default", "default": "true" }, { "key": "PORT", "service": "Redis", "description": "Port Redis listens on inside the private network. Reachable only from this project — there is no public proxy.", "secret": false, "strategy": "default", "default": "6379" } ], "deploy": { "mcp": { "server": "railway", "tool": "deploy_template", "args": { "template_code": "evolution-whatsapp-api" } }, "cli": "railway deploy --template evolution-whatsapp-api", "api": { "method": "POST", "path": "/graphql/v2", "body": { "query": "mutation templateDeploy($input: TemplateDeployV2Input!) { templateDeployV2(input: $input) { projectId workflowId } }", "variables": { "input": { "templateId": "fbb7b1c9-351c-4905-b89a-3942a09ea9a3", "serializedConfig": { "buckets": {}, "services": { "4eb31f0a-6f45-409d-82f6-e136f52c1404": { "icon": "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/postgresql.svg", "name": "Postgres", "deploy": { "startCommand": null, "healthcheckPath": null, "restartPolicyType": "ON_FAILURE", "restartPolicyMaxRetries": 2 }, "source": { "image": "postgres:18.6-alpine" }, "variables": { "PORT": { "isOptional": false, "description": "Port Postgres listens on inside the private network.", "defaultValue": "5432" }, "POSTGRES_DB": { "isOptional": false, "description": "Database created on first boot. Must match the database name in DATABASE_CONNECTION_URI.", "defaultValue": "evolution" }, "POSTGRES_USER": { "isOptional": false, "description": "Superuser role created on first boot.", "defaultValue": "postgres" }, "POSTGRES_PASSWORD": { "isOptional": false, "description": "Generated once on deploy. Changing it here does not change it in the database.", "defaultValue": "{{POSTGRES_PASSWORD}}" } }, "volumeMounts": { "4eb31f0a-6f45-409d-82f6-e136f52c1404": { "mountPath": "/var/lib/postgresql" } } }, "99479610-0603-43f3-b3bb-b243ec0d5bc1": { "icon": "https://cdn.jsdelivr.net/gh/evolution-foundation/evolution-api@2.3.7/public/images/evolution-logo.png", "name": "EvolutionAPI", "deploy": { "startCommand": "bash -c 'for i in $(seq 1 90); do (echo > /dev/tcp/$DB_WAIT_HOST/$DB_WAIT_PORT) 2>/dev/null && break; echo \"waiting for postgres ($i/90)\"; sleep 2; done; . ./Docker/scripts/deploy_database.sh && exec npm run start:prod'", "healthcheckPath": "/", "restartPolicyType": "ON_FAILURE", "restartPolicyMaxRetries": 10 }, "source": { "image": "evoapicloud/evolution-api:v2.3.7" }, "variables": { "TZ": { "isOptional": false, "description": "Container timezone. The image bakes in America/Sao_Paulo, which shifts every timestamp the API prints.", "defaultValue": "UTC" }, "PORT": { "isOptional": false, "description": "Port Railway routes public traffic and healthchecks to. Must match SERVER_PORT — the application itself never reads PORT.", "defaultValue": "8080" }, "LANGUAGE": { "isOptional": false, "description": "Language of API messages, for example en or pt-BR.", "defaultValue": "en" }, "LOG_COLOR": { "isOptional": false, "description": "ANSI colours in the log. Off, because Railway's log viewer shows them as escape sequences.", "defaultValue": "false" }, "LOG_LEVEL": { "isOptional": false, "description": "Which log channels to print. Upstream turns on every one of them including VERBOSE and WEBSOCKET, which on Railway hits the per-deployment log rate limit and drops the lines that matter. Add DEBUG and VERBOSE while troubleshooting.", "defaultValue": "ERROR,WARN,INFO,LOG" }, "S3_ENABLED": { "isOptional": true, "description": "Set to true to store received media in S3-compatible storage instead of fetching it from WhatsApp on demand. Needs S3_ACCESS_KEY, S3_SECRET_KEY, S3_BUCKET and S3_ENDPOINT alongside it.", "defaultValue": "" }, "SERVER_URL": { "isOptional": false, "description": "Public URL of this API. It goes into every webhook payload and QR-code callback, so it has to be the address clients actually reach — with the scheme.", "defaultValue": "https://${{RAILWAY_PUBLIC_DOMAIN}}" }, "LOG_BAILEYS": { "isOptional": false, "description": "Log level of the WhatsApp library itself: fatal, error, warn, info, debug or trace.", "defaultValue": "error" }, "SERVER_PORT": { "isOptional": false, "description": "Port the API binds. Must match PORT.", "defaultValue": "8080" }, "SERVER_TYPE": { "isOptional": false, "description": "The API speaks plain HTTP; Railway terminates TLS in front of it. Setting this to https makes the app look for certificate files that are not there.", "defaultValue": "http" }, "DB_WAIT_HOST": { "isOptional": false, "description": "Read by the start command, not by the application: the API runs database migrations on boot and exits if Postgres is not answering yet, so it waits for this host first.", "defaultValue": "${{ Postgres.RAILWAY_PRIVATE_DOMAIN }}" }, "DB_WAIT_PORT": { "isOptional": false, "description": "Port checked by that same wait loop.", "defaultValue": "5432" }, "DEL_INSTANCE": { "isOptional": false, "description": "Minutes of inactivity after which a disconnected instance is dropped from memory, or false to never drop it. Off here — the alternative silently disconnects a number that simply had a quiet day.", "defaultValue": "false" }, "QRCODE_LIMIT": { "isOptional": false, "description": "How many times a QR code is regenerated before the connection attempt gives up.", "defaultValue": "30" }, "CACHE_REDIS_TTL": { "isOptional": false, "description": "Cache lifetime in seconds (7 days).", "defaultValue": "604800" }, "CACHE_REDIS_URI": { "isOptional": false, "description": "Connection string for the Redis service on the private network. The trailing number is the Redis database index.", "defaultValue": "redis://${{Redis.RAILWAY_PRIVATE_DOMAIN}}:6379/0" }, "DATABASE_PROVIDER": { "isOptional": false, "description": "Database engine. Changing it means changing the connection URI and the migration set with it.", "defaultValue": "postgresql" }, "TELEMETRY_ENABLED": { "isOptional": false, "description": "Send usage data to the upstream project. Off here; set to true to opt back in.", "defaultValue": "false" }, "WEBHOOK_GLOBAL_URL": { "isOptional": true, "description": "The URL those global events are posted to.", "defaultValue": "" }, "CACHE_LOCAL_ENABLED": { "isOptional": false, "description": "In-process cache. Redundant while Redis is on, and it does not survive a deploy.", "defaultValue": "false" }, "CACHE_REDIS_ENABLED": { "isOptional": false, "description": "Use Redis for caching. Turning this off makes the Redis service dead weight.", "defaultValue": "true" }, "AUTHENTICATION_API_KEY": { "isOptional": false, "description": "The master key for the whole API — it creates instances and reads every message. Sent as the `apikey` header. Generated once on deploy; treat it like a password.", "defaultValue": "{{AUTHENTICATION_API_KEY}}" }, "CACHE_REDIS_PREFIX_KEY": { "isOptional": false, "description": "Key prefix, so two installations can share one Redis.", "defaultValue": "evolution" }, "SERVER_DISABLE_MANAGER": { "isOptional": true, "description": "Set to true to switch off the built-in web manager at /manager and leave only the REST API.", "defaultValue": "" }, "WEBHOOK_GLOBAL_ENABLED": { "isOptional": true, "description": "Set to true to send every instance's events to one URL. Requires WEBHOOK_GLOBAL_URL.", "defaultValue": "" }, "DATABASE_CONNECTION_URI": { "isOptional": false, "description": "Postgres connection string. Prisma reads this variable directly, which is why no separate DATABASE_URL exists. Do not add a ?schema= parameter — that is what the open upstream migration reports have in common.", "defaultValue": "postgresql://postgres:${{Postgres.POSTGRES_PASSWORD}}@${{Postgres.RAILWAY_PRIVATE_DOMAIN}}:5432/evolution" }, "DATABASE_DELETE_MESSAGE": { "isOptional": false, "description": "Remove messages from the database when they are deleted on WhatsApp.", "defaultValue": "true" }, "DATABASE_SAVE_DATA_CHATS": { "isOptional": false, "description": "Store the chat list of connected numbers.", "defaultValue": "true" }, "CONFIG_SESSION_PHONE_NAME": { "isOptional": false, "description": "Browser shown next to it: Chrome, Firefox, Edge, Opera or Safari.", "defaultValue": "Chrome" }, "DATABASE_SAVE_DATA_LABELS": { "isOptional": false, "description": "Store WhatsApp Business labels.", "defaultValue": "true" }, "CACHE_REDIS_SAVE_INSTANCES": { "isOptional": false, "description": "Keeps session credentials in Postgres rather than Redis. Redis here is a cache by intent; Postgres is what gets backed up.", "defaultValue": "false" }, "CONFIG_SESSION_PHONE_CLIENT": { "isOptional": false, "description": "Name shown on the phone under Linked Devices.", "defaultValue": "Evolution API" }, "DATABASE_SAVE_DATA_CONTACTS": { "isOptional": false, "description": "Store the contact list of connected numbers.", "defaultValue": "true" }, "DATABASE_SAVE_DATA_HISTORIC": { "isOptional": false, "description": "Import the entire past conversation history of every number that connects. Upstream ships this on; here it is off, because on a metered volume it is the difference between a database that grows with your traffic and one that arrives full the day someone links a busy account.", "defaultValue": "false" }, "DATABASE_SAVE_DATA_INSTANCE": { "isOptional": false, "description": "Do not turn this off. Besides storing instances, this is the flag that puts WhatsApp session credentials in Postgres — with it off and no other store configured, no number can connect at all.", "defaultValue": "true" }, "DATABASE_SAVE_IS_ON_WHATSAPP": { "isOptional": false, "description": "Cache which numbers are registered on WhatsApp, so repeat checks cost nothing.", "defaultValue": "true" }, "DATABASE_SAVE_MESSAGE_UPDATE": { "isOptional": false, "description": "Store delivery and read receipts.", "defaultValue": "true" }, "DATABASE_SAVE_DATA_NEW_MESSAGE": { "isOptional": false, "description": "Store incoming messages. Turn off if you only send.", "defaultValue": "true" }, "DATABASE_CONNECTION_CLIENT_NAME": { "isOptional": false, "description": "Separates one installation from another when several share a database.", "defaultValue": "evolution" }, "ENABLE_ALPINE_PRIVATE_NETWORKING": { "isOptional": false, "description": "Required on Alpine-based images for *.railway.internal to resolve at all.", "defaultValue": "true" }, "DATABASE_SAVE_IS_ON_WHATSAPP_DAYS": { "isOptional": false, "description": "How long that cache stays valid, in days.", "defaultValue": "7" }, "AUTHENTICATION_EXPOSE_IN_FETCH_INSTANCES": { "isOptional": false, "description": "Include each instance's own token in fetchInstances responses. That endpoint already requires the master key.", "defaultValue": "true" } }, "networking": { "serviceDomains": { ":8080": { "port": 8080 } } } }, "fcad5573-38f1-4a0f-a852-fa003e2653ed": { "icon": "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/redis.svg", "name": "Redis", "deploy": { "startCommand": null, "healthcheckPath": null, "restartPolicyType": "ON_FAILURE", "restartPolicyMaxRetries": 2 }, "source": { "image": "redis:8.10.1-alpine" }, "variables": { "PORT": { "isOptional": false, "description": "Port Redis listens on inside the private network. Reachable only from this project — there is no public proxy.", "defaultValue": "6379" } }, "haTemplateCode": "redis-ha", "haConversionConfig": { "edge": { "label": "Reverse Proxies", "options": [ 1, 2 ], "nodeLabel": "HAProxy", "description": "HAProxy instances routing writes to the primary", "defaultValue": 2 }, "replica": { "label": "Redis Replicas", "options": [ 2, 3, 4, 5 ], "nodeLabel": "Redis", "description": "Nodes running Redis + colocated Sentinel", "defaultValue": 2 }, "internal": null, "description": "This will convert your Redis instance to an HA cluster with Sentinel failover and HAProxy routing to the primary." } } } } } } } } }, "post_deploy": { "healthcheck": { "service": "EvolutionAPI", "method": "GET", "path": "/", "expect_status": 200 } }, "resources": { "expected_services": 3, "needs_volume": true }, "generated_at": "2026-09-19T16:14:39.735Z", "generator_version": "0.1.0", "status": "validated", "validated_at": "2026-09-19T19:26:35.780Z", "success_rate_30d": 1, "validation": { "last_run_id": "run_75151daf89794324aa25", "checks": [ { "name": "workflow_completed", "passed": true }, { "name": "all_services_deployed", "passed": true }, { "name": "healthcheck", "passed": true }, { "name": "stays_up", "passed": true } ], "typical_ready_seconds": 101, "typical_build_seconds": 0, "typical_start_seconds": 20, "slowest_service": "EvolutionAPI" } }