local-webhooks/.env-example at main · matter-labs/local-webhooks · 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
# ==============================================================================
# ZKsync Webhook Service — Environment Configuration (Example)
#
# Copy this file to `.env` and fill in the required values.
# Do NOT commit your real `.env` file to source control.
# ==============================================================================

# ------------------------------------------------------------------------------
# Required: Docker Registry Credentials (Quay.io)
#
# These credentials are provided by Matter Labs.
# Required to pull the private webhook-service image.
# ------------------------------------------------------------------------------

DOCKER_USERNAME=matterlabs_enterprise+your_username
DOCKER_PASSWORD=super_secret_provided_by_matterlabs

# ------------------------------------------------------------------------------
# Required: Cryptographic Secrets
#
# Used for:
# - Service account authentication for accessing Prividium JSON-RPC
# - Encrypting the signing key used to sign webhooks
#
# These are required for local setups. In hosted deployments, ZKsync manages them.
# ------------------------------------------------------------------------------

PRIVIDIUM_SIGNER_KEY=
ENCRYPTION_KEY=

# ------------------------------------------------------------------------------
# Webhook Delivery (Your Receiver)
#
# Where the webhook service will POST deliveries to.
#
# For local testing with the included mock server:
#   make mock-server
# ------------------------------------------------------------------------------

WEBHOOK_DESTINATION_URL=http://host.docker.internal:9000/webhook

# ------------------------------------------------------------------------------
# Service Ports (Host-side)
#
# These control which ports are exposed on *your machine*.
# Inside the container, ports are defined in `config.toml`.
#
# Defaults match `config.prividium.docker.toml`:
#   - API port   → 8081
#   - Admin port → 8080
# ------------------------------------------------------------------------------

API_PORT=8081
ADMIN_PORT=8080

# ------------------------------------------------------------------------------
# Service Configuration File
#
# Path to the config file on your machine that will be mounted into the container.
#
# Users may point this to a custom config file.
# ------------------------------------------------------------------------------

HOST_CONFIG_PATH=./config/config.prividium.docker.toml

# ------------------------------------------------------------------------------
# Logging
#
# Controls log verbosity for the webhook service.
# Common values: trace, debug, info, warn, error
# ------------------------------------------------------------------------------

RUST_LOG=info

# ------------------------------------------------------------------------------
# SIWE / Auth Context (Used by helper scripts)
#
# These are used when generating SIWE messages and auth tokens.
# They do NOT affect the running webhook service directly.
# ------------------------------------------------------------------------------

API_URL=https://api.example.zksync.dev
DOMAIN=user-panel.example.zksync.dev