References
Outpost Configuration
Global configurations are provided through env variables or a YAML file. ConfigMap can be used if deploying with Kubernetes.
| Variable | Default | Required |
|---|---|---|
SERVICE | nil | No |
CONFIG | nil | No |
ORGANIZATION_NAME | default | Yes |
API_KEY | nil | Yes |
API_PORT | 3333 | Yes |
API_JWT_SECRET | nil | Only for using JWT Auth |
AES_ENCRYPTION_SECRET | nil | Yes |
TOPICS | '' | No |
REDIS_PORT | 6379 | Yes |
REDIS_HOST | 127.0.0.1 | Yes |
REDIS_PASSWORD | nil | Yes |
REDIS_DATABASE | 0 | Yes |
CLICKHOUSE_USER | nil | Yes |
CLICKHOUSE_DATABASE | outpost | Yes |
CLICKHOUSE_HOST | nil | Yes |
CLICKHOUSE_PASSWORD | nil | Yes |
RABBITMQ_SERVER_URL | nil | No |
RABBITMQ_EXCHANGE | outpost | No |
RABBITMQ_DELIVERY_QUEUE | outpost-delivery | No |
RABBITMQ_LOG_QUEUE | outpost-log | No |
AWS_SQS_REGION | nil | No |
AWS_SQS_ACCESS_KEY_ID | nil | No |
AWS_SQS_SECRET_ACCESS_KEY | nil | No |
AWS_SQS_DELIVERY_QUEUE | outpost-delivery | No |
AWS_SQS_LOG_QUEUE | outpost-log | No |
GCP_PUBSUB_SERVICE_ACCOUNT_CREDS | nil | No |
GCP_PUBSUB_DELIVERY_TOPIC | outpost-delivery | No |
GCP_PUBSUB_LOG_TOPIC | outpost-log | No |
PUBLISH_RABBITMQ_SERVER_URL | nil | No |
PUBLISH_RABBITMQ_QUEUE | nil | No |
PUBLISH_AWS_REGION | nil | No |
PUBLISH_AWS_SQS_ACCESS_KEY_ID | nil | No |
PUBLISH_AWS_SQS_SECRET_ACCESS_KEY | nil | No |
PUBLISH_AWS_SQS_QUEUE | nil | No |
PUBLISH_GCP_PUBSUB_SERVICE_ACCOUNT_CREDS | nil | No |
PUBLISH_GCP_PUBSUB_SUBSCRIPTION | nil | No |
PUBLISH_MAX_CONCURRENCY | 10 | No |
DELIVERY_MAX_CONCURRENCY | 10 | Yes |
LOG_MAX_CONCURRENCY | 10 | Yes |
LOG_RETRY_LIMIT | 5 | Yes |
RETRY_INTERVAL_SECONDS | 30 | Yes |
MAX_RETRY_LIMIT | 10 | Yes |
DELIVERY_TIMEOUT_SECONDS | 5 | Yes |
HTTP_USER_AGENT | Outpost 1.0 | Yes |
MAX_EVENT_SIZE_KB | 256 | Yes |
MAX_DESTINATIONS_PER_TENANT | 20 | Yes |
LOG_BATCH_SIZE | 1000 | Yes |
LOG_BATCH_THRESHOLD_SECONDS | 10 | Yes |
DESTINATIONS_WEBHOOK_HEADER_PREFIX | x- | No |
DESTINATIONS_WEBHOOK_DISABLE_EVENT_ID_HEADER | false | No |
DESTINATIONS_WEBHOOK_DISABLE_SIGNATURE_HEADER | false | No |
DESTINATIONS_WEBHOOK_DISABLE_TIMESTAMP_HEADER | false | No |
DESTINATIONS_WEBHOOK_DISABLE_TOPIC_HEADER | false | No |
DESTINATIONS_WEBHOOK_SIGNATURE_VALUE_TEMPLATE | {{.Timestamp.Unix}}.{{.Body}} | No |
DESTINATIONS_WEBHOOK_SIGNATURE_HEADER_TEMPLATE | t=\{\{.Timestamp.Unix}},v0={{.Signatures | join ","\}\} | No |
DESTINATIONS_WEBHOOK_SIGNATURE_ENCODING | hex | No |
DESTINATIONS_WEBHOOK_SIGNATURE_ALGORITHM | hmac-sha256 | No |
ALERT_CALLBACK_URL | nil | No |
ALERT_DEBOUNCING_INTERVAL_SECOND | 3600 | No |
ALERT_CONSECUTIVE_FAILURE_COUNT | 20 | No |
ALERT_FAILURE_WINDOW_SECOND | 60 | No |
ALERT_FAILURE_RATE | 0.1 | No |
ALERT_AUTO_DISABLE_DESTINATION | true | No |
PORTAL_REFERER_URL | nil | Yes |
PORTAL_FAVICON_URL | nil | No |
PORTAL_LOGO | nil | No |
PORTAL_FORCE_THEME | nil | No |
PORTAL_ACCENT_COLOR | nil | No |
PORTAL_BRAND_COLOR | nil | No |
PORTAL_OUTPOST_BRANDING | true | No |
DISABLE_TELEMETRY | false | Yes |
LOG_LEVEL | info | Yes |
AUDIT_LOG | true | Yes |
OTEL_SERVICE_NAME | nil | No |
OTEL_* | nil | https://opentelemetry.io/docs/languages/sdk-configuration/general/ |
DESTINATIONS_METADATA_PATH | config/outpost/destinations | No |