Move settings from site.conf into webwork2.mojolicious.yml #2314
Conversation
pstaabp
force-pushed
the
remove-site-conf
branch
from
4b66a34 to
d9b4005
Compare
There was a problem hiding this comment.
This is just a quick perusal of a few things, but I already see that there is a lot of work that needs to be done here. So much in fact, that I recommend not pursuing it further at this point. At least not in its entirety all at once.
How about you start with the removal of conf/database.conf.dist. Separate that into another pull request, and we will consider that. Then we will see what else here we want to pursue further after that.
One huge drawback of doing this is that those that have been using webwork will need to do a lot of work to transfer all of there site.conf settings to the webwork2.mojolicious.conf file. This is perhaps to much work when there may be only a few more releases of webwork2 before we start trying to switch to webwork3.
| in `site.conf` as needed. In particular you will need to set `$server_root_url` to the server name, and set | ||
| - Copy `webwork2.mojolicious.dist.yml` to `webwork2.mojolicious.yml` and change appropriate settings. | ||
| - Copy `localOverrides.conf.dist` to `localOverrides.conf`, and adjust the variables | ||
| as needed. In particular you will need to set `$server_root_url` to the server name, and set |
There was a problem hiding this comment.
All of these references to variables that were in site.conf need to be updated. They are no longer perl variables, and so the $ should be removed.
| @@ -14,7 +14,7 @@ | |||
| #ScriptAliasMatch /webwork2_course_files/([^/]*)/show-source.cgi/(.*) /opt/webwork/courses/$1/html/show-source.cgi/$2 | |||
| #ProxyPassMatch /webwork2_course_files/([^/]*)/show-source.cgi/(.*) ! | |||
|
|
|||
| # Note that if $webwork_url in site.conf is changed, then /webwork2 | |||
| # Note that if $webwork_url in webwork2.mojolicious.yml is changed, then /webwork2 | |||
There was a problem hiding this comment.
In this file as well, remove the $ on things reference in webwork2.mojolicious.yml. This will take some work, because this needs to be done anywhere a variable that was in site.conf and is now in webwork2.mojolicious.yml is referenced anywhere in the code or documentation files.
| @@ -1,4 +1,4 @@ | |||
| # Note that if $webwork_url in site.conf is changed, then /webwork2 | |||
| # Note that if $webwork_url in webwork2.mojolicious.yml is changed, then /webwork2 | |||
There was a problem hiding this comment.
In this file as well, remove the $ on things reference in webwork2.mojolicious.yml.
| in `site.conf` as needed. In particular you will need to set `$server_root_url` to the server name, and set | ||
| - Copy `webwork2.mojolicious.dist.yml` to `webwork2.mojolicious.yml` and change appropriate settings. | ||
| - Copy `localOverrides.conf.dist` to `localOverrides.conf`, and adjust the variables | ||
| as needed. In particular you will need to set `$server_root_url` to the server name, and set | ||
| `$database_password` to the password for the database. | ||
| - Adjust the variables in `localOverrides.conf` to customize your server for your needs. | ||
| - Copy any of the other `.dist` files and adjust the variables in them as needed. Note that those files will need to be |
There was a problem hiding this comment.
There are comments about site.conf further down in this file that need to be updated.
| # Set these variables to correspond to your configuration. It is not | ||
| # recommended to change any of the settings in this file once your | ||
| # web server has been initially configured. |
There was a problem hiding this comment.
Remove the recommendation. That is a bad recommendation. If server needs change, then the configuration will need to be changed. I know you copied it from site.conf, but don't just copy the comments. Go through them and clean them up. There was a lot of crap said in site.conf.
| # URL of WeBWorK handler. If WeBWorK is to be on the web server root, use "". Note | ||
| # that using "" may not work so we suggest sticking with "/webwork2". |
There was a problem hiding this comment.
Clearly the comments about quoting do not apply anymore. Another reason to go through the comments.
|
Let's chat about this for our next meeting. |
|
Note conflicts here now from a recent merge. |
|
I'm going to close this in favor of #2338 |
This replaces the
conf/site.conffile by adding many configuration variables toconf/webwork2.mojolicious.yml.The idea is that many of the server configurations shouldn't be overridden by course configuration in
site.conforsimple.conf. How this happens is that the new order of configurations reads is:webwork2.mojolicious.ymlis loaded and some basic configuration is done.defaults.configlocalOverrides.confsimple.confcourse.confwebwork2.mojolicious.ymlto CourseEnvironment.Note that the URL and directory structure is now included in
webwork2.mojolicious.ymlso that has been removed fromdefaults.config.Since yaml files cannot contain code, the loading of
webwork2.mojolicious.ymlis not done in the safe compartment.Also, the code in
conf/database.conf.disthas been moved tolib/WeBWorK/DB/Utils.pm-- This can be moved elsewhere if there is a better place for it. This was removed because it doesn't appear that there are the options that we used to allow in earlier versions.Another strange thing that I noticed that when the session times out, I couldn't log back in. The addition of including the password on line 362 of
lib/WeBWorK/Authen.pmfixed this, but I can't figure out how this work has changed that, but also, why the password was missing from that block.Some other ideas I've thought about:
webwork2.mojolicious.yml, we can move much of this to a different yaml file.defaults.configto yaml files that wouldn't need to be loaded in the Safeconfigobject or other helpers. Note: @drgrice1 suggested this, but will require rewriting a bunch of the codebase for a new location.