Make all routes relative to ROOT_URL to support reverse proxies

[johipsum]

Add ROOT_URL support.

Issues:

• Iron-router behind nginx proxy iron-router#154 - Iron-router behind nginx proxy
• Evaluate route paths relative to ROOT_URL parameter iron-router#848 - Evaluate route paths relative to ROOT_URL parameter
• Reverse Proxy Nginx iron-router#875 - Reverse Proxy Nginx
• app deployed in subfolder instead of root of the domain iron-router#1454 - app deployed in subfolder instead of root of the domain

[inka]

+1

[bogdanrn]

Any news on this?

[awatson1978]

Can we get this PR merged in? It's much needed and appreciated functionality.

[awatson1978]

Any chance of getting a status update on this PR? We're needing to go live on a project with this functionality; and are debating whether we need to fork the packages or not. Thanks!

[MaximusDecimus]

+1

[chrisbutler]

@johdirr @awatson1978 i think the functionality definitely makes sense, but are there any side effects of this change?

[awatson1978]

Don't know. That's what version numbers are for! ;)

[johipsum]

i couldn't discover any side effects

[bogdanrn]

I'm really looking forward to this, i'm using OrionJS and they don't allow to change "/admin" path. Being able to setup the root_url will fix this annoying thing. Also i'm thinking this will help with other packages too.

In the mean time for whoever is waiting for something similar, someone pointed me towards a nice article about how to run meteor trough proxies from a subdirectory :
https://gist.github.com/soheilhy/8b94347ff8336d971ad0

[awatson1978]

So, I just forked iron:url, merged this PR in, and am not getting the prefix to work. I've tried the following syntaxes....

ROOT_URL_PATH_PREFIX=admin meteor
ROOT_URL_PATH_PREFIX="/admin" meteor
ROOT_URL_PATH_PREFIX="admin/" meteor

ROOT_URL=http://localhost:3000/admin meteor

@johdirr - Do you have a syntax example of how this is suppose to work?

[awatson1978]

Actually, just realized that all the routes are available on the ROOT_URL. It's Router.go() that's not using the ROOT_URL_PATH_PREFIX.

[awatson1978]

Wasn't able to get this full integrated. Wound up using the solution from PR #13 instead. Router with ROOT_URL support available here:

https://atmospherejs.com/?q=clinical%3Arouter

Command line installation includes:

meteor add clinical:router

And support for including in packages...

api.use('clinical:[email protected]');

[johipsum]

@awatson1978 you don't need to set the ROOT_URL_PATH_PREFIX env variable. To make you're app available at http://localhost:3000/admin just run meteor with

ROOT_URL=http://localhost:3000/admin meteor

Meteor is setting the __meteor_runtime_config__.ROOT_URL_PATH_PREFIX variable for you.

I just tested my PR again with the newest meteor, iron:router, iron:url, ... versions and it works fine for me. Router.go() works too. What Errors do you get?

[awatson1978]

Hi. Wasn't getting errors. It was the Router.go() command didn't add the ROOT_URL_PATH_PREFIX to the route.

We adjusted the Router.prototype.go function to look at the Meteor.absoluteUrl() path to get the path prefix, since absoluteUrl sends the necessary ROOT_URL at the right time for the client side templates to parse it.

Router.prototype.go = function (routeNameOrPath, params, options) {
  var self = this;
  var isPath = /^\/|http/;
  var path;
  var routeWithPrefix = routeNameOrPath;

  if (Meteor.absoluteUrl().split('/').length > 4) {
    routeWithPrefix = "/" + Meteor.absoluteUrl().split('/')[3] + routeNameOrPath;
  }

  options = options || {};

  if (isPath.test(routeWithPrefix)) {
    // it's a path!
    path = routeWithPrefix;
  } else {
    // it's a route name!
    var route = self.routes[routeWithPrefix];
    assert(route, "No route found named " + JSON.stringify(routeWithPrefix));
    path = route.path(params, _.extend(options, {throwOnMissingParams: true}));
  }

  // let Iron Location handle it and we'll pick up the change in
  // Iron.Location.get() computation.

  Iron.Location.go(path, options);
};

https://github.com/clinical-meteor/clinical-router/blob/devel/lib/router_client.js#L229

I think the consideration is that we have an edge cases where our proxy server works a bit different than your proxy server.

[chrisbutler]

@awatson1978 so we have a complete, working solution for this now?

[awatson1978]

More or less. We're moving the ckcc project into production behind a proxy server using clinical:router.

Right now we've got our app running green in our CI test environment, which doesn't use the route prefix from the ROOT_URL; but we're getting ready to do a live run with it behind the proxy server.

I suppose I could add some acceptance tests that check the prefix as well. Will need to think on that.

[chrlvclaudiu]

Thanks @awatson1978 . I ended up using clinical:router, too. my ROOT_URL var has the subfolder specified (e.g. http://domain.com/app) and meteor sets the correct path preffix.
I had some issues with configuring apache proxy using subfolder and for anyone interested here are my directives to successfully proxy to a subfolder.

[apache]
ProxyPreserveHost On
ProxyPass /app/ http://ip_address:3002/app/
ProxyPassReverse /app/ http://ip_address:3002/app/

[meteor]
export ROOT_URL=http://domain.com/app meteor

[abate]

so the accepted solution is to switch to clinical:router ? I'm in the same boat the the OP using ngnix ...

[methodbox]

I no longer use Meteor, having opted for my own templating and build system using Vue, Mongo and Express.

However, last I used Meteor, clinical-router did solve this issue. Flow router may also address this, but not sure.

[Steditor]

Any updates on this PR?