From 25065986e12619c6bcf7414681c1f214d0d05461 Mon Sep 17 00:00:00 2001 From: Sveinung Gundersen Date: Wed, 15 Nov 2023 19:05:22 +0100 Subject: [PATCH] Added note on the removal of interactivetools_shorten_url --- .../admin/special_topics/interactivetools.rst | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/source/admin/special_topics/interactivetools.rst b/doc/source/admin/special_topics/interactivetools.rst index ca306f556136..698c2d1d3d73 100644 --- a/doc/source/admin/special_topics/interactivetools.rst +++ b/doc/source/admin/special_topics/interactivetools.rst @@ -102,6 +102,28 @@ The ``gx-it-proxy`` config relates to an important service in the InteractiveToo proxy. ``gx-it-proxy`` runs as a separate process listening at port 4002 (by default). HTTP requests are decoded based on the URL and headers, then somewhat massaged, and finally forwarded to the correct entry point port of the target InteractiveTool. +.. note:: + + A previous config option ``interactivetools_shorten_url`` was removed in commit `#73100de `_ + since similar functionality is now default behavior. Setting ``interactivetools_shorten_url`` to ``true`` shortened + long interactive tool URLs (then default) from e.g. + + ``8c24e5aaae1db3a3-d0fc9f05229e40259142c4d8b5829797.interactivetoolentrypoint.interactivetool.mygalaxy.org`` + + down to + + ``8c24e5aaae1db3a3-d0fc9f0522.interactivetool.mygalaxy.org`` + + Now, all interactive tool URLs are similarly short, e.g. + + ``24q1dbzrknq1v-1a1p13jnahscj.ep.interactivetool.mygalaxy.org`` + + Note that the previous ``.interactivetoolentrypoint`` part has been shortened down to ``.ep``, but this is now always included. + For this reason, URLs are now up to ``3`` character longer than was previously the case when ``interactivetools_shorten_url`` + was set to ``true``. For deployments that require URLs to be shorter than a specific limit (for example ``63`` characters for some kubernetes + setups), this slight ``3`` character increase could cause the URLs to break the limit. If so, please adjust the + ``interactivetools_prefix`` config (default value: ``interactivetool``) to counter this. + You will also need to enable a docker destination in the job_conf.xml file. An example ``job_conf.yml`` file as seen in ``config/job_conf.yml.interactivetools``: