Enable path-based interactive tools

[kysrpex]

Enable access via path (e.g. https://usegalaxy.eu/interactivetool/ep/3qg8nstfnl44r/fsjbqy66kln5) to interactive tools that support it (those for which requires_domain="False" in the tool's xml file).

More information:

• nginx configuration: https://docs.galaxyproject.org/en/master/admin/special_topics/interactivetools.html#nginx-proxy-server-configuration-in-production
• interactive tools proxy configuration: Support high-availability setups for the interactive tools proxy galaxyproject/galaxy#18481 (comment), https://github.com/galaxyproject/gx-it-proxy/blob/v0.0.6/lib/proxy.js#L101-L141, https://github.com/galaxyproject/gx-it-proxy/blob/v0.0.6/lib/main.js#L16

Related commit: usegalaxy-eu/galaxy@e216b45

[kysrpex]

Ping @sveinugu (just FYI)

[sveinugu]

Great!

Could you also update the ansible playbook example you mentioned?

[sanjaysrikakulam]

It looks good from my side. With this change, both subdomain and path-based ITs will work.

For path-based, the tool XML wrapper should set requires_domain="False" requires_path_in_url="True", right and rest would automagically work.

Let's wait for @bgruening's review.

[sanjaysrikakulam]

I have a question: I see on the main nginx conf that the path /gie_proxy is suffixed after the port here. Is that necessary for this proxy_pass as well?

[kysrpex]

Actually, I do not know what the path

	# Global GIE configuration
	location /gie_proxy {
		proxy_pass http://127.0.0.1:8800/gie_proxy;
		proxy_redirect off;
	}

does (maybe @hexylena has a clue? <- git blame). As far as I know, the configuration that is making domain-based interactive tools work is this one.

	server_name ~^(?<key>[0-9a-z-]*)\.ep\.interactivetool\.(?<domain>[a-z0-9.-]*)usegalaxy\.eu$;

	[...]

	location / {
		proxy_pass http://127.0.0.1:8800;
		proxy_redirect off;
		proxy_http_version 1.1;
		proxy_set_header Host $host;
		proxy_set_header Upgrade $http_upgrade;
		proxy_set_header Connection $connection_upgrade;
	}

See also the Galaxy docs. Both in the excerpt above and the Galaxy docs you can see that it is not necessary to add the prefix again, regardless of whether the tool is domain-based or path-based. I assume it's needed only if you want special behavior (e.g. alter the prefix).

Edit: testing galaxyproject/galaxy#18481 involved configuring nginx for both types of interactive tools, and they work fine, no extra prefix needed.

[sveinugu]

True. Adding an extra prefix would OTOH mess up path-based ITs.

Also the solution for supporting path-based ITs might differ from tool to tool. The config @sanjaysrikakulam refers to above will work if all paths in the web server in the IT are relative. If not, other solutions for injecting the path are available, as
documented in the Galaxy admin docs.

[bgruening]

Interesting! Thanks @kysrpex! If this gets merged I will remove my commit in our Galaxy fork and we can try.

[kysrpex]

Great!

Could you also update the ansible playbook example you mentioned?

@sveinugu Commit a97941b would not be valid without having updated the Ansible role, see the latest release from 2h ago and the comment on the new README.

# configuring this path prefix enables path-based interactive tools
# (https://docs.galaxyproject.org/en/master/admin/special_topics/interactivetools.html#nginx-proxy-server-configuration-in-production)
gie_proxy_path_prefix: /interactivetool/ep  

[bgruening]

So if someone presses merge here, I will remove the commit in the galaxy repo and redeploy :)