From fed86eb598345f35b02678c1d7d2fcdae948a327 Mon Sep 17 00:00:00 2001 From: Nate Coraor Date: Fri, 22 Feb 2019 13:30:02 -0500 Subject: [PATCH] Remove cookie_path configuration documentation since it's now set automatically. --- config/galaxy.yml.sample | 7 ------- config/reports.yml.sample | 7 ------- config/tool_shed.yml.sample | 7 ------- doc/source/admin/apache.md | 10 +--------- doc/source/admin/galaxy_options.rst | 14 -------------- doc/source/admin/nginx.md | 10 +--------- doc/source/admin/reports_options.rst | 15 --------------- lib/galaxy/webapps/galaxy/config_schema.yml | 11 ----------- lib/galaxy/webapps/reports/config_schema.yml | 8 -------- lib/galaxy/webapps/tool_shed/config_schema.yml | 11 ----------- 10 files changed, 2 insertions(+), 98 deletions(-) diff --git a/config/galaxy.yml.sample b/config/galaxy.yml.sample index a875e39b5ca..c7381a87c8f 100644 --- a/config/galaxy.yml.sample +++ b/config/galaxy.yml.sample @@ -98,13 +98,6 @@ uwsgi: galaxy: - # When running multiple Galaxy instances under separate URL prefixes - # on a single hostname, you will want to set this to the same path as - # the prefix set in the uWSGI "mount" configuration option above. This - # value becomes the "path" attribute set in the cookie so the cookies - # from one instance will not clobber those from another. - #cookie_path: '' - # By default, Galaxy uses a SQLite database at # 'database/universe.sqlite'. You may use a SQLAlchemy connection # string to specify an external database instead. This string takes diff --git a/config/reports.yml.sample b/config/reports.yml.sample index 1855c8f427b..5ca6bdd5008 100644 --- a/config/reports.yml.sample +++ b/config/reports.yml.sample @@ -80,13 +80,6 @@ uwsgi: reports: - # When running multiple Galaxy Reports instances under separate URL - # prefixes on a single hostname, you will want to set this to the same - # path as the prefix set in the uWSGI "mount" configuration option - # above. This value becomes the "path" attribute set in the cookie so - # the cookies from one instance will not clobber those from another. - #cookie_path: null - # Verbosity of console log messages. Acceptable values can be found # here: https://docs.python.org/2/library/logging.html#logging-levels #log_level: DEBUG diff --git a/config/tool_shed.yml.sample b/config/tool_shed.yml.sample index 939a88b2100..31c2fe7087f 100644 --- a/config/tool_shed.yml.sample +++ b/config/tool_shed.yml.sample @@ -351,13 +351,6 @@ tool_shed: # store this information. #citation_cache_lock_dir: database/citations/lock - # When running multiple Tool Shed instances under separate URL - # prefixes on a single hostname, you will want to set this to the same - # path as the prefix set in the uWSGI "mount" configuration option - # above. This value becomes the "path" attribute set in the cookie so - # the cookies from one instance will not clobber those from another. - #cookie_path: null - # Turn on logging of user actions to the database. Actions currently # logged are grid views, tool searches, and use of "recently" used # tools menu. The log_events and log_actions functionality will diff --git a/doc/source/admin/apache.md b/doc/source/admin/apache.md index 81b070a5329..d92d144d3e9 100644 --- a/doc/source/admin/apache.md +++ b/doc/source/admin/apache.md @@ -223,8 +223,7 @@ previous section: ``` 2. The Galaxy application needs to be aware that it is running with a prefix (for generating URLs in dynamic pages). - This is accomplished by configuring uWSGI and Galaxy (the `uwsgi` and `galaxy` sections in `config/galaxy.yml` - respectively) like so and restarting Galaxy: + This is accomplished by configuring uWSGI (the `uwsgi` section in `config/galaxy.yml`) like so and restarting Galaxy: ```yaml uwsgi: @@ -234,15 +233,8 @@ previous section: manage-script-name: true # `module` MUST NOT be set when `mount` is in use #module: galaxy.webapps.galaxy.buildapp:uwsgi_app() - - galaxy: - #... - cookie_path: /galaxy ``` - `cookie_path` should be set to prevent Galaxy's session cookies from clobbering each other if you are running more - than one instance of Galaxy under different URL prefixes on the same hostname. - Be sure to consult the [Scaling and Load Balancing](scaling.md) documentation, other options unrelated to proxying should also be set in the `uwsgi` section of the config. diff --git a/doc/source/admin/galaxy_options.rst b/doc/source/admin/galaxy_options.rst index ec1b6e8e611..0620457d9ad 100644 --- a/doc/source/admin/galaxy_options.rst +++ b/doc/source/admin/galaxy_options.rst @@ -1,17 +1,3 @@ -~~~~~~~~~~~~~~~ -``cookie_path`` -~~~~~~~~~~~~~~~ - -:Description: - When running multiple Galaxy instances under separate URL prefixes - on a single hostname, you will want to set this to the same path - as the prefix set in the uWSGI "mount" configuration option above. - This value becomes the "path" attribute set in the cookie so the - cookies from one instance will not clobber those from another. -:Default: ```` -:Type: str - - ~~~~~~~~~~~~~~~~~~~~~~~ ``database_connection`` ~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/admin/nginx.md b/doc/source/admin/nginx.md index 482659b5271..a40646ac698 100644 --- a/doc/source/admin/nginx.md +++ b/doc/source/admin/nginx.md @@ -215,8 +215,7 @@ previous section: ``` 2. The Galaxy application needs to be aware that it is running with a prefix (for generating URLs in dynamic pages). - This is accomplished by configuring uWSGI and Galaxy (the `uwsgi` and `galaxy` sections in `config/galaxy.yml` - respectively) like so and restarting Galaxy: + This is accomplished by configuring uWSGI (the `uwsgi` section in `config/galaxy.yml`) like so and restarting Galaxy: ```yaml uwsgi: @@ -226,15 +225,8 @@ previous section: manage-script-name: true # `module` MUST NOT be set when `mount` is in use #module: galaxy.webapps.galaxy.buildapp:uwsgi_app() - - galaxy: - #... - cookie_path: /galaxy ``` - `cookie_path` should be set to prevent Galaxy's session cookies from clobbering each other if you are running more - than one instance of Galaxy under different URL prefixes on the same hostname. - Be sure to consult the [Scaling and Load Balancing](scaling.md) documentation, other options unrelated to proxying should also be set in the `uwsgi` section of the config. diff --git a/doc/source/admin/reports_options.rst b/doc/source/admin/reports_options.rst index dd36b29bacf..ce307a2cab9 100644 --- a/doc/source/admin/reports_options.rst +++ b/doc/source/admin/reports_options.rst @@ -1,18 +1,3 @@ -~~~~~~~~~~~~~~~ -``cookie_path`` -~~~~~~~~~~~~~~~ - -:Description: - When running multiple Galaxy Reports instances under separate URL - prefixes on a single hostname, you will want to set this to the - same path as the prefix set in the uWSGI "mount" configuration - option above. This value becomes the "path" attribute set in the - cookie so the cookies from one instance will not clobber those - from another. -:Default: ``None`` -:Type: str - - ~~~~~~~~~~~~~ ``log_level`` ~~~~~~~~~~~~~ diff --git a/lib/galaxy/webapps/galaxy/config_schema.yml b/lib/galaxy/webapps/galaxy/config_schema.yml index edb17277c5b..a935fde6779 100644 --- a/lib/galaxy/webapps/galaxy/config_schema.yml +++ b/lib/galaxy/webapps/galaxy/config_schema.yml @@ -25,17 +25,6 @@ mapping: required: true mapping: - cookie_path: - type: str - default: '' - required: false - desc: | - When running multiple Galaxy instances under separate URL prefixes on a - single hostname, you will want to set this to the same path as the prefix set - in the uWSGI "mount" configuration option above. This value becomes the "path" - attribute set in the cookie so the cookies from one instance will not clobber - those from another. - database_connection: type: str default: sqlite:///./database/universe.sqlite?isolation_level=IMMEDIATE diff --git a/lib/galaxy/webapps/reports/config_schema.yml b/lib/galaxy/webapps/reports/config_schema.yml index 57f8d7b4f46..855bc27c9d9 100644 --- a/lib/galaxy/webapps/reports/config_schema.yml +++ b/lib/galaxy/webapps/reports/config_schema.yml @@ -7,14 +7,6 @@ mapping: desc: | Galaxy Reports configuration options. mapping: - cookie_path: - type: str - desc: | - When running multiple Galaxy Reports instances under separate URL prefixes on a - single hostname, you will want to set this to the same path as the prefix set - in the uWSGI "mount" configuration option above. This value becomes the "path" - attribute set in the cookie so the cookies from one instance will not clobber - those from another. log_level: type: str diff --git a/lib/galaxy/webapps/tool_shed/config_schema.yml b/lib/galaxy/webapps/tool_shed/config_schema.yml index 430764a6f26..92e2e6466ca 100644 --- a/lib/galaxy/webapps/tool_shed/config_schema.yml +++ b/lib/galaxy/webapps/tool_shed/config_schema.yml @@ -516,17 +516,6 @@ mapping: external sources such as https://doi.org/ by Galaxy - the following parameters can be used to control the caching used to store this information. - cookie_path: - type: str - default: null - required: false - desc: | - When running multiple Tool Shed instances under separate URL prefixes on a - single hostname, you will want to set this to the same path as the prefix set - in the uWSGI "mount" configuration option above. This value becomes the "path" - attribute set in the cookie so the cookies from one instance will not clobber - those from another. - log_actions: type: bool default: true