Installation & Setup

Step-by-step setup instructions for self-hosting or integrating with Bunnylynk Cloud.

Deployment Options

Bunnylynk is designed to run either as a managed cloud service or self-hosted in your own infrastructure.

Using Bunnylynk Cloud

  1. Access to the managed dashboard at app.bunnylynk.com is currently invite-only during our preview release.
  2. Go to Settings > API Keys to generate an API Key.
  3. Export your key in your environment:
    export BUNNYLYNK_API_KEY="blyk_live_xxxxxxxxxxxxxxxxxxxx"
    
  4. All requests go to https://api.bunnylynk.com/v1.

Core Configuration Parameters

When configuring Bunnylynk instances, the following environment variables control runtime behavior:

VariableDescriptionDefault
DATABASE_URLConnection string for PostgreSQL or SQLite ledgerRequired
GATEWAY_PORTPort for the ingestion edge gateway8787
API_PORTPort for the management REST API3001
MAX_PAYLOAD_BYTESMaximum allowed request body size10485760 (10MB)
DEFAULT_TIMEOUT_MSDefault HTTP client timeout for destination deliveries5000 (5s)

Connecting Webhook Senders

To begin routing webhooks, update your webhook endpoints in your external service settings:

  • Stripe: Replace your webhook endpoint in Stripe Developer Dashboard with your Bunnylynk source endpoint: https://gateway.bunnylynk.com/h/stripe-prod.
  • Shopify: Under Shopify Admin > Notifications > Webhooks, point subscriptions to your Bunnylynk URL.
  • GitHub: Under Repository > Settings > Webhooks, set Payload URL to your Bunnylynk endpoint.

Next: Learn about Core Concepts: Sources, Destinations, Connections.