Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

remove reverse proxy rewrite (#340)

Bill Yangb375df8985c5
diff --git a/Caddyfile b/Caddyfile
index 4141123f9..b47fc80c0 100644
--- a/Caddyfile
+++ b/Caddyfile
@@ -4,7 +4,7 @@
# Enable compression
encode zstd gzip
- handle_path /api/* {
+ handle /api/* {
reverse_proxy backend:3001
}
diff --git a/client/package.json b/client/package.json
index cf3b8116d..f3777a786 100644
--- a/client/package.json
+++ b/client/package.json
@@ -1,6 +1,6 @@
{
"name": "client",
- "version": "0.4.2",
+ "version": "1.0.0",
"private": true,
"scripts": {
"dev": "next dev -p 3002 --turbopack",
diff --git a/client/src/lib/const.ts b/client/src/lib/const.ts
index fa28ab75f..9de3e47ab 100644
--- a/client/src/lib/const.ts
+++ b/client/src/lib/const.ts
@@ -1,6 +1,6 @@
export const BACKEND_URL =
process.env.NEXT_PUBLIC_BACKEND_URL === "http://localhost:3001"
- ? "http://localhost:3001"
+ ? "http://localhost:3001/api"
: `${process.env.NEXT_PUBLIC_BACKEND_URL}/api`;
export const IS_CLOUD = process.env.NEXT_PUBLIC_CLOUD === "true";
export const IS_DEMO = process.env.NEXT_PUBLIC_DEMO === "true";
diff --git a/client/src/middleware.ts b/client/src/middleware.ts
index 1e5778f1a..98688db80 100644
--- a/client/src/middleware.ts
+++ b/client/src/middleware.ts
@@ -11,7 +11,10 @@ export async function middleware(request: NextRequest) {
}
// Handle GitHub OAuth callback redirect
- if (path === "/auth/callback/github" || path === "/auth/callback/google") {
+ if (
+ path.includes("/auth/callback/github") ||
+ path.includes("/auth/callback/google")
+ ) {
const redirectUrl = new URL(
`/api${path}${request.nextUrl.search}`,
request.url
diff --git a/docs/src/content/self-hosting-advanced.mdx b/docs/src/content/self-hosting-advanced.mdx
index 5b81e9e33..546840dff 100644
--- a/docs/src/content/self-hosting-advanced.mdx
+++ b/docs/src/content/self-hosting-advanced.mdx
@@ -63,7 +63,7 @@ server {
# API requests - adjust port if you customized it
location /api/ {
- proxy_pass http://localhost:3001/; # or your custom port
+ proxy_pass http://localhost:3001; # or your custom port
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
@@ -202,11 +202,10 @@ HOST_CLIENT_PORT=3002
Hint: In the Custom Location add a custom rule:
```
location /api/ {
- rewrite ^/api(/.*)$ $1 break;
proxy_pass http://rybbit_backend:3001;
}
```
-_note, this might not be necessary anymore, check https://github.com/rybbit-io/rybbit/issues/135_
+_Note: Path rewriting is no longer needed as the backend now expects requests with the `/api/` prefix._
7. run `docker compose up -d` (or separately pull and up)
diff --git a/docs/src/content/self-hosting-nginx.mdx b/docs/src/content/self-hosting-nginx.mdx
index ab81271f8..a62932aba 100644
--- a/docs/src/content/self-hosting-nginx.mdx
+++ b/docs/src/content/self-hosting-nginx.mdx
@@ -61,7 +61,7 @@ server {
}
location /api/ {
- proxy_pass http://localhost:3001/; # Backend port
+ proxy_pass http://localhost:3001; # Backend port
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
@@ -70,8 +70,8 @@ server {
}
```
-<Callout type="warning">
- Note the trailing slash in the proxy_pass for the API location. This is important to correctly strip the `/api/` prefix when forwarding requests to the backend service.
+<Callout type="info">
+ The backend service expects requests to include the `/api/` prefix, so we proxy requests directly without path rewriting.
</Callout>
### 4. Enable the Site Configuration
diff --git a/server/src/index.ts b/server/src/index.ts
index 124897e00..647ec0c9e 100644
--- a/server/src/index.ts
+++ b/server/src/index.ts
@@ -117,63 +117,59 @@ server.register(
);
const PUBLIC_ROUTES: string[] = [
- "/health",
- "/track",
- "/script",
- "/auth",
- "/config",
+ "/api/health",
+ "/api/track",
+ "/api/script.js", // Updated script route
+ "/api/config",
"/api/auth",
"/api/auth/callback/google",
"/api/auth/callback/github",
- "/api/stripe/webhook", // Add webhook to public routes
+ "/api/stripe/webhook",
];
// Define analytics routes that can be public
const ANALYTICS_ROUTES = [
- "/live-user-count/",
- "/overview/",
- "/overview-bucketed/",
- "/single-col/",
- "/page-titles/",
- "/retention/",
- "/site-has-data/",
- "/site-is-public/",
- "/sessions/",
- "/session/",
- "/recent-events/",
- "/users/",
- "/user/info/",
- "/user/session-count/",
- "/live-session-locations/",
- "/funnels/",
- "/funnel/",
- "/journeys/",
- "/goals/",
- "/goal/",
+ "/api/live-user-count/",
+ "/api/overview/",
+ "/api/overview-bucketed/",
+ "/api/single-col/",
+ "/api/page-titles/",
+ "/api/retention/",
+ "/api/site-has-data/",
+ "/api/site-is-public/",
+ "/api/sessions/",
+ "/api/session/",
+ "/api/recent-events/",
+ "/api/users/",
+ "/api/user/info/",
+ "/api/user/session-count/",
+ "/api/live-session-locations/",
+ "/api/funnels/",
+ "/api/funnel/",
+ "/api/journeys/",
+ "/api/goals/",
+ "/api/goal/",
"/api/analytics/events/names/",
"/api/analytics/events/properties/",
- "/events/",
- "/get-site",
+ "/api/events/",
+ "/api/get-site",
];
-// Check if a route is an analytics route
-const isAnalyticsRoute = (path: string) => {
- return ANALYTICS_ROUTES.some((route) => path.startsWith(route));
-};
-
server.addHook("onRequest", async (request, reply) => {
const { url } = request.raw;
if (!url) return;
- // Bypass auth for health check and tracking
- if (PUBLIC_ROUTES.some((route) => url.includes(route))) {
+ let processedUrl = url;
+
+ // Bypass auth for public routes (now including the prepended /api)
+ if (PUBLIC_ROUTES.some((route) => processedUrl.includes(route))) {
return;
}
- // Check if it's an analytics route and get site ID
- if (isAnalyticsRoute(url)) {
- const siteId = extractSiteId(url);
+ // Check if it's an analytics route and get site ID (now including the prepended /api)
+ if (ANALYTICS_ROUTES.some((route) => processedUrl.startsWith(route))) {
+ const siteId = extractSiteId(processedUrl);
if (siteId && (await isSitePublic(siteId))) {
// Skip auth check for public sites
@@ -196,61 +192,70 @@ server.addHook("onRequest", async (request, reply) => {
}
});
+// Add this with your other routes, around line 273
+server.get("/api/script.js", async (request, reply) => {
+ return reply.sendFile("script.js");
+});
+
// Analytics
// This endpoint gets called a lot so we don't want to log it
-server.get("/live-user-count/:site", { logLevel: "silent" }, getLiveUsercount);
-server.get("/overview/:site", getOverview);
-server.get("/overview-bucketed/:site", getOverviewBucketed);
-server.get("/single-col/:site", getSingleCol);
-server.get("/page-titles/:site", getPageTitles);
-server.get("/retention/:site", getRetention);
-server.get("/site-has-data/:site", getSiteHasData);
-server.get("/site-is-public/:site", getSiteIsPublic);
-server.get("/sessions/:site", getSessions);
-server.get("/session/:sessionId/:site", getSession);
-server.get("/recent-events/:site", getEvents); // Legacy endpoint for backward compatibility
-server.get("/events/:site", getEvents); // New endpoint with filtering and pagination
-server.get("/users/:site", getUsers);
-server.get("/user/:userId/sessions/:site", getUserSessions);
-server.get("/user/session-count/:site", getUserSessionCount);
-server.get("/user/info/:userId/:site", getUserInfo);
-server.get("/live-session-locations/:site", getLiveSessionLocations);
-server.get("/funnels/:site", getFunnels);
-server.get("/journeys/:site", getJourneys);
-server.post("/funnel/:site", getFunnel);
-server.post("/funnel/create/:site", createFunnel);
-server.delete("/funnel/:funnelId", deleteFunnel);
-server.get("/goals/:site", getGoals);
-server.get("/goal/:goalId/:site", getGoal);
-server.post("/goal/create", createGoal);
-server.delete("/goal/:goalId", deleteGoal);
-server.put("/goal/update", updateGoal);
-server.get("/events/names/:site", getEventNames);
-server.get("/events/properties/:site", getEventProperties);
-server.get("/org-event-count/:organizationId", getOrgEventCount);
+server.get(
+ "/api/live-user-count/:site",
+ { logLevel: "silent" },
+ getLiveUsercount
+);
+server.get("/api/overview/:site", getOverview);
+server.get("/api/overview-bucketed/:site", getOverviewBucketed);
+server.get("/api/single-col/:site", getSingleCol);
+server.get("/api/page-titles/:site", getPageTitles);
+server.get("/api/retention/:site", getRetention);
+server.get("/api/site-has-data/:site", getSiteHasData);
+server.get("/api/site-is-public/:site", getSiteIsPublic);
+server.get("/api/sessions/:site", getSessions);
+server.get("/api/session/:sessionId/:site", getSession);
+server.get("/api/recent-events/:site", getEvents); // Legacy endpoint for backward compatibility
+server.get("/api/events/:site", getEvents); // New endpoint with filtering and pagination
+server.get("/api/users/:site", getUsers);
+server.get("/api/user/:userId/sessions/:site", getUserSessions);
+server.get("/api/user/session-count/:site", getUserSessionCount);
+server.get("/api/user/info/:userId/:site", getUserInfo);
+server.get("/api/live-session-locations/:site", getLiveSessionLocations);
+server.get("/api/funnels/:site", getFunnels);
+server.get("/api/journeys/:site", getJourneys);
+server.post("/api/funnel/:site", getFunnel);
+server.post("/api/funnel/create/:site", createFunnel);
+server.delete("/api/funnel/:funnelId", deleteFunnel);
+server.get("/api/goals/:site", getGoals);
+server.get("/api/goal/:goalId/:site", getGoal);
+server.post("/api/goal/create", createGoal);
+server.delete("/api/goal/:goalId", deleteGoal);
+server.put("/api/goal/update", updateGoal);
+server.get("/api/events/names/:site", getEventNames);
+server.get("/api/events/properties/:site", getEventProperties);
+server.get("/api/org-event-count/:organizationId", getOrgEventCount);
// Administrative
-server.get("/config", getConfig);
-server.post("/add-site", addSite);
-server.post("/change-site-domain", changeSiteDomain);
-server.post("/change-site-public", changeSitePublic);
-server.post("/change-site-salt", changeSiteSalt);
-server.post("/change-site-block-bots", changeSiteBlockBots);
-server.post("/delete-site/:id", deleteSite);
-server.get("/get-sites-from-org/:organizationId", getSitesFromOrg);
-server.get("/get-site/:id", getSite);
+server.get("/api/config", getConfig);
+server.post("/api/add-site", addSite);
+server.post("/api/change-site-domain", changeSiteDomain);
+server.post("/api/change-site-public", changeSitePublic);
+server.post("/api/change-site-salt", changeSiteSalt);
+server.post("/api/change-site-block-bots", changeSiteBlockBots);
+server.post("/api/delete-site/:id", deleteSite);
+server.get("/api/get-sites-from-org/:organizationId", getSitesFromOrg);
+server.get("/api/get-site/:id", getSite);
server.get(
- "/list-organization-members/:organizationId",
+ "/api/list-organization-members/:organizationId",
listOrganizationMembers
);
-server.get("/user/organizations", getUserOrganizations);
+server.get("/api/user/organizations", getUserOrganizations);
if (IS_CLOUD) {
// Stripe Routes
- server.post("/stripe/create-checkout-session", createCheckoutSession);
- server.post("/stripe/create-portal-session", createPortalSession);
- server.get("/stripe/subscription", getSubscription);
+ server.post("/api/stripe/create-checkout-session", createCheckoutSession);
+ server.post("/api/stripe/create-portal-session", createPortalSession);
+ server.get("/api/stripe/subscription", getSubscription);
server.post(
"/api/stripe/webhook",
{ config: { rawBody: true } },
@@ -258,12 +263,14 @@ if (IS_CLOUD) {
); // Use rawBody parser config for webhook
// Admin Routes
- server.get("/admin/sites", getAdminSites);
- server.get("/admin/organizations", getAdminOrganizations);
+ server.get("/api/admin/sites", getAdminSites);
+ server.get("/api/admin/organizations", getAdminOrganizations);
}
-server.post("/track", trackEvent);
-server.get("/health", { logLevel: "silent" }, (_, reply) => reply.send("OK"));
+server.post("/api/track", trackEvent);
+server.get("/api/health", { logLevel: "silent" }, (_, reply) =>
+ reply.send("OK")
+);
const start = async () => {
try {
diff --git a/server/src/lib/auth.ts b/server/src/lib/auth.ts
index 513a709ec..bfce25b0f 100644
--- a/server/src/lib/auth.ts
+++ b/server/src/lib/auth.ts
@@ -83,7 +83,7 @@ const pluginList = [
];
export let auth: AuthType | null = betterAuth({
- basePath: "/auth",
+ basePath: "/api/auth",
database: new pg.Pool({
host: process.env.POSTGRES_HOST || "postgres",
port: parseInt(process.env.POSTGRES_PORT || "5432", 10),
@@ -126,7 +126,7 @@ export let auth: AuthType | null = betterAuth({
export function initAuth(allowedOrigins: string[]) {
auth = betterAuth({
- basePath: "/auth",
+ basePath: "/api/auth",
database: drizzleAdapter(db, {
provider: "pg",
schema: {