Changes between Version 2 and Version 3 of TracPlugins


Ignore:
Timestamp:
Feb 26, 2008 5:40:00 PM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPlugins

    v2 v3  
    88To use egg based plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (version 0.6) installed.
    99
    10 Plugins can also consist of a single `.py` file dropped into either the environment or global `plugins` directory ''(since [milestone:0.10])''.
    11 
    1210To install `setuptools`, download the bootstrap module [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] and execute it as follows:
    1311{{{
     
    1715If the `ez_setup.py` script fails to install the setuptools release, you can download it from [http://www.python.org/pypi/setuptools PyPI] and install it manually.
    1816
     17Plugins can also consist of a single `.py` file dropped into either the environment or global `plugins` directory ''(since [milestone:0.10])''.
     18
    1919== Installing a Trac Plugin ==
    2020
    2121=== For a Single Project ===
    2222
    23 Plugins are packaged as [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs]. That means they are ZIP archives with the file extension `.egg`. If you have downloaded a source distribution of a plugin, you can run:
     23Plugins are packaged as [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs]. That means they are ZIP archives with the file extension `.egg`.
     24
     25If you have downloaded a source distribution of a plugin, and want to build the `.egg` file, follow this instruction:
     26 * Unpack the source. It should provide a setup.py.
     27 * Run:
    2428{{{
    2529$ python setup.py bdist_egg
    2630}}}
    27 to build the `.egg` file.
     31
     32Then you will have a *.egg file. Examine the output of running python to find where this was created.
    2833
    2934Once you have the plugin archive, you need to copy it into the `plugins` directory of the [wiki:TracEnvironment project environment]. Also, make sure that the web server has sufficient permissions to read the plugin egg.
     
    3944==== With an .egg file ====
    4045
    41 Some plugins (such as [http://trac.edgewall.org/wiki/WebAdmin WebAdmin]) are downloadable as a `.egg` file which can be installed with the `easy_install` program:
     46Some plugins (such as [http://trac.edgewall.org/wiki/SpamFilter SpamFilter]) are downloadable as a `.egg` file which can be installed with the `easy_install` program:
    4247{{{
    43 easy_install TracWebAdmin-0.1.1dev_r2765-py2.3.egg
     48easy_install TracSpamFilter
    4449}}}
    4550
     
    4853If Trac reports permission errors after installing a zipped egg and you would rather not bother providing a egg cache directory writable by the web server, you can get around it by simply unzipping the egg. Just pass `--always-unzip` to `easy_install`:
    4954{{{
    50 easy_install --always-unzip TracWebAdmin-0.1.1dev_r2765-py2.3.egg
     55easy_install --always-unzip TracSpamFilter-0.2.1dev_r5943-py2.4.egg
    5156}}}
    5257You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents.
    5358
    54 Trac also searches for globally installed plugins under `$prefix/share/trac/plugins` ''(since 0.10)''.
     59Trac also searches for globally installed plugins under `$PREFIX/share/trac/plugins` ''(since 0.10)''.
    5560
    5661==== From source ====
    5762
    58 If you downloaded the plugin's source from Subversion, or a source zip file you can install it using the included `setup.py`:
     63`easy_install` makes installing from source a snap. Just give it the URL to either a Subversion repository or a tarball/zip of the source:
    5964{{{
    60 $ python setup.py install
     65easy_install http://svn.edgewall.com/repos/trac/sandbox/spam-filter
    6166}}}
    6267
     
    6570{{{
    6671[components]
    67 webadmin.* = enabled
     72tracspamfilter.* = enabled
    6873}}}
    6974
    70 The name of the option is the Python package of the plugin. This should be specified in the documentation of the Plugin, but can also be easily find out by looking at the source (look for a top-level directory that contains a file named `__init__.py`.)
     75The name of the option is the Python package of the plugin. This should be specified in the documentation of the plugin, but can also be easily discovered by looking at the source (look for a top-level directory that contains a file named `__init__.py`.)
    7176
    72 Note: After installing the plugin, you may need to restart Apache.
     77Note: After installing the plugin, you need to restart your web server.
    7378
    7479== Setting up the Plugin Cache ==
     
    102107 ''Note: this requires the `mod_env` module''
    103108
    104 For [wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables.
     109For [wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables.
     110
     111 ''Note: that if you already use -initial-env to set the project directory for either a single project or parent you will need to add atleast one environment variable inside trac.fcgi as expressed in the example on [wiki:TracFastCgi TracFastCgi].
    105112
    106113=== About hook scripts ===
     
    130137 * you actually added the necessary line(s) to the `[components]` section
    131138 * the package/module names are correct
    132  * if you're reference a module (as opposed to a class), you've appended the necessary “.*”
    133139 * the value is “enabled", not e.g. “enable”
    134140
    135141=== Check the permissions on the egg file ===
    136142
    137 Trac must of course be able to read the file. Yeah, you knew that ;-)
     143Trac must be able to read the file.
    138144
    139145=== Check the log files ===
    140146
    141 Enable [TracLogging logging] in Trac, set the log level to `DEBUG` and then watch the log file for messages about loading plugins.
     147Enable [wiki:TracLogging logging] and set the log level to `DEBUG`, then watch the log file for messages about loading plugins.
     148
     149=== Verify you have proper permissions ===
     150
     151Some plugins require you have special permissions in order to use them. WebAdmin, for example, requires the user to have TRAC_ADMIN permissions for it to show up on the navigation bar.
     152
     153=== Is the wrong version of the plugin loading? ===
     154
     155If you put your plugins inside plugins directories, and certainly if you have more than one project, you need to make sure that the correct version of the plugin is loading. Here are som basic rules:
     156 * Only one version of the plugin can be loaded for each running Trac server (ie. each Python process). The Python namespaces and module list will be shared, and it cannot handle duplicates. Whether a plugin is `enabled` or `disabled` makes no difference.
     157 * A globally installed plugin (typically `setup.py install`) will override any version in global or project plugins directories. A plugin from the global plugins directory will be located before any project plugins directory.
     158 * If your Trac server hosts more than one project (as with `TRAC_ENV_PARENT_DIR` setups), then having two versions of a plugin in two different projects will give uncertain results. Only one of them will load, and the one loaded will be shared by both projects. Trac will load the first found - basically from the project that receives the first request.
     159 * Having more than one version listed inside Python site-packages is fine (ie. installed with `setup.py install`) - setuptools will make sure you get the version installed most recently. However, don't store more than one version inside a global or project plugins directory - neither version number nor installed date will matter at all. There is no way to determine which one will be located first when Trac searches the directory for plugins.
     160
     161=== If all of the above failed ===
     162
     163OK, so the logs don't mention plugins, the egg is readable, the python version is correct ''and'' the egg has been installed globally (and is enabled in the trac.ini) and it still doesn't work or give any error messages or any other indication as to why? Hop on the IrcChannel and ask away.
    142164
    143165----