Skip to content

Database diagrams editor that allows you to visualize and design your DB with a single query.

fix: add DISABLE_ANALYTICS flag to opt-out of Fathom analytics (#750)

Jonathan Fishneraa0b629a3eaf
diff --git a/Dockerfile b/Dockerfile
index bc133b88..233209e6 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -3,7 +3,8 @@ FROM node:22-alpine AS builder
ARG VITE_OPENAI_API_KEY
ARG VITE_OPENAI_API_ENDPOINT
ARG VITE_LLM_MODEL_NAME
-ARG VITE_HIDE_BUCKLE_DOT_DEV
+ARG VITE_HIDE_CHARTDB_CLOUD
+ARG VITE_DISABLE_ANALYTICS
WORKDIR /usr/src/app
@@ -16,7 +17,8 @@ COPY . .
RUN echo "VITE_OPENAI_API_KEY=${VITE_OPENAI_API_KEY}" > .env && \
echo "VITE_OPENAI_API_ENDPOINT=${VITE_OPENAI_API_ENDPOINT}" >> .env && \
echo "VITE_LLM_MODEL_NAME=${VITE_LLM_MODEL_NAME}" >> .env && \
- echo "VITE_HIDE_BUCKLE_DOT_DEV=${VITE_HIDE_BUCKLE_DOT_DEV}" >> .env
+ echo "VITE_HIDE_CHARTDB_CLOUD=${VITE_HIDE_CHARTDB_CLOUD}" >> .env && \
+ echo "VITE_DISABLE_ANALYTICS=${VITE_DISABLE_ANALYTICS}" >> .env
RUN npm run build
diff --git a/README.md b/README.md
index a23bc217..e25d7ec6 100644
--- a/README.md
+++ b/README.md
@@ -125,6 +125,8 @@ docker run \
-p 8080:80 chartdb
```
+> **Privacy Note:** ChartDB includes privacy-focused analytics via Fathom Analytics. You can disable this by adding `-e DISABLE_ANALYTICS=true` to the run command or `--build-arg VITE_DISABLE_ANALYTICS=true` when building.
+
> **Note:** You must configure either Option 1 (OpenAI API key) OR Option 2 (Custom endpoint and model name) for AI capabilities to work. Do not mix the two options.
Open your browser and navigate to `http://localhost:8080`.
diff --git a/default.conf.template b/default.conf.template
index 084dd78c..0bea3e7d 100644
--- a/default.conf.template
+++ b/default.conf.template
@@ -10,11 +10,12 @@ server {
location /config.js {
default_type application/javascript;
- return 200 "window.env = {
+ return 200 "window.env = {
OPENAI_API_KEY: \"$OPENAI_API_KEY\",
OPENAI_API_ENDPOINT: \"$OPENAI_API_ENDPOINT\",
LLM_MODEL_NAME: \"$LLM_MODEL_NAME\",
- HIDE_BUCKLE_DOT_DEV: \"$HIDE_BUCKLE_DOT_DEV\"
+ HIDE_CHARTDB_CLOUD: \"$HIDE_CHARTDB_CLOUD\",
+ DISABLE_ANALYTICS: \"$DISABLE_ANALYTICS\"
};";
}
diff --git a/entrypoint.sh b/entrypoint.sh
index cc6c02af..3214c406 100644
--- a/entrypoint.sh
+++ b/entrypoint.sh
@@ -1,7 +1,7 @@
#!/bin/sh
# Replace placeholders in nginx.conf
-envsubst '${OPENAI_API_KEY} ${OPENAI_API_ENDPOINT} ${LLM_MODEL_NAME} ${HIDE_BUCKLE_DOT_DEV}' < /etc/nginx/conf.d/default.conf.template > /etc/nginx/conf.d/default.conf
+envsubst '${OPENAI_API_KEY} ${OPENAI_API_ENDPOINT} ${LLM_MODEL_NAME} ${HIDE_CHARTDB_CLOUD} ${DISABLE_ANALYTICS}' < /etc/nginx/conf.d/default.conf.template > /etc/nginx/conf.d/default.conf
# Start Nginx
nginx -g "daemon off;"
diff --git a/index.html b/index.html
index 420fe35f..4c30b83b 100644
--- a/index.html
+++ b/index.html
@@ -13,11 +13,21 @@
rel="stylesheet"
/>
<script src="/config.js"></script>
- <script
- src="https://cdn.usefathom.com/script.js"
- data-site="PRHIVBNN"
- defer
- ></script>
+ <script>
+ // Load analytics only if not disabled
+ (function() {
+ const disableAnalytics = (window.env && window.env.DISABLE_ANALYTICS === 'true') ||
+ (typeof process !== 'undefined' && process.env && process.env.VITE_DISABLE_ANALYTICS === 'true');
+
+ if (!disableAnalytics) {
+ const script = document.createElement('script');
+ script.src = 'https://cdn.usefathom.com/script.js';
+ script.setAttribute('data-site', 'PRHIVBNN');
+ script.defer = true;
+ document.head.appendChild(script);
+ }
+ })();
+ </script>
</head>
<body>
<div id="root"></div>
diff --git a/src/lib/env.ts b/src/lib/env.ts
index 19a78c5c..cd4f84fa 100644
--- a/src/lib/env.ts
+++ b/src/lib/env.ts
@@ -6,6 +6,9 @@ export const IS_CHARTDB_IO: boolean =
import.meta.env.VITE_IS_CHARTDB_IO === 'true';
export const APP_URL: string = import.meta.env.VITE_APP_URL;
export const HOST_URL: string = import.meta.env.VITE_HOST_URL ?? '';
-export const HIDE_BUCKLE_DOT_DEV: boolean =
- (window?.env?.HIDE_BUCKLE_DOT_DEV ??
- import.meta.env.VITE_HIDE_BUCKLE_DOT_DEV) === 'true';
+export const HIDE_CHARTDB_CLOUD: boolean =
+ (window?.env?.HIDE_CHARTDB_CLOUD ??
+ import.meta.env.VITE_HIDE_CHARTDB_CLOUD) === 'true';
+export const DISABLE_ANALYTICS: boolean =
+ (window?.env?.DISABLE_ANALYTICS ??
+ import.meta.env.VITE_DISABLE_ANALYTICS) === 'true';
diff --git a/src/pages/editor-page/editor-page.tsx b/src/pages/editor-page/editor-page.tsx
index 82a10474..33bfe04a 100644
--- a/src/pages/editor-page/editor-page.tsx
+++ b/src/pages/editor-page/editor-page.tsx
@@ -26,7 +26,7 @@ import { Spinner } from '@/components/spinner/spinner';
import { Helmet } from 'react-helmet-async';
import { AlertProvider } from '@/context/alert-context/alert-provider';
import { CanvasProvider } from '@/context/canvas-context/canvas-provider';
-import { HIDE_BUCKLE_DOT_DEV } from '@/lib/env';
+import { HIDE_CHARTDB_CLOUD } from '@/lib/env';
import { useDiagramLoader } from './use-diagram-loader';
import { DiffProvider } from '@/context/diff-context/diff-provider';
import { TopNavbarMock } from './top-navbar/top-navbar-mock';
@@ -61,7 +61,7 @@ const EditorPageComponent: React.FC = () => {
const { initialDiagram } = useDiagramLoader();
useEffect(() => {
- if (HIDE_BUCKLE_DOT_DEV) {
+ if (HIDE_CHARTDB_CLOUD) {
return;
}