remove Paste config option, reword URL prefix

galaxyproject · Feb 19, 2019 · d72f82d · d72f82d
1 parent b6d5675
commit d72f82d
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 39 deletions.
diff --git a/config/galaxy.yml.sample b/config/galaxy.yml.sample
@@ -67,11 +67,11 @@ uwsgi:
   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.
+  # URL 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.
+  # points. Set this to true if a URL prefix is used.
   manage-script-name: false
 
   # It is usually a good idea to set this to ``true`` if processes is
@@ -98,17 +98,17 @@ uwsgi:
 
 galaxy:
 
-  # If running behind a proxy server and Galaxy is served from a
-  # 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
-  # instance behind one hostname, you will want to set this to the same
-  # path as the prefix in the filter above.  This value becomes the
-  # "path" attribute set in the cookie so the cookies from each instance
-  # will not clobber each other.
+  # If not running behind a proxy server, you may want to enable gzip
+  # compression to decrease the size of data transferred over the
+  # network.  If using a proxy server, please enable gzip compression
+  # there instead.
+  #filter-with: gzip
+
+  # If you serve Galaxy at a URL prefix and you're running more than one
+  # Galaxy instance behind one hostname, you will want to set this to
+  # the same path as the prefix in the filter above.  This value becomes
+  # the "path" attribute set in the cookie so the cookies from each
+  # instance will not clobber each other.
   #cookie_path: ''
 
   # By default, Galaxy uses a SQLite database at

diff --git a/config/reports.yml.sample b/config/reports.yml.sample
@@ -49,11 +49,11 @@ uwsgi:
   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.
+  # URL 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.
+  # points. Set this to true if a URL prefix is used.
   manage-script-name: false
 
   # It is usually a good idea to set this to ``true`` if processes is

diff --git a/config/tool_shed.yml.sample b/config/tool_shed.yml.sample
@@ -49,11 +49,11 @@ uwsgi:
   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.
+  # URL 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.
+  # points. Set this to true if a URL prefix is used.
   manage-script-name: false
 
   # It is usually a good idea to set this to ``true`` if processes is

diff --git a/doc/source/admin/galaxy_options.rst b/doc/source/admin/galaxy_options.rst
@@ -3,11 +3,11 @@
 ~~~~~~~~~~~~~~~
 
 :Description:
-    If running behind a proxy server and Galaxy is served from a
-    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``
+    If not running behind a proxy server, you may want to enable gzip
+    compression to decrease the size of data transferred over the
+    network.  If using a proxy server, please enable gzip compression
+    there instead.
+:Default: ``gzip``
 :Type: str
 
 
@@ -16,11 +16,11 @@
 ~~~~~~~~~~~~~~~
 
 :Description:
-    If proxy-prefix is enabled and you're running more than one Galaxy
-    instance behind one hostname, you will want to set this to the
-    same path as the prefix in the filter above.  This value becomes
-    the "path" attribute set in the cookie so the cookies from each
-    instance will not clobber each other.
+    If you serve Galaxy at a URL prefix and you're running more than
+    one Galaxy instance behind one hostname, you will want to set this
+    to the same path as the prefix in the filter above.  This value
+    becomes the "path" attribute set in the cookie so the cookies from
+    each instance will not clobber each other.
 :Default: ````
 :Type: str
 

diff --git a/lib/galaxy/webapps/config_manage.py b/lib/galaxy/webapps/config_manage.py
@@ -112,12 +112,12 @@
         'type': 'str',
     }),
     ('#mount', {
-        'desc': """Mount the web application (e.g. Galaxy, Reports, etc.) at the given prefix. Cannot be used together with 'module:' above.""",
+        'desc': """Mount the web application (e.g. Galaxy, Reports, etc.) at the given URL 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.""",
+        'desc': """Make uWSGI rewrite PATH_INFO and SCRIPT_NAME according to mount-points. Set this to true if a URL prefix is used.""",
         'default': False,
         'type': 'bool',
     }),

diff --git a/lib/galaxy/webapps/galaxy/config_schema.yml b/lib/galaxy/webapps/galaxy/config_schema.yml
@@ -34,21 +34,12 @@ mapping:
           to decrease the size of data transferred over the network.  If using a proxy
           server, please enable gzip compression there instead.
 
-      filter-with:
-        type: str
-        default: proxy-prefix
-        required: false
-        desc: |
-          If running behind a proxy server and Galaxy is served from a 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.
-
       cookie_path:
         type: str
         default: ''
         required: false
         desc: |
-          If proxy-prefix is enabled and you're running more than one Galaxy instance
+          If you serve Galaxy at a URL prefix and you're running more than one Galaxy instance
           behind one hostname, you will want to set this to the same path as the prefix
           in the filter above.  This value becomes the "path" attribute set in the
           cookie so the cookies from each instance will not clobber each other.