Changes between Version 3 and Version 4 of TracPlugins


Ignore:
Timestamp:
12/23/12 14:06:38 (21 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPlugins

    v3 v4  
    22[[TracGuideToc]] 
    33 
    4 Since 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]. 
     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]) and in `plugins` directory of local TracEnvironment. Components defined in globally installed plugins should be explicitly enabled in the [[TracIni#components-section| [components] ]] section of the trac.ini file. 
     9 
     10== Requirements for Trac eggs  == 
    711 
    812To use egg based plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (version 0.6) installed. 
     
    1519If 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. 
    1620 
    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 . 
     21Plugins can also consist of a single `.py` file dropped directly into the root of environment's or into shared `plugins` directory. 
    1822 
    1923== Installing a Trac Plugin == 
     
    3236Then you will have a *.egg file. Examine the output of running python to find where this was created. 
    3337 
    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. 
     38Once 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). 
    3539 
    3640To uninstall a plugin installed this way, remove the egg from `plugins` directory and restart web server. 
     
    3842Note that the Python version that the egg is built with must 
    3943match 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 
     44instance you are running Trac under Python 2.5, but have 
     45upgraded your standalone Python to 2.6, the eggs won't be 
    4246recognized. 
    4347 
     
    5357}}} 
    5458 
    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). 
     59If `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). 
    5660 
    5761If 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`: 
    5862{{{ 
    59 easy_install --always-unzip TracSpamFilter-0.2.1dev_r5943-py2.4.egg 
     63easy_install --always-unzip TracSpamFilter-0.4.1_r10106-py2.6.egg 
    6064}}} 
    6165You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents. 
    6266 
    63 Trac also searches for globally installed plugins ''(since 0.10)'', see TracIni#GlobalConfiguration. 
     67Trac 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. 
    6468 
    6569==== From source ==== 
     
    6771`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: 
    6872{{{ 
    69 easy_install http://svn.edgewall.com/repos/trac/sandbox/spam-filter 
     73easy_install http://svn.edgewall.com/repos/trac/plugins/0.12/spam-filter-captcha 
    7074}}} 
    7175 
    7276==== Enabling the plugin ==== 
    73 Unlike 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: 
     77Unlike 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.  
     78 
     79This is done in the `[components]` section of the configuration file, for example: 
    7480{{{ 
    7581[components] 
     
    151157=== Did you get the correct version of the Python egg? === 
    152158 
    153 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). 
     159Python 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). 
    154160 
    155161Also, 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.