Get started / Introduction
Get started
Branly documentation
Integration guides and setup references for your engineering team.
Technical guides for teams working with Branly. Start with the overview of a topic, then follow the setup steps. Every code example has a copy button, and ⌘K searches all pages.
Feed integration
- How feeds workPublish posts from the Branly feed admin and serve them at /feed on your own website, with one reverse proxy rule.
- Set up the proxyConnection details and the five steps to route /feed to the Branly feed service, verify it and launch.
- Edge routing examplesReady-to-use /feed rules for NGINX, Amazon CloudFront, AWS ALB and Cloudflare Workers.
- WebflowServe the feed on a Webflow site: route /feed at the public edge and connect the feed sitemap.
Crawl Insights
- OverviewSee which AI crawlers and assistants read your pages, measured from your own server or CDN logs, and choose how to send them.
- CloudflareInstall a small Cloudflare Worker, automatically with an API token or by hand, that reports AI-bot requests on any Cloudflare plan.
- AWS CloudFrontLaunch one CloudFormation stack that turns on CloudFront logging and forwards only AI-bot requests from your AWS account.
- AWS ALBForward AI-bot requests from Application Load Balancer access logs with one CloudFormation stack per region.
- WebhookSend access-log entries as JSON from any server, CDN or log shipper: request format, fields, responses and limits.
- File uploadUpload nginx, Apache, CloudFront, ALB, JSON or CSV logs to backfill up to 90 days, including custom log formats.
- Reading the dashboardDate ranges, metrics and domains on the Crawl Insights page.
- Data and privacyPausing and disconnecting sources, limits and retention, and how your data is protected.
- TroubleshootingFixes for common problems with AWS stacks, the Cloudflare Worker, uploads and webhooks.
Integrations
Need a hand? Write to connect@branly.ai and we'll help your team with the setup.