Merge branch 'self-hosted-auth' of github.com:novuhq/novu into self-hosted-auth

Author: djabarovgeorge

.cspell.json

@@ -733,6 +733,8 @@
     "oklch",
     "Duplicable",
     "Radek",
+    "automators", 
+    "VITE",
     "snooze",
     "unsnooze",
     "snoozed",

.github/workflows/prepare-self-hosted-release.yml

@@ -22,7 +22,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        name: ['novu/api', 'novu/worker', 'novu/web', 'novu/webhook', 'novu/ws']
+        name: ['novu/api', 'novu/worker', 'novu/dashboard', 'novu/webhook', 'novu/ws']
     steps:
       - name: Git Checkout
         uses: actions/checkout@v4
@@ -97,8 +97,8 @@ jobs:
 
           if [ "${{ env.SERVICE_NAME }}" == "worker" ]; then
             cd src/ && echo -e "\nIS_SELF_HOSTED=true\nOS_TELEMETRY_URL=\"${{ secrets.OS_TELEMETRY_URL }}\"" >> .example.env && cd ..
-          elif [ "${{ env.SERVICE_NAME }}" == "web" ]; then
-            echo -e "\nIS_V2_ENABLED=true" >> .env.sample
+          elif [ "${{ env.SERVICE_NAME }}" == "dashboard" ]; then
+            echo -e "\nVITE_SELF_HOSTED=true" >> .env
           fi
 
           pnpm run docker:build

apps/dashboard/docker-entrypoint.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+
+# Safely build a <script> block assigning to window._env_
+ENV_SCRIPT="<script>
+  window._env_ = {
+    VITE_API_HOSTNAME: '${VITE_API_HOSTNAME}',
+    VITE_WEBSOCKET_HOSTNAME: '${VITE_WEBSOCKET_HOSTNAME}'
+  };
+</script>"
+
+# Escape newlines for safe sed usage
+ESCAPED_SCRIPT=$(printf "%s\n" "$ENV_SCRIPT" | sed ':a;N;$!ba;s/\n/\\n/g')
+
+# Inject just before the first <script type="module"> tag
+sed -i "s@<script type=\"module\"@${ESCAPED_SCRIPT}\n<script type=\"module\"@" /app/dist/index.html
+
+# Start your app (adjust as needed, e.g. serve or nginx)
+exec "$@"

apps/dashboard/dockerfile

@@ -1,5 +1,12 @@
-FROM ghcr.io/novuhq/novu/base:1.0.0 AS builder
+FROM node:20-alpine3.19 AS builder
+RUN apk add g++ make py3-pip
+ENV NX_DAEMON=false
+
 WORKDIR /usr/src/app
+
+RUN apk add --no-cache bash
+RUN npm install -g [email protected] --loglevel notice
+
 COPY .npmrc .
 COPY package.json .
 
@@ -14,13 +21,24 @@ COPY pnpm-workspace.yaml .
 COPY pnpm-lock.yaml .
 
 RUN --mount=type=cache,id=pnpm-store-dashboard,target=/root/.pnpm-store\
-  pnpm install --frozen-lockfile
+  pnpm install --frozen-lockfile --unsafe-perm
+
 COPY [".prettierrc",".prettierignore", "./"]
-RUN pnpm build:dashboard
-
-FROM alpine:latest
-RUN apk add --no-cache busybox
-WORKDIR /www
-COPY --from=builder /usr/src/app/apps/dashboard/build /www
-EXPOSE 80
-CMD ["busybox", "httpd", "-f", "-p", "80"]
+RUN CI='' pnpm build:dashboard --skip-nx-cache
+
+FROM node:20-alpine
+
+RUN npm install -g http-server --loglevel notice
+
+USER 1000
+WORKDIR /app
+
+COPY --chown=1000:1000 --from=builder /usr/src/app/apps/dashboard/dist /app/dist
+COPY --chown=1000:1000 --from=builder /usr/src/app/apps/dashboard/package.json /app/package.json
+COPY --chown=1000:1000 --from=builder /usr/src/app/apps/dashboard/docker-entrypoint.sh /app/docker-entrypoint.sh  
+
+RUN chmod +x /app/docker-entrypoint.sh
+ENTRYPOINT [ "/app/docker-entrypoint.sh" ]
+# Expose the port the app runs on
+EXPOSE 4000
+CMD [ "http-server", "dist", "-p", "4000" ]

apps/dashboard/src/config/index.ts

@@ -12,11 +12,11 @@ export const CLERK_PUBLISHABLE_KEY = import.meta.env.VITE_CLERK_PUBLISHABLE_KEY
 
 export const APP_ID = import.meta.env.VITE_NOVU_APP_ID || '';
 
-export const API_HOSTNAME = import.meta.env.VITE_API_HOSTNAME;
+export const API_HOSTNAME = window._env_.VITE_API_HOSTNAME || import.meta.env.VITE_API_HOSTNAME;
 
 export const IS_EU = API_HOSTNAME === 'https://eu.api.novu.co';
 
-export const WEBSOCKET_HOSTNAME = import.meta.env.VITE_WEBSOCKET_HOSTNAME;
+export const WEBSOCKET_HOSTNAME = window._env_.VITE_WEBSOCKET_HOSTNAME || import.meta.env.VITE_WEBSOCKET_HOSTNAME;
 
 export const INTERCOM_APP_ID = import.meta.env.VITE_INTERCOM_APP_ID;
 

docker/community/.env.example

@@ -46,24 +46,22 @@ REDIS_CACHE_SERVICE_PORT=6379
 WS_PORT=3002
 
 # Root URL
