πΈ Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
Refactor proxy guide to standardize API path mappings
Bill Yang4f19e27b3114
diff --git a/docs/content/docs/proxy-guide/astro.mdx b/docs/content/docs/proxy-guide/astro.mdxindex cd67be9e9..fab0a994f 100644--- a/docs/content/docs/proxy-guide/astro.mdx+++ b/docs/content/docs/proxy-guide/astro.mdx@@ -92,14 +92,9 @@ export const onRequest: MiddlewareHandler = async (context, next) => {async function proxyToRybbit(request: Request, pathname: string): Promise<Response> {try {- // Map paths+ // Map paths: /analytics/* β /api/*let rybbitPath = pathname.replace('/analytics/', '/api/');- // Special case for site config- if (pathname.startsWith('/analytics/site/')) {- rybbitPath = pathname.replace('/analytics/', '/');- }-const rybbitUrl = `${RYBBIT_HOST}${rybbitPath}`;// Get client IP from headers@@ -149,12 +144,9 @@ export const onRequest = async (context, next) => {async function proxyToRybbit(request, pathname) {try {+ // Map paths: /analytics/* β /api/*let rybbitPath = pathname.replace('/analytics/', '/api/');- if (pathname.startsWith('/analytics/site/')) {- rybbitPath = pathname.replace('/analytics/', '/');- }-const rybbitUrl = `${RYBBIT_HOST}${rybbitPath}`;const forwardedFor = request.headers.get('x-forwarded-for');const clientIp = forwardedFor ? forwardedFor.split(',')[0].trim() : '127.0.0.1';diff --git a/docs/content/docs/proxy-guide/caddy.mdx b/docs/content/docs/proxy-guide/caddy.mdxindex 4cd72b5f7..c22577233 100644--- a/docs/content/docs/proxy-guide/caddy.mdx+++ b/docs/content/docs/proxy-guide/caddy.mdx@@ -62,16 +62,6 @@ yourdomain.com {rewrite * /api/script.js}- # Unminified script- handle /analytics/script-full.js {- reverse_proxy https://app.rybbit.io {- header_up Host app.rybbit.io- header_up X-Real-IP {remote_host}- header_up X-Forwarded-For {remote_host}- }- rewrite * /api/script-full.js- }-# Session replay scripthandle /analytics/replay.js {reverse_proxy https://app.rybbit.io {@@ -132,7 +122,7 @@ yourdomain.com {header_up X-Real-IP {remote_host}header_up X-Forwarded-For {remote_host}}- rewrite * /site/tracking-config{path}+ rewrite * /api/site/tracking-config{path}}}```@@ -306,7 +296,7 @@ yourdomain.com {header_up X-Real-IP {remote_host}header_up X-Forwarded-For {remote_host}}- rewrite * /site/tracking-config{path}+ rewrite * /api/site/tracking-config{path}header Cache-Control "public, max-age=300"}diff --git a/docs/content/docs/proxy-guide/cloudflare-workers.mdx b/docs/content/docs/proxy-guide/cloudflare-workers.mdxindex 0fb80dc07..d1741d078 100644--- a/docs/content/docs/proxy-guide/cloudflare-workers.mdx+++ b/docs/content/docs/proxy-guide/cloudflare-workers.mdx@@ -77,11 +77,6 @@ async function proxyToRybbit(request, url) {// Map paths: /analytics/* β /api/*let rybbitPath = url.pathname.replace('/analytics/', '/api/');- // Special case for site config- if (url.pathname.startsWith('/analytics/site/')) {- rybbitPath = url.pathname.replace('/analytics/', '/');- }-// Build Rybbit URLconst rybbitUrl = new URL(rybbitPath, RYBBIT_HOST);rybbitUrl.search = url.search; // Preserve query params@@ -203,12 +198,9 @@ async function handleRequest(request, env) {return fetch(request);}+ // Map paths: /analytics/* β /api/*let rybbitPath = url.pathname.replace('/analytics/', '/api/');- if (url.pathname.startsWith('/analytics/site/')) {- rybbitPath = url.pathname.replace('/analytics/', '/');- }-const rybbitUrl = new URL(rybbitPath, RYBBIT_HOST);const clientIp = request.headers.get('CF-Connecting-IP') || '0.0.0.0';diff --git a/docs/content/docs/proxy-guide/express.mdx b/docs/content/docs/proxy-guide/express.mdxindex edbd4302a..79260a72a 100644--- a/docs/content/docs/proxy-guide/express.mdx+++ b/docs/content/docs/proxy-guide/express.mdx@@ -98,7 +98,7 @@ app.use('/analytics/site/tracking-config', createProxyMiddleware({target: RYBBIT_HOST,changeOrigin: true,pathRewrite: {- '^/analytics': '', // Keep /site/tracking-config path+ '^/analytics/site': '/api/site', // Rewrite to /api/site/tracking-config},onProxyReq: (proxyReq, req, res) => {const clientIp = req.headers['x-forwarded-for'] || req.socket.remoteAddress;@@ -186,7 +186,7 @@ app.use('/analytics/site/tracking-config', createProxyMiddleware({target: RYBBIT_HOST,changeOrigin: true,pathRewrite: {- '^/analytics': '',+ '^/analytics/site': '/api/site',},onProxyReq: proxyOptions.onProxyReq,}));diff --git a/docs/content/docs/proxy-guide/get-started.mdx b/docs/content/docs/proxy-guide/get-started.mdxindex c58e8445d..1232f8ca6 100644--- a/docs/content/docs/proxy-guide/get-started.mdx+++ b/docs/content/docs/proxy-guide/get-started.mdx@@ -45,13 +45,12 @@ This minimal setup enables basic pageview and event tracking, but won't support| Endpoint | Method | Purpose | Cache ||----------|--------|---------|-------|| `/api/script.js` | GET | Main tracking script (minified) | 1 hour |-| `/api/script-full.js` | GET | Unminified script for debugging | 1 hour || `/api/replay.js` | GET | Session replay recording script | 1 hour || `/api/metrics.js` | GET | Web Vitals metrics script | 1 hour || `/api/track` | POST | Event tracking endpoint | No cache || `/api/identify` | POST | User identification endpoint | No cache || `/api/session-replay/record/:siteId` | POST | Session replay data upload | No cache |-| `/site/tracking-config/:siteId` | GET | Site configuration | 5 minutes |+| `/api/site/tracking-config/:siteId` | GET | Site configuration | 5 minutes |This setup supports all Rybbit features including session replay, Web Vitals, and custom events.@@ -94,7 +93,7 @@ Implement caching to reduce load on Rybbit servers and improve performance:**Recommended cache durations:**- **Scripts** (`.js` files): 1 hour (3600 seconds)- These change infrequently but may be updated for bug fixes-- **Site configuration** (`/site/tracking-config/*`): 5 minutes (300 seconds)+- **Site configuration** (`/api/site/tracking-config/*`): 5 minutes (300 seconds)- Updated when you change settings in the dashboard- **Tracking endpoints** (POST requests): Never cache- Each request contains unique event datadiff --git a/docs/content/docs/proxy-guide/laravel.mdx b/docs/content/docs/proxy-guide/laravel.mdxindex e5a441cc8..2f3075ed5 100644--- a/docs/content/docs/proxy-guide/laravel.mdx+++ b/docs/content/docs/proxy-guide/laravel.mdx@@ -116,7 +116,7 @@ class AnalyticsProxyController extends Controller$cacheKey = "rybbit_config_{$siteId}";return Cache::remember($cacheKey, 300, function () use ($siteId, $request) {- return $this->forwardRequest("site/tracking-config/{$siteId}", 'GET', $request);+ return $this->forwardRequest("api/site/tracking-config/{$siteId}", 'GET', $request);});}@@ -174,7 +174,7 @@ use App\Http\Controllers\AnalyticsProxyController;Route::prefix('analytics')->group(function () {// Scripts (GET)Route::get('/{script}', [AnalyticsProxyController::class, 'proxyScript'])- ->where('script', '(script|script-full|replay|metrics)\.js');+ ->where('script', '(script|replay|metrics)\.js');// Tracking endpoints (POST)Route::post('/track', [AnalyticsProxyController::class, 'proxyTrack']);diff --git a/docs/content/docs/proxy-guide/next-js.mdx b/docs/content/docs/proxy-guide/next-js.mdxindex e5da548d5..cbef8f797 100644--- a/docs/content/docs/proxy-guide/next-js.mdx+++ b/docs/content/docs/proxy-guide/next-js.mdx@@ -87,10 +87,6 @@ const nextConfig = {source: '/analytics/script.js',destination: `${rybbitHost}/api/script.js`,},- {- source: '/analytics/script-full.js',- destination: `${rybbitHost}/api/script-full.js`,- },{source: '/analytics/replay.js',destination: `${rybbitHost}/api/replay.js`,@@ -114,7 +110,7 @@ const nextConfig = {},{source: '/analytics/site/tracking-config/:siteId',- destination: `${rybbitHost}/site/tracking-config/:siteId`,+ destination: `${rybbitHost}/api/site/tracking-config/:siteId`,},];},@@ -204,7 +200,7 @@ const nextConfig = {},{source: '/analytics/site/tracking-config/:siteId',- destination: `${rybbitHost}/site/tracking-config/:siteId`,+ destination: `${rybbitHost}/api/site/tracking-config/:siteId`,},];},diff --git a/docs/content/docs/proxy-guide/nginx.mdx b/docs/content/docs/proxy-guide/nginx.mdxindex 5dbf3f631..69454d3aa 100644--- a/docs/content/docs/proxy-guide/nginx.mdx+++ b/docs/content/docs/proxy-guide/nginx.mdx@@ -70,18 +70,6 @@ server {add_header X-Cache-Status $upstream_cache_status;}- # Unminified script for debugging (cached)- location = /analytics/script-full.js {- proxy_pass https://app.rybbit.io/api/script-full.js;- proxy_set_header Host app.rybbit.io;- proxy_set_header X-Real-IP $remote_addr;- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;- proxy_set_header X-Forwarded-Proto $scheme;- proxy_ssl_server_name on;-- proxy_cache_valid 200 1h;- }-# Session replay script (cached)location = /analytics/replay.js {proxy_pass https://app.rybbit.io/api/replay.js;@@ -144,7 +132,7 @@ server {# Site configuration endpoint (cached briefly)location ~ ^/analytics/site/tracking-config/(.*)$ {- proxy_pass https://app.rybbit.io/site/tracking-config/$1;+ proxy_pass https://app.rybbit.io/api/site/tracking-config/$1;proxy_set_header Host app.rybbit.io;proxy_set_header X-Real-IP $remote_addr;proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;@@ -372,8 +360,8 @@ location ~ ^/analytics/(script|replay|metrics)\.js$ {}# Config - cache for 5 minutes (changes when you update dashboard settings)-location ~ ^/analytics/site/tracking-config/ {- proxy_pass https://app.rybbit.io/site/tracking-config/;+location ~ ^/analytics/site/tracking-config/(.*)$ {+ proxy_pass https://app.rybbit.io/api/site/tracking-config/$1;# ... proxy headersproxy_cache_valid 200 5m;}diff --git a/docs/content/docs/proxy-guide/troubleshooting.mdx b/docs/content/docs/proxy-guide/troubleshooting.mdxindex daa46a928..a9ed5cb8b 100644--- a/docs/content/docs/proxy-guide/troubleshooting.mdx+++ b/docs/content/docs/proxy-guide/troubleshooting.mdx@@ -289,9 +289,9 @@ module.exports = {```nginx# Nginx - cache for 5 minutes max-location ~ ^/analytics/site/tracking-config/ {+location ~ ^/analytics/site/tracking-config/(.*)$ {proxy_cache_valid 200 5m; # Not longer!- proxy_pass https://app.rybbit.io;+ proxy_pass https://app.rybbit.io/api/site/tracking-config/$1;}```@@ -317,9 +317,9 @@ cache.flushAll();```nginx# Nginx - no caching-location ~ ^/analytics/site/tracking-config/ {+location ~ ^/analytics/site/tracking-config/(.*)$ {proxy_cache off;- proxy_pass https://app.rybbit.io;+ proxy_pass https://app.rybbit.io/api/site/tracking-config/$1;}```diff --git a/docs/content/docs/proxy-guide/vercel.mdx b/docs/content/docs/proxy-guide/vercel.mdxindex 2a4dca691..18c04810a 100644--- a/docs/content/docs/proxy-guide/vercel.mdx+++ b/docs/content/docs/proxy-guide/vercel.mdx@@ -43,10 +43,6 @@ Add rewrites to your `vercel.json` file in the project root:"source": "/analytics/script.js","destination": "https://app.rybbit.io/api/script.js"},- {- "source": "/analytics/script-full.js",- "destination": "https://app.rybbit.io/api/script-full.js"- },{"source": "/analytics/replay.js","destination": "https://app.rybbit.io/api/replay.js"@@ -69,7 +65,7 @@ Add rewrites to your `vercel.json` file in the project root:},{"source": "/analytics/site/tracking-config/:siteId",- "destination": "https://app.rybbit.io/site/tracking-config/:siteId"+ "destination": "https://app.rybbit.io/api/site/tracking-config/:siteId"}]}