Changes between Version 2 and Version 3 of TracPlugins


Ignore:
Timestamp:
11/11/10 14:43:40 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPlugins

    v2 v3  
    22[[TracGuideToc]] 
    33 
    4 Since version 0.9, Trac supports [PluginList plugins] that extend the built-in functionality. The plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture]. 
     4Trac is extensible with [trac:PluginList plugins] since version 0.9. The plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture] with peculiarities described at [TracDev/PluginDevelopment plugin development] page. 
    55 
    6 == Requirements == 
     6== Plugin discovery == 
     7 
     8From the user point of view a Plugin is either standalone .py file or an .egg package. Trac looks for Plugins in a global shared plugins directory (see [TracIni#GlobalConfiguration Global Configuration]), or in a local TracEnvironment, in its `plugins` directory. 
     9Except for the later case, the components defined in a plugin should be explicitly enabled in the [[TracIni#components-section| [components] ]] section of the trac.ini file. 
     10 
     11== Requirements for Trac eggs  == 
    712 
    813To use egg based plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (version 0.6) installed. 
     
    1520If 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. 
    1621 
    17 Plugins can also consist of a single `.py` file dropped into either the environment or global `plugins` directory ''(since [milestone:0.10])''. See TracIni#GlobalConfiguration . 
     22Plugins can also consist of a single `.py` file dropped into either the environment or the shared plugins directory. 
    1823 
    1924== Installing a Trac Plugin == 
     
    3237Then you will have a *.egg file. Examine the output of running python to find where this was created. 
    3338 
    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. 
     39Once 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). 
    3540 
    3641To uninstall a plugin installed this way, remove the egg from `plugins` directory and restart web server. 
     
    3843Note that the Python version that the egg is built with must 
    3944match the Python version with which Trac is run.  If for 
    40 instance you are running Trac under Python 2.3, but have 
    41 upgraded your standalone Python to 2.4, the eggs won't be 
     45instance you are running Trac under Python 2.5, but have 
     46upgraded your standalone Python to 2.6, the eggs won't be 
    4247recognized. 
    4348 
     
    5358}}} 
    5459 
    55 If `easy_install` is not on your system see the Requirements section above to install it.  Windows users will need to add the `Scripts` directory of their Python installation (for example, `C:\Python23\Scripts`) to their `PATH` environment variable (see [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes easy_install Windows notes] for more information). 
     60If `easy_install` is not on your system see the Requirements section above to install it.  Windows users will need to add the `Scripts` directory of their Python installation (for example, `C:\Python24\Scripts`) to their `PATH` environment variable (see [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes easy_install Windows notes] for more information). 
    5661 
    5762If 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`: 
    5863{{{ 
    59 easy_install --always-unzip TracSpamFilter-0.2.1dev_r5943-py2.4.egg 
     64easy_install --always-unzip TracSpamFilter-0.4.1_r10106-py2.6.egg 
    6065}}} 
    6166You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents. 
    6267 
    63 Trac also searches for globally installed plugins ''(since 0.10)'', see TracIni#GlobalConfiguration. 
     68Trac also searches for plugins installed in the shared plugins directory ''(since 0.10)'', see TracIni#GlobalConfiguration. This is a convenient way to share the installation of plugins across several but not all environments. 
    6469 
    6570==== From source ==== 
     
    6772`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: 
    6873{{{ 
    69 easy_install http://svn.edgewall.com/repos/trac/sandbox/spam-filter 
     74easy_install http://svn.edgewall.com/repos/trac/plugins/0.12/spam-filter-captcha 
    7075}}} 
    7176 
    7277==== Enabling the plugin ==== 
    73 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: 
     78Unlike 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 shared plugins directory, i.e. the path specified in the `[inherit] plugins_dir` configuration option.  
     79 
     80This is done in the `[components]` section of the configuration file, for example: 
    7481{{{ 
    7582[components] 
     
    98105== Setting up the Plugin Cache == 
    99106 
    100 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. 
     107Some 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. 
    101108 
    102109To do this from the Apache configuration, use the `SetEnv` directive as follows: 
     
    124131}}} 
    125132 
    126  ''Note: this requires the `mod_env` module'' 
     133 ''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.'' 
    127134 
    128135For [wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables.  
    129136 
    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 atleast one environment variable inside trac.fcgi as expressed in the example on [wiki:TracFastCgi TracFastCgi]. 
     137 ''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. 
     138 
     139{{{ 
     140FastCgiConfig -initial-env TRAC_ENV=/var/lib/trac -initial-env PYTHON_EGG_CACHE=/var/lib/trac/plugin-cache 
     141}}} 
    131142 
    132143=== About hook scripts === 
     
    147158=== Did you get the correct version of the Python egg? === 
    148159 
    149 Python eggs have the Python version encoded in their filename. For example, `MyPlugin-1.0-py2.4.egg` is an egg for Python 2.4, and will '''not''' be loaded if you're running a different Python version (such as 2.3 or 2.5). 
     160Python eggs have the Python version encoded in their filename. For example, `MyPlugin-1.0-py2.5.egg` is an egg for Python 2.5, and will '''not''' be loaded if you're running a different Python version (such as 2.4 or 2.6). 
    150161 
    151162Also, verify that the egg file you downloaded is indeed a ZIP archive. If you downloaded it from a Trac site, chances are you downloaded the HTML preview page instead. 
    152163 
    153164=== Is the plugin enabled? === 
     165 
    154166 
    155167If 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: 
     
    168180=== Verify you have proper permissions === 
    169181 
    170 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. 
     182Some 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. 
    171183 
    172184=== Is the wrong version of the plugin loading? === 
     
    180192=== If all of the above failed === 
    181193 
    182 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. 
     194OK, 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. 
    183195 
    184196----