Changes between Version 1 and Version 2 of TracPlugins


Ignore:
Timestamp:
07/14/08 16:31:16 (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPlugins

    v1 v2  
    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://projects.edgewall.com/trac/wiki/TracDev/ComponentArchitecture component architecture]. 
     4Since 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]. 
    55 
    66== Requirements == 
    77 
    8 To use plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (version 0.6) installed. 
     8To use egg based plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (version 0.6) installed. 
     9 
     10Plugins can also consist of a single `.py` file dropped into either the environment or global `plugins` directory ''(since [milestone:0.10])''. 
    911 
    1012To install `setuptools`, download the bootstrap module [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] and execute it as follows: 
     
    2729Once 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. 
    2830 
     31Note that the Python version that the egg is built with must 
     32match the Python version with which Trac is run.  If for 
     33instance you are running Trac under Python 2.3, but have 
     34upgraded your standalone Python to 2.4, the eggs won't be 
     35recognized. 
     36 
    2937=== For All Projects === 
    3038 
    31 Plugins that you want to use in all your projects (such as [http://projects.edgewall.com/trac/wiki/WebAdmin WebAdmin]) can be installed globally by running: 
     39==== With an .egg file ==== 
     40 
     41Some 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: 
     42{{{ 
     43easy_install TracWebAdmin-0.1.1dev_r2765-py2.3.egg 
     44}}} 
     45 
     46If `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). 
     47 
     48If 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`: 
     49{{{ 
     50easy_install --always-unzip TracWebAdmin-0.1.1dev_r2765-py2.3.egg 
     51}}} 
     52You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents. 
     53 
     54Trac also searches for globally installed plugins under `$prefix/share/trac/plugins` ''(since 0.10)''. 
     55 
     56==== From source ==== 
     57 
     58If you downloaded the plugin's source from Subversion, or a source zip file you can install it using the included `setup.py`: 
    3259{{{ 
    3360$ python setup.py install 
    3461}}} 
    3562 
    36 Alternatively, you can just drop the `.egg` file in the Python `site-packages` directory. 
    37  
     63==== Enabling the plugin ==== 
    3864Unlike 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: 
    3965{{{ 
     
    4369 
    4470The 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`.) 
     71 
     72Note: After installing the plugin, you may need to restart Apache. 
    4573 
    4674== Setting up the Plugin Cache == 
     
    5381}}} 
    5482 
    55 This works whether your using the [wiki:TracCgi CGI] or the [wiki:TracModPython mod_python] front-end. Put this directive next to where you set the path to the [wiki:TracEnvironment Trac environment], i.e. in the same `<Location>` block. 
     83This works whether you are using the [wiki:TracCgi CGI] or the [wiki:TracModPython mod_python] front-end. Put this directive next to where you set the path to the [wiki:TracEnvironment Trac environment], i.e. in the same `<Location>` block. 
    5684 
    5785For example (for CGI): 
     
    72100}}} 
    73101 
     102 ''Note: this requires the `mod_env` module'' 
     103 
    74104For [wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables. 
    75105 
     106=== About hook scripts === 
     107 
     108If you have set up some subversion hook scripts that call the Trac engine - such as the post-commit hook script provided in the `/contrib` directory - make sure you define the `PYTHON_EGG_CACHE` environment variable within these scripts as well. 
     109 
     110== Troubleshooting == 
     111 
     112=== Is setuptools properly installed? === 
     113 
     114Try this from the command line: 
     115{{{ 
     116$ python -c "import pkg_resources" 
     117}}} 
     118 
     119If you get '''no output''', setuptools '''is''' installed. Otherwise, you'll need to install it before plugins will work in Trac. 
     120 
     121=== Did you get the correct version of the Python egg? === 
     122 
     123Python 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). 
     124 
     125Also, 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. 
     126 
     127=== Is the plugin enabled? === 
     128 
     129If 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: 
     130 * you actually added the necessary line(s) to the `[components]` section 
     131 * the package/module names are correct 
     132 * if you're reference a module (as opposed to a class), you've appended the necessary “.*” 
     133 * the value is “enabled", not e.g. “enable” 
     134 
     135=== Check the permissions on the egg file === 
     136 
     137Trac must of course be able to read the file. Yeah, you knew that ;-) 
     138 
     139=== Check the log files === 
     140 
     141Enable [TracLogging logging] in Trac, set the log level to `DEBUG` and then watch the log file for messages about loading plugins. 
     142 
    76143---- 
    77 See also TracGuide, [http://projects.edgewall.com/trac/wiki/PluginList plugin list], [http://projects.edgewall.com/trac/wiki/TracDev/ComponentArchitecture component architecture] 
     144See also TracGuide, [http://trac.edgewall.org/wiki/PluginList plugin list], [http://trac.edgewall.org/wiki/TracDev/ComponentArchitecture component architecture]