Changes between Version 1 and Version 2 of TracPlugins


Ignore:
Timestamp:
Jul 17, 2008 10:45:00 AM (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPlugins

    v1 v2  
    1 = Trac plugins = 
     1= Trac Plugins = 
    22[[TracGuideToc]] 
    33 
    4 From version 0.9 onwards, Trac is extensible with [trac:PluginList plugins]. Plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture], with peculiarities described in the [TracDev/PluginDevelopment plugin development] page. 
     4Since 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]. 
    55 
    6 == Plugin discovery == 
     6== Requirements == 
    77 
    8 From the user's point of view, a plugin is either a standalone .py file or an .egg package. Trac looks for plugins in the global shared plugins directory (see [TracIni#GlobalConfiguration Global Configuration]) and in the `plugins` directory of the 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 == 
    11  
    12 To use egg-based 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. 
    139 
    1410To install `setuptools`, download the bootstrap module [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] and execute it as follows: 
    15  
    1611{{{ 
    1712$ python ez_setup.py 
     
    2015If 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. 
    2116 
    22 Plugins can also consist of a single `.py` file dropped directly into either the project's or the shared `plugins` directory. 
     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 . 
    2318 
    24 == Installing a Trac plugin == 
     19== Installing a Trac Plugin == 
    2520 
    26 === For a single project === 
     21=== For a Single Project === 
    2722 
    28 Plugins are typically packaged as [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs]. That means they are .zip archives with the file extension `.egg`. 
     23Plugins are packaged as [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs]. That means they are ZIP archives with the file extension `.egg`.  
    2924 
    30 If you have downloaded a source distribution of a plugin, and want to build the `.egg` file: 
    31  
    32  * Unpack the source. It should provide `setup.py`. 
     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.  
    3327 * Run: 
    34  
    3528{{{ 
    3629$ python setup.py bdist_egg 
    3730}}} 
    3831 
    39 You should have a *.egg file. Examine the output of running python to find where this was created. 
     32Then you will have a *.egg file. Examine the output of running python to find where this was created. 
    4033 
    41 Once you have the plugin archive, 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. If you are running as a [wiki:TracStandalone "tracd" standalone server], restart tracd (kill and run again). 
     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. 
    4235 
    43 To uninstall a plugin installed this way, remove the egg from the `plugins` directory and restart the web server. 
     36To uninstall a plugin installed this way, remove the egg from `plugins` directory and restart web server. 
    4437 
    45 Note: the Python version that the egg is built with ''must'' match the Python version with which Trac is run. For example, if you're running Trac under Python 2.5, but have upgraded your standalone Python to 2.6, the eggs won't be recognized. 
     38Note that the Python version that the egg is built with must 
     39match the Python version with which Trac is run.  If for 
     40instance you are running Trac under Python 2.3, but have 
     41upgraded your standalone Python to 2.4, the eggs won't be 
     42recognized. 
    4643 
    47 Note also: in a multi-project setup, a pool of Python interpreter instances will be dynamically allocated to projects based on need; 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 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. 
     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. 
    4845 
    49 === For all projects === 
     46=== For All Projects === 
    5047 
    5148==== With an .egg file ==== 
    5249 
    53 Some plugins (such as [trac:SpamFilter SpamFilter]) are downloadable as an `.egg` file that 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: 
    5451{{{ 
    5552easy_install TracSpamFilter 
    5653}}} 
    5754 
    58 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:\Python24\Scripts`) to their `PATH` environment variable (see [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes easy_install Windows notes] for more information). 
     55If `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). 
    5956 
    60 If 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`: 
     57If 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`: 
    6158{{{ 
    62 easy_install --always-unzip TracSpamFilter-0.4.1_r10106-py2.6.egg 
     59easy_install --always-unzip TracSpamFilter-0.2.1dev_r5943-py2.4.egg 
    6360}}} 
    6461You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents. 
    6562 
    66 Trac 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. 
     63Trac also searches for globally installed plugins ''(since 0.10)'', see TracIni#GlobalConfiguration. 
    6764 
    6865==== From source ==== 
     
    7067`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: 
    7168{{{ 
    72 easy_install http://svn.edgewall.com/repos/trac/plugins/0.12/spam-filter-captcha 
     69easy_install http://svn.edgewall.com/repos/trac/sandbox/spam-filter 
    7370}}} 
    7471 
    7572==== Enabling the plugin ==== 
    76  
    77 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 shared plugins directory, i.e. the path specified in the `[inherit] plugins_dir` configuration option.  
    78  
    79 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 is done in the `[components]` section of the configuration file, for example: 
    8074{{{ 
    8175[components] 
     
    8377}}} 
    8478 
    85 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 discovered by looking at the source (look for a top-level directory that contains a file named `__init__.py`). 
     79The 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`.) 
    8680 
    87 Note: After installing the plugin, you must restart your web server. 
     81Note: After installing the plugin, you need to restart your web server. 
    8882 
    8983==== Uninstalling ==== 
    9084 
    91 `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: 
     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. 
    9290 
    93  1. Do `easy_install -m [plugin name]` to remove references from `$PYTHONLIB/site-packages/easy-install.pth` when the plugin installed by setuptools. 
    94  1. Delete executables from `/usr/bin`, `/usr/local/bin`, or `C:\\Python*\Scripts`. To find what executables are involved, refer to the `[console-script]` section of `setup.py`. 
    95  1. Delete the .egg file or folder from where it's installed (usually inside `$PYTHONLIB/site-packages/`). 
    96  1. Restart the web server. 
    97  
    98 If you are uncertain about the location of the egg, here's a small tip to help locate an egg (or any package). Just replace `myplugin` with whatever namespace the plugin uses (as used when enabling the plugin): 
     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): 
    9992{{{ 
    10093>>> import myplugin 
     
    10396}}} 
    10497 
    105 == Setting up the plugin cache == 
     98== Setting up the Plugin Cache == 
    10699 
    107 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 `.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. 
     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 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. 
    108101 
    109 To do this from the Apache configuration, use the `SetEnv` directive: 
     102To do this from the Apache configuration, use the `SetEnv` directive as follows: 
    110103{{{ 
    111104SetEnv PYTHON_EGG_CACHE /path/to/dir 
    112105}}} 
    113106 
    114 This works whether you're 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. 
     107This 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. 
    115108 
    116109For example (for CGI): 
     
    122115}}} 
    123116 
    124 Or (for mod_python): 
     117or (for mod_python): 
    125118{{{ 
    126119 <Location /trac> 
     
    131124}}} 
    132125 
    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.'' 
     126 ''Note: this requires the `mod_env` module'' 
    134127 
    135128For [wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables.  
    136129 
    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 {{{ 
    140 FastCgiConfig -initial-env TRAC_ENV=/var/lib/trac -initial-env PYTHON_EGG_CACHE=/var/lib/trac/plugin-cache 
    141 }}} 
     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]. 
    142131 
    143132=== About hook scripts === 
    144133 
    145 If you've 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. 
     134If 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. 
    146135 
    147136== Troubleshooting == 
     
    158147=== Did you get the correct version of the Python egg? === 
    159148 
    160 Python 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). 
     149Python 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). 
    161150 
    162 Also, 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. 
     151Also, 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. 
    163152 
    164153=== Is the plugin enabled? === 
    165154 
    166 If you install a plugin globally (i.e., ''not'' inside the `plugins` directory of the Trac project environment), you must explicitly enable it in [TracIni trac.ini]. Make sure that: 
     155If 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: 
     156 * you actually added the necessary line(s) to the `[components]` section 
     157 * the package/module names are correct 
     158 * the value is “enabled", not e.g. “enable” 
    167159 
    168  * ...you actually added the necessary line(s) to the `[components]` section. 
    169  * ...the package/module names are correct. 
    170  * ...the value is "enabled", not "enable" or "Enable". 
     160=== Check the permissions on the egg file === 
    171161 
    172 === Check the permissions on the .egg file === 
    173  
    174 Trac must be able to read the .egg file.  
     162Trac must be able to read the file.  
    175163 
    176164=== Check the log files === 
     
    180168=== Verify you have proper permissions === 
    181169 
    182 Some 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. 
     170Some 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. 
    183171 
    184172=== Is the wrong version of the plugin loading? === 
    185173 
    186174If 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: 
    187  
    188  * Only one version of the plugin can be loaded for each running Trac server (i.e., 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. 
    189  * A globally-installed plugin (typically `setup.py install`) will override any version in the global or project plugins directories. A plugin from the global plugins directory will be located ''before'' any project plugins directory. 
    190  * If your Trac server hosts more than one project (as with `TRAC_ENV_PARENT_DIR` setups), 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 plugin found, usually from the project that receives the first request. 
    191  * Having more than one version listed inside Python site-packages is fine (i.e., 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. 
     175 * 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. 
     176 * 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. 
     177 * 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. 
     178 * 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. 
    192179 
    193180=== If all of the above failed === 
    194181 
    195 Okay, 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 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! 
    196  
    197 == Web-based plugin administration == 
    198  
    199 The WebAdmin plugin (part of the core since 0.11) offers limited support for plugin configuration through the web to users with `TRAC_ADMIN` permission: 
    200  
    201 * en/disabling installed plugins 
    202 * installing plugins by uploading them as eggs 
    203  
    204 You probably want to disable the second function for security reasons: in `trac.ini`, in the `[components]` section, add the line 
    205 {{{ 
    206 trac.admin.web_ui.PluginAdminPanel = disabled 
    207 }}} 
    208 This disables the whole panel, so the first function will no longer be available either. 
     182OK, 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. 
    209183 
    210184---- 
    211 See also TracGuide, [trac:PluginList plugin list], [trac:TracDev/ComponentArchitecture component architecture]. 
     185See also TracGuide, [trac:PluginList plugin list], [trac:TracDev/ComponentArchitecture component architecture]