Changes between Version 2 and Version 3 of TracPlugins


Ignore:
Timestamp:
2010-06-13T20:31:26Z (11 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPlugins

    v2 v3  
    22[[TracGuideToc]]
    33
    4 Since version 0.9, Trac supports plugins that extend the built-in functionality. The plugin functionality is based on the [http://trac.edgewall.org/wiki/TracDev/ComponentArchitecture component architecture].
     4Since version 0.9, Trac supports [trac:PluginList plugins] that extend the built-in functionality. The plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture]. Plugins can be installed globally (in this case they should be explicitly enabled in [TracIni#components-section trac.ini]) or locally for specific TracEnvironment.
    55
    66== Requirements ==
     
    1515If 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.
    1616
    17 Plugins can also consist of a single `.py` file dropped into either the environment or global `plugins` directory ''(since [milestone:0.10])''.
     17Plugins can also consist of a single `.py` file dropped into either the environment or global `plugins` directory ''(since [milestone:0.10])''. See TracIni#GlobalConfiguration .
    1818
    1919== Installing a Trac Plugin ==
     
    3232Then you will have a *.egg file. Examine the output of running python to find where this was created.
    3333
    34 Once 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.
     34Once 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. Then, restart the web server (this requirement was not previously mentioned in this document, but in my tests it began working only after I did so).
     35
     36To uninstall a plugin installed this way, remove the egg from `plugins` directory and restart web server.
    3537
    3638Note that the Python version that the egg is built with must
     
    4042recognized.
    4143
     44Note also that in a multi-project setup, a pool of Python interpreter instances will be dynamically allocated to projects based on need, and since plugins occupy a place in Python's module system, the first version of any given plugin to be loaded will be used for all the projects. In other words, you cannot use different versions of a single plugin in two projects of a multi-project setup. It may be safer to install plugins for all projects (see below) and then enable them selectively on a project-by-project basis.
     45
    4246=== For All Projects ===
    4347
    4448==== With an .egg file ====
    4549
    46 Some 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:
     50Some plugins (such as [trac:SpamFilter SpamFilter]) are downloadable as a `.egg` file which can be installed with the `easy_install` program:
    4751{{{
    4852easy_install TracSpamFilter
     
    5761You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents.
    5862
    59 Trac also searches for globally installed plugins under `$PREFIX/share/trac/plugins` ''(since 0.10)''.
     63Trac also searches for globally installed plugins ''(since 0.10)'', see TracIni#GlobalConfiguration.
    6064
    6165==== From source ====
     
    6367`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:
    6468{{{
    65 easy_install http://svn.edgewall.com/repos/trac/sandbox/spam-filter
     69easy_install http://svn.edgewall.com/repos/trac/plugins/0.11/spam-filter
    6670}}}
    6771
    6872==== Enabling the plugin ====
    69 Unlike plugins installed per-environment, you'll have to explicitly enable globally installed plugins via [wiki:TracIni trac.ini]. This is done in the `[components]` section of the configuration file, for example:
     73Unlike plugins installed per-environment, you'll have to explicitly enable globally installed plugins via [wiki:TracIni trac.ini]. This also applies to plugins installed in the path specified in the `[inherit] plugins_dir` configuration option. This is done in the `[components]` section of the configuration file, for example:
    7074{{{
    7175[components]
     
    7781Note: After installing the plugin, you need to restart your web server.
    7882
     83==== Uninstalling ====
     84
     85`easy_install` or `python setup.py` does not have an uninstall feature. Hower, it is usually quite trivial to remove a globally installed egg and reference:
     86 1. Do `easy_install -m [plugin name]` to remove references from `$PYTHONLIB/site-packages/easy-install.pth` when the plugin installed by setuptools.
     87 1. Delete executables from `/usr/bin`, `/usr/local/bin` or `C:\\Python*\Scripts`. For search what executables are there, you may refer to `[console-script]` section of `setup.py`.
     88 1. Delete the .egg file or folder from where it is installed, usually inside `$PYTHONLIB/site-packages/`.
     89 1. Restart web server.
     90
     91If you are uncertain about the location of the egg, here is a small tip to help locate an egg (or any package) - replace `myplugin` with whatever namespace the plugin uses (as used when enabling the plugin):
     92{{{
     93>>> import myplugin
     94>>> print myplugin.__file__
     95/opt/local/python24/lib/site-packages/myplugin-0.4.2-py2.4.egg/myplugin/__init__.pyc
     96}}}
     97
    7998== Setting up the Plugin Cache ==
    8099
    81 Some plugins will need to be extracted by the Python eggs runtime (`pkg_resources`), so that their contents are actual files on the file system. The directory in which they are extracted defaults to the home directory of the current user, which may or may not be a problem. You can however override the default location using the `PYTHON_EGG_CACHE` environment variable.
     100Some plugins will need to be extracted by the Python eggs runtime (`pkg_resources`), so that their contents are actual files on the file system. The directory in which they are extracted defaults to '.python-eggs' in the home directory of the current user, which may or may not be a problem. You can however override the default location using the `PYTHON_EGG_CACHE` environment variable.
    82101
    83102To do this from the Apache configuration, use the `SetEnv` directive as follows:
     
    105124}}}
    106125
    107  ''Note: this requires the `mod_env` module''
     126 ''Note: !SetEnv requires the `mod_env` module which needs to be activated for Apache. In this case the !SetEnv directive can also be used in the `mod_python` Location block.''
    108127
    109128For [wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables.
    110129
    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].
     130 ''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 an additional -initial-env directive to the !FastCgiConfig directive. I.e.
     131
     132{{{
     133FastCgiConfig -initial-env TRAC_ENV=/var/lib/trac -initial-env PYTHON_EGG_CACHE=/var/lib/trac/plugin-cache
     134}}}
    112135
    113136=== About hook scripts ===
     
    134157=== Is the plugin enabled? ===
    135158
     159
    136160If you install a plugin globally (i.e. ''not'' inside the `plugins` directory of the Trac project environment) you will have to explicitly enable it in [TracIni trac.ini]. Make sure that:
    137161 * you actually added the necessary line(s) to the `[components]` section
     
    149173=== Verify you have proper permissions ===
    150174
    151 Some 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.
     175Some plugins require you have special permissions in order to use them. [trac:WebAdmin WebAdmin], for example, requires the user to have TRAC_ADMIN permissions for it to show up on the navigation bar.
    152176
    153177=== Is the wrong version of the plugin loading? ===
    154178
    155 If 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:
     179If 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 some basic rules:
    156180 * 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.
    157181 * 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.
     
    161185=== If all of the above failed ===
    162186
    163 OK, 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.
     187OK, 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 [trac:IrcChannel IrcChannel] and ask away.
    164188
    165189----
    166 See also TracGuide, [http://trac.edgewall.org/wiki/PluginList plugin list], [http://trac.edgewall.org/wiki/TracDev/ComponentArchitecture component architecture]
     190See also TracGuide, [trac:PluginList plugin list], [trac:TracDev/ComponentArchitecture component architecture]