Changes between Initial Version and Version 1 of TracSlimTimerPluginInstallation

Apr 27, 2007, 7:43:36 AM (11 years ago)

Initial version


  • TracSlimTimerPluginInstallation

    v1 v1  
     1= TracSlimTimerPlugin installation =
     3'''Most of all read [ TracPlugins]. Also, if you get stuck [ PluginDevelopment] is very useful.'''
     5 1. Install the plugin. If you want to run it from source you might use something like,
     8/opt/trac/0.10.3/install/bin/python develop -md /var/trac/0.10.3/var/trac/plugins
     11Otherwise you can can make the egg and use `easy_install`. e.g.
     14/opt/trac/0.10.3/install/bin/python bdist_egg
     17Then run `/opt/trac/0.10.3/install/bin/easy_install <egg>` where `<egg>` is whatever got dumped in your `dist` directory.
     19You might have some trouble with dependencies. If you do check below under [#dependencies Dependencies] below.
     21 2. Enable the plugin in trac.ini. For example, in `/var/trac/0.10.3/var/trac/conf/trac.ini.` you should add `tracslimtimer.* = enabled` under `[components]`, e.g.
     27tracslimtimer.* = enabled
     30 3. Upgrade (setup) the environment for the plugin by running trac-admin, e.g.
     33/opt/trac/0.10.3/install/bin/trac-admin /var/trac/0.10.3/var/trac upgrade
     36This adds the slimtimer_id custom ticket field. If you skip this step you'll probably get an error in the error.log (see below for more information on troubleshooting).
     39[Tue Apr 24 12:50:34 2007] [error] [client] PythonHandler trac.web.modpython_frontend: TracError: The Trac Environment needs to be upgraded. Run trac-admin /var/trac/0.10.3/var/trac upgrade", referer: ...
     42 4. Restart the trac server, e.g.
     45/opt/trac/0.10.3/install/etc/init.d/httpd restart
     50<a name="dependencies"/>
     52== Dependencies ==
     54If you have trouble with installation it may well be because of the dependencies. There are two dependencies: !ElementTree and MySQL-python aka MySQLdb.
     56The main dependency of is !ElementTree. It is listed as a dependency in `` file so if you're  lucky simply installing the egg might result in the !ElementTree module being downloaded. Chances are though you will have trouble here. The best option is just to `easy_install` it.
     58You can learn all about `easy_install` at:
     60Make sure you use trac's version of `easy_install`, e.g.
     63e.g. /opt/trac/0.10.3/install/bin/easy_install
     66Running this version of `easy_install` will mean the packages are installed in the appropriate site-packages folder so trac's version of Python can find them.
     68So just try something like:
     71/opt/trac/0.10.3/install/bin/easy_install elementtree
     74After installing, you'll need to restart the trac server. This can be done like so:
     77/opt/trac/0.10.3/install/etc/init.d/httpd restart
     80The other dependency is MySQL-python. This module can also be installed using `easy_install` and implements the Python DB-API for MySQL.
     82NOTE: The latest version of MySQL-python that is compatible with Python 2.3 does not support the authentication protocol used by some MySQL servers. You must use at least Python 2.4 so that you can use the most recent version of MySQL-python.
     84== Troubleshooting ==
     86'''1. Just disable the plugin'''
     88If you run in to trouble the easiest thing to do so you can keep working is just to disable the !TracSlimTimer plugin. Go to the admin page in trac, Plugins, !TracSlimTimer 0.1.0. Then untick the "Enable" box next to each component (although it is probably only the `TracSlimTimerTicketChangeListener` component that will get in your way). Select "Apply Changes" and restart trac.
     90'''2. Inspect the logs'''
     92If you actually want to fix the problem you should start with the logs:
     94 * `/var/trac/0.10.3/log/httpd/trac.log` — This is usually the most helpful log. You can set the logging level to 'debug' under the Administration page (see 'General', 'Logging'). The !TracSlimTimer plugin writes quite a few things to this log so it's worth a look.
     95 * `/var/trac/0.10.3/log/httpd/error.log` — Sometimes errors show up here. I think these are mostly errors encountered while loading plugins like syntax errors.
     97'''3. But I've got nothing'''
     99I came across one occasion where the whole web server would just crash with no log, nothing, just a seg fault. The problem seemed to be that Apache's version of expat (1.95.7) was conflicting with Python's (1.95.8). It would happen whenever a module was loaded that used expat (e.g. elementtree and I think genshi too). The solution was simply to upgrade the system (and also Apache's) expat to 1.95.8. See [ this article] for details.
     101'''4. Restart'''
     103So you've changed the code and yet you're still getting the problem? I don't know how Python/trac's caching works but often it doesn't reload the file properly. One way to ensure the file is reloaded is to restart trac:
     106/opt/trac/0.10.3/install/etc/init.d/httpd restart
     109== Summary of important paths ==
     111On my setup here are the places to look:
     113`/opt/trac/0.10.3/install/bin` — trac's version of Python, easy_install etc.
     115`/var/trac/0.10.3/var/trac/plugins` — trac plugins (eggs)
     117`/var/trac/0.10.3/var/trac/conf` — trac configuration (including trac.ini and !TracSlimTimer's users.xml)
     119`/var/trac/0.10.3/log/httpd` — trac logs (and logs from the module)
     121`/var/trac/0.10.3/log/time_report.log` — reporting module log
     123`/opt/trac/0.10.3/install/etc/init.d/httpd restart` — The command to restart trac (including Apache)