Access dashboard from private openhab cloud

tiller · February 23, 2021, 8:19pm

Hello,
I’m trying to setup a private openhab cloud, but I’m struggling on some things…

The main issue I run into at the moment, is to access my oh3 dashboard through the cloud, and I don’t understand how it’s supposed to work! When I install oh-cloud following the github’s documentation (setting aside nginx for the moment) I end up with ohc running on port 3000 as expected. When I connect & login, I’m greeted with “Your openHAB is online. Click here to access your openHAB’s dashboard” giving a link to the exact same url (/mydomain:3000/).

By looking into the issue both on github & here, I found out the property “proxyHost” that can be set into the config.json to point to a different host. My understanding for this is that older versions of oh used sub-folders for UI, so you could just called mydomain:3000/subfolder and it worked, but as oh3 uses the root, it has to be on a different domain for the application to understand we’re looking for the dashboard and not the main ui.
So far so good, but! How is it supposed to work? Am I just supposed to add a vhost that proxy home.mydomain.com to localhost:3000? I’ve tried it, and it didn’t seem to work. I ended up on the main page even when accessing through the domain configured in the ‘proxyHost’

! Important note ! Sometime I don’t like to do what I’m told, so for all my vhost tests I’ve been using apache2 and not nginx. But I don’t see why it wouldn’t work?

So I tried to investigate a bit more. And I found this: openhab-cloud/etc at master · openhab/openhab-cloud · GitHub
More specifically nginx_openhabcloud-production.conf, openhabcloud-main@.service and openhabcloud-web@.service. In the nginx configuration, I can see that the myopenhab and home.myopenhab do not proxy to the same destination. One to 3000, and the other to 3001. And in the service definitions, two services! One with TASK=web and one with TASK=main.
Is there any untold story that we need to run 2 instances of the app, one for the main, one for the dashboards? Or is it just a deployment choice for myopenhab?
! Note ! I tried to run another instance with PORT=3001 TASK=web because why not, and it didn’t work any better!

So yeah, I’m kind of stuck now. Any idea what my issue is? Is there something missing somewhere? Is it just “supposed to work as is” and then the issue is me using apache instead of nginx?

Thanks!

tiller · February 24, 2021, 7:56pm

Well, I just tried with nginx, and as I expected I end up with the exact same result. I just don’t understand how it’s supposed to work with the information that are provided…

tiller · February 24, 2021, 8:07pm

Ok I found the issue… but I must say it’s quite… ugly…

github.com/openhab/openhab-cloud

app.js