-REACT_APP_WS_URL=$HOST_NAME:3002
-# Uncomment this one when deploying Novu in the local environment
-# as Web app local Dockerfile will have to load this to be used.
-# Deployment version doesn't need as we inject it with API_ROOT_URL value.
-# REACT_APP_API_URL=http://localhost:3000
+VITE_API_HOSTNAME=$HOST_NAME:3000
+VITE_WEBSOCKET_HOSTNAME=$HOST_NAME:3002
 API_ROOT_URL=$HOST_NAME:3000
-DISABLE_USER_REGISTRATION=false
 FRONT_BASE_URL=$HOST_NAME:4200
 WIDGET_EMBED_PATH=$HOST_NAME:4701/embed.umd.min.js
 WIDGET_URL=$HOST_NAME:4500
+IS_API_IDEMPOTENCY_ENABLED=false
+IS_API_RATE_LIMITING_ENABLED=false
+IS_NEW_MESSAGES_API_RESPONSE_ENABLED=true
+IS_V2_ENABLED=true
+IS_CONTROLS_AUTOCOMPLETE_ENABLED=false
+IS_WORKFLOW_NODE_PREVIEW_ENABLED=false
+IS_ENHANCED_DIGEST_ENABLED=-false
+IS_EMAIL_INLINE_CSS_DISABLED=false
+IS_USE_MERGED_DIGEST_ID_ENABLED=false
 
-# Context Paths
-# Only needed for setups with reverse-proxies
-GLOBAL_CONTEXT_PATH=
-WEB_CONTEXT_PATH=
-API_CONTEXT_PATH=
-WS_CONTEXT_PATH=
-WIDGET_CONTEXT_PATH=
 
 # Analytics
 SENTRY_DSN=

docker/community/docker-compose.yml

@@ -44,7 +44,6 @@ services:
     environment:
       NODE_ENV: ${NODE_ENV}
       API_ROOT_URL: ${API_ROOT_URL}
-      DISABLE_USER_REGISTRATION: ${DISABLE_USER_REGISTRATION}
       PORT: ${API_PORT}
       FRONT_BASE_URL: ${FRONT_BASE_URL}
       MONGO_URL: ${MONGO_URL}
@@ -71,6 +70,10 @@ services:
       NEW_RELIC_LICENSE_KEY: ${NEW_RELIC_LICENSE_KEY}
       API_CONTEXT_PATH: ${API_CONTEXT_PATH}
       MONGO_AUTO_CREATE_INDEXES: ${MONGO_AUTO_CREATE_INDEXES}
+      IS_API_IDEMPOTENCY_ENABLED: ${IS_API_IDEMPOTENCY_ENABLED}
+      IS_API_RATE_LIMITING_ENABLED: ${IS_API_RATE_LIMITING_ENABLED}
+      IS_NEW_MESSAGES_API_RESPONSE_ENABLED: ${IS_NEW_MESSAGES_API_RESPONSE_ENABLED}
+      IS_V2_ENABLED: ${IS_V2_ENABLED}
     ports:
       - ${API_PORT}:${API_PORT}
 
@@ -109,6 +112,9 @@ services:
       NEW_RELIC_LICENSE_KEY: ${NEW_RELIC_LICENSE_KEY}
       BROADCAST_QUEUE_CHUNK_SIZE: ${BROADCAST_QUEUE_CHUNK_SIZE}
       MULTICAST_QUEUE_CHUNK_SIZE: ${MULTICAST_QUEUE_CHUNK_SIZE}
+      API_ROOT_URL: http://api:${API_PORT}
+      IS_EMAIL_INLINE_CSS_DISABLED: ${IS_EMAIL_INLINE_CSS_DISABLED}
+      IS_USE_MERGED_DIGEST_ID_ENABLED: ${IS_USE_MERGED_DIGEST_ID_ENABLED}
 
   ws:
     image: 'ghcr.io/novuhq/novu/ws:2.1.1'
@@ -138,27 +144,27 @@ services:
     ports:
       - ${WS_PORT}:${WS_PORT}
 
-  web:
-    image: 'ghcr.io/novuhq/novu/web:2.1.1'
+  dashboard:
+    image: 'ghcr.io/novuhq/novu/dashboard:2.1.1'
     depends_on:
       - api
       - worker
-    container_name: web
+    container_name: dashboard
     restart: unless-stopped
     logging:
       driver: 'json-file'
       options:
         max-size: '50m'
         max-file: '5'
     environment:
-      REACT_APP_API_URL: ${API_ROOT_URL}
-      REACT_APP_ENVIRONMENT: ${NODE_ENV}
-      REACT_APP_WIDGET_EMBED_PATH: ${WIDGET_EMBED_PATH}
-      REACT_APP_IS_SELF_HOSTED: 'true'
-      REACT_APP_WS_URL: ${REACT_APP_WS_URL}
+      VITE_API_HOSTNAME: ${VITE_API_HOSTNAME}
+      VITE_SELF_HOSTED: true
+      VITE_WEBSOCKET_HOSTNAME: ${VITE_WEBSOCKET_HOSTNAME}
+      IS_CONTROLS_AUTOCOMPLETE_ENABLED: ${IS_CONTROLS_AUTOCOMPLETE_ENABLED}
+      IS_WORKFLOW_NODE_PREVIEW_ENABLED: ${IS_WORKFLOW_NODE_PREVIEW_ENABLED}
+      IS_ENHANCED_DIGEST_ENABLED: ${IS_ENHANCED_DIGEST_ENABLED}
     ports:
-      - 4200:4200
-    command: ['/bin/sh', '-c', 'pnpm run envsetup:docker && pnpm run start:static:build']
+      - 4000:4000
 
 volumes:
   mongodb: ~