Update galaxy.yml.sample for prefix config

galaxyproject · Jan 15, 2019 · b6d5675 · b6d5675
1 parent 105a1d8
commit b6d5675
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 6 deletions.
diff --git a/config/galaxy.yml.sample b/config/galaxy.yml.sample
@@ -66,6 +66,14 @@ uwsgi:
   # Reports, etc.) that you are loading.
   module: galaxy.webapps.galaxy.buildapp:uwsgi_app()
 
+  # Mount the web application (e.g. Galaxy, Reports, etc.) at the given
+  # prefix. Cannot be used together with 'module:' above.
+  #mount: /galaxy=galaxy.webapps.galaxy.buildapp:uwsgi_app()
+
+  # Make uWSGI rewrite PATH_INFO and SCRIPT_NAME according to mount-
+  # points. Set this to true if a prefix is used.
+  manage-script-name: false
+
   # It is usually a good idea to set this to ``true`` if processes is
   # greater than 1.
   thunder-lock: false
@@ -91,8 +99,9 @@ uwsgi:
 galaxy:
 
   # If running behind a proxy server and Galaxy is served from a
-  # subdirectory, enable the proxy-prefix filter and set the prefix in
-  # the [filter:proxy-prefix] section above.
+  # subdirectory, enable the proxy-prefix filter, uncomment the 'mount:
+  # /galaxy=galaxy.webapps.galaxy.buildapp:uwsgi_app()' line and enable
+  # `manage-script-name` in the uwsgi config section.
   #filter-with: proxy-prefix
 
   # If proxy-prefix is enabled and you're running more than one Galaxy

diff --git a/config/reports.yml.sample b/config/reports.yml.sample
@@ -48,6 +48,14 @@ uwsgi:
   # Reports, etc.) that you are loading.
   module: galaxy.webapps.reports.buildapp:uwsgi_app()
 
+  # Mount the web application (e.g. Galaxy, Reports, etc.) at the given
+  # prefix. Cannot be used together with 'module:' above.
+  #mount: /galaxy=galaxy.webapps.galaxy.buildapp:uwsgi_app()
+
+  # Make uWSGI rewrite PATH_INFO and SCRIPT_NAME according to mount-
+  # points. Set this to true if a prefix is used.
+  manage-script-name: false
+
   # It is usually a good idea to set this to ``true`` if processes is
   # greater than 1.
   thunder-lock: false

diff --git a/config/tool_shed.yml.sample b/config/tool_shed.yml.sample
@@ -48,6 +48,14 @@ uwsgi:
   # Reports, etc.) that you are loading.
   module: galaxy.webapps.tool_shed.buildapp:uwsgi_app()
 
+  # Mount the web application (e.g. Galaxy, Reports, etc.) at the given
+  # prefix. Cannot be used together with 'module:' above.
+  #mount: /galaxy=galaxy.webapps.galaxy.buildapp:uwsgi_app()
+
+  # Make uWSGI rewrite PATH_INFO and SCRIPT_NAME according to mount-
+  # points. Set this to true if a prefix is used.
+  manage-script-name: false
+
   # It is usually a good idea to set this to ``true`` if processes is
   # greater than 1.
   thunder-lock: false

diff --git a/doc/source/admin/galaxy_options.rst b/doc/source/admin/galaxy_options.rst
@@ -4,8 +4,9 @@
 
 :Description:
     If running behind a proxy server and Galaxy is served from a
-    subdirectory, enable the proxy-prefix filter and set the prefix in
-    the [filter:proxy-prefix] section above.
+    subdirectory, enable the proxy-prefix filter, uncomment the
+    'mount: /galaxy=galaxy.webapps.galaxy.buildapp:uwsgi_app()' line
+    and enable `manage-script-name` in the uwsgi config section.
 :Default: ``proxy-prefix``
 :Type: str
 

diff --git a/lib/galaxy/webapps/config_manage.py b/lib/galaxy/webapps/config_manage.py
@@ -111,6 +111,16 @@
         'default': '$uwsgi_module',
         'type': 'str',
     }),
+    ('#mount', {
+        'desc': """Mount the web application (e.g. Galaxy, Reports, etc.) at the given prefix. Cannot be used together with 'module:' above.""",
+        'default': '/galaxy=galaxy.webapps.galaxy.buildapp:uwsgi_app()',
+        'type': 'str',
+    }),
+    ('manage-script-name', {
+        'desc': """Make uWSGI rewrite PATH_INFO and SCRIPT_NAME according to mount-points. Set this to true if a prefix is used.""",
+        'default': False,
+        'type': 'bool',
+    }),
     ('thunder-lock', {
         'desc': """It is usually a good idea to set this to ``true`` if processes is greater than 1.""",
         'default': False,

diff --git a/lib/galaxy/webapps/galaxy/config_schema.yml b/lib/galaxy/webapps/galaxy/config_schema.yml
@@ -40,8 +40,8 @@ mapping:
         required: false
         desc: |
           If running behind a proxy server and Galaxy is served from a subdirectory,
-          enable the proxy-prefix filter and set the prefix in the
-          [filter:proxy-prefix] section above.
+          enable the proxy-prefix filter, uncomment the 'mount: /galaxy=galaxy.webapps.galaxy.buildapp:uwsgi_app()'
+          line and enable `manage-script-name` in the uwsgi config section.
 
       cookie_path:
         type: str