main


      
          /**
           * Copyright (c) 2010-2019 Contributors to the openHAB project
           *
           * See the NOTICE file(s) distributed with this work for additional
           * information.
           *
           * This program and the accompanying materials are made available under the
           * terms of the Eclipse Public License 2.0 which is available at
           * http://www.eclipse.org/legal/epl-2.0
           *
           * SPDX-License-Identifier: EPL-2.0
           */
          
          /**
           * This is the main application of the openHAB-cloud service
           *
           * @author Victor Belov - Initial contribution
           * @author Dan Cunningham - Extended Features
           * @author Mehmet Arziman - Extended Features
           *
           */
          
          // Main Logging setup
          var logger = require('./logger.js'),
              system = require('./system'),
              config;
          
          //load and set our configuration, delete any cache first
          var loadConfig = function () {
              delete require.cache[require.resolve('./config.json')];
              config = require('./config.json');
              system.setConfiguration(config);
          }
          
          loadConfig();
          
          module.exports.config = config;
          
          logger.info('Backend service is starting up...');
          
          process.on('uncaughtException', function (err) {
              console.log(JSON.stringify(err))
              logger.error(err);
          });
          
          process.on('SIGHUP', function () {
              logger.info('Reloading config...');
              loadConfig();
          });
          
          logger.info('Backend logging initialized...');
          
          // Setup all homepage
          var flash = require('connect-flash'),
              express = require('express'),
              bodyParser = require('body-parser'),
              errorHandler = require('errorhandler'),
              cookieParser = require('cookie-parser'),
              session = require('express-session'),
              favicon = require('serve-favicon'),
              csurf = require('csurf'),
              serveStatic = require('serve-static'),
              path = require('path'),
              passport = require('passport'),
              RedisStore = require('connect-redis')(session),
              redis = require('./redis-helper'),
              date_util = require('./date_util.js'),
              auth = require('./auth.js'),
              routes = require('./routes'),
              MongoConnect = require('./system/mongoconnect'),
              mongoose = require('mongoose'),
              cachegoose = require('recachegoose'),
              mongooseTypes = require('mongoose-types'),
              SocketIO = require('./socket-io');
          
          
          cachegoose(mongoose, {
              engine: 'redis',
              port: config.redis.port,
              host: config.redis.host,
              password: config.redis.password,
          });
          
          // Try to setup a mongodb connection, otherwise stopping
          var mongoConnect = new MongoConnect(system);
          mongoConnect.connect(mongoose);
          mongooseTypes.loadTypes(mongoose);
          
          var app = express();
          
          var every5MinStatJob = require('./jobs/every5minstat');
          every5MinStatJob.start();
          
          // Configurable support for cross subdomain cookies
          var cookie = {};
          if (config.system.subDomainCookies) {
              cookie.path = '/';
              cookie.domain = '.' + system.getHost();
              logger.info('Cross sub domain cookie support is configured for domain: ' + cookie.domain);
          }
          
          // Configure the openHAB-cloud for development mode, if in development
          if (app.get('env') === 'development') {
              app.use(errorHandler());
          }
          if (system.getLoggerMorganOption()) {
              app.use(system.getLoggerMorganOption());
          }
          // App configuration for all environments
          app.set('port', process.env.PORT || 3000);
          app.set('views', __dirname + '/views');
          app.set('view engine', 'ejs');
          app.use(favicon(__dirname + '/public/img/favicon.ico'));
          app.use(bodyParser.json({ verify: function (req, res, buf) { req.rawBody = buf } }))
          app.use(bodyParser.urlencoded({
              verify: function (req, res, buf) { req.rawBody = buf },
              extended: true
          }));
          app.use(cookieParser(config.express.key));
          app.use(session({
              secret: config.express.key,
              store: new RedisStore({
                  host: 'localhost',
                  port: 6379,
                  client: redis,
                  logErrors: true
              }),
              cookie: cookie,
              resave: false,
              saveUninitialized: false
          }));
          app.use(flash());
          app.use(passport.initialize());
          app.use(passport.session());
          //TODO we need to remove this hack, its leftover from long ago.
          //we need to know if this is a proxy connection or not (home/remote), other middleware depends on it.
          app.use(function (req, res, next) {
              var host = req.headers.host;
              //  console.log(host);
              if (!host) {
                  next(); // No host in header, just go ahead
              }
              // If host matches names for full /* proxying, go ahead and just proxy it.
              if (host.indexOf('remote.') === 0 || host === system.getProxyHost()) {
                  //make sure this was not set by another server
                  if (req.url.indexOf('/remote') != 0) {
                      req.url = '/remote' + req.url;
                  }
              }
              next();
          });
          app.use(function (req, res, next) {
              var csrf = csurf();
              // Check if url needs csrf, remote connections and REST connections are excluded from CSRF
              if (!req.path.match('/api/*') && !req.path.match('/rest*') && !req.path.match('/oauth2/token') && !req.path.match('/ifttt/*') && !req.path.match('/remote/*'))
                  csrf(req, res, next);
              else
                  next();
          });
          app.use(function (req, res, next) {
              if (typeof req.csrfToken === 'function') {
                  res.locals.token = req.csrfToken();
              }
              next();
          });
          // Add global usable locals for templates
          app.use(function (req, res, next) {
              res.locals.baseurl = system.getBaseURL();
              res.locals.proxyUrl = system.getProxyURL();
          
              if (req.session.timezone) {
                  res.locals.timeZone = req.session.timezone;
              } else {
                  res.locals.timeZone = 'undefined';
              }
          
              res.locals.date_util = date_util;
          
              res.locals.legal = false;
              if (config.legal) {
                  res.locals.legal = true;
                  res.locals.terms = config.legal.terms;
                  res.locals.policy = config.legal.policy;
              }
              res.locals.registration_enabled = system.isUserRegistrationEnabled();
              next();
          });
          app.use(serveStatic(path.join(__dirname, 'public')));
          
          var server = app.listen(system.getNodeProcessPort(), config.system.listenIp, function () {
              logger.info('express server listening on port ' + system.getNodeProcessPort());
          });
          
          // setup socket.io connections from openHABs
          var socketIO = new SocketIO(server, system);
          // setup the routes for the app
          var rt = new routes(logger);
          rt.setSocketIO(socketIO);
          rt.setupRoutes(app);
          
          function shutdown() {
              // Stop accepting new requests
              socketIO.shutDown().then(() => {
                  server.close((err) => {
                      if (err) {
                          console.error('Error while shutting down:', err);
                          process.exit(1);
                      }
                      process.exit(0);
                  });
                  logger.info('will wait up to 5 seconds to shut down');
                  setTimeout(() => {
                      process.exit(0);
                  }, 5000);
          
              });
              logger.info('Stopping every5min statistics job');
              every5MinStatJob.stop();
          }
          
          process.on('SIGINT', function () {
              logger.info('frontend is shutting down from SIGINT');
              shutdown();
          });
          
          process.on('SIGTERM', function () {
              logger.info('frontend is shutting down from SIGTERM');
              shutdown();
          });

This file has been truncated. show original

The redirect only works with the subdomain starts with “remote.” or “home.”. My subdomain was different…
Sorry for the post I guess

Wolfgang_S · February 24, 2021, 8:11pm

but didn’t you write in your first post that you tried home.mydomain.com ?

tiller · February 24, 2021, 8:20pm

Yes sorry. I wanted to anonymize my domain so I replaced it with “what would be expected”. Never would I have imagined that the subdomain name was a hardcoded string in the app’s code…