Making the dashboard optional

src/@types/OceanNode.ts

@@ -40,6 +40,7 @@ export interface OceanNodeConfig {
   hasIndexer: boolean
   hasProvider: boolean
   hasHttp: boolean
+  hasDashboard: boolean
   dbConfig?: OceanNodeDBConfig
   httpPort: number
   feeStrategy: FeeStrategy

src/index.ts

@@ -125,22 +125,24 @@ if (config.hasHttp) {
   app.use(express.raw({ limit: '25mb' }))
   app.use(cors())
 
-  // Serve static files expected at the root, under the '/_next' path
-  app.use('/_next', express.static(path.join(__dirname, '/dashboard/_next')))
-
-  // Serve static files for Next.js under '/dashboard'
-  const dashboardPath = path.join(__dirname, '/dashboard')
-  app.use('/dashboard', express.static(dashboardPath))
-
-  // Custom middleware for SPA routing: Serve index.html for non-static asset requests under '/dashboard'
-  app.use('/dashboard', (req, res, next) => {
-    if (/(.ico|.js|.css|.jpg|.png|.svg|.map)$/i.test(req.path)) {
-      return next() // Skip this middleware if the request is for a static asset
-    }
+  if (config.hasDashboard) {
+    // Serve static files expected at the root, under the '/_next' path
+    app.use('/_next', express.static(path.join(__dirname, '/dashboard/_next')))
+
+    // Serve static files for Next.js under '/dashboard'
+    const dashboardPath = path.join(__dirname, '/dashboard')
+    app.use('/dashboard', express.static(dashboardPath))
+
+    // Custom middleware for SPA routing: Serve index.html for non-static asset requests under '/dashboard'
+    app.use('/dashboard', (req, res, next) => {
+      if (/(.ico|.js|.css|.jpg|.png|.svg|.map)$/i.test(req.path)) {
+        return next() // Skip this middleware if the request is for a static asset
+      }
 
-    // For any other requests under '/dashboard', serve index.html
-    res.sendFile(path.join(dashboardPath, 'index.html'))
-  })
+      // For any other requests under '/dashboard', serve index.html
+      res.sendFile(path.join(dashboardPath, 'index.html'))
+    })
+  }
 
   // allow up to 25Mb file upload
   app.use((req, res, next) => {

src/utils/config.ts

@@ -405,6 +405,7 @@ async function getEnvConfig(isStartup?: boolean): Promise<OceanNodeConfig> {
     },
     // Only enable provider if we have a DB_URL
     hasProvider: !!getEnvValue(process.env.DB_URL, ''),
+    hasDashboard: process.env.DASHBOARD !== 'false',
     httpPort: getIntEnvValue(process.env.HTTP_API_PORT, 8000),
     dbConfig: {
       url: getEnvValue(process.env.DB_URL, '')

src/utils/constants.ts

@@ -194,5 +194,10 @@ export const ENVIRONMENT_VARIABLES: Record<any, EnvVariable> = {
     name: 'ALLOWED_ADMINS',
     value: process.env.ALLOWED_ADMINS,
     required: false
+  },
+  DASHBOARD: {
+    name: 'DASHBOARD',
+    value: process.env.DASHBOARD,
+    required: false
   }
 }