Changes between Version 3 and Version 4 of TracPlugins
- Timestamp:
- May 23, 2015, 1:32:03 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracPlugins
v3 v4 1 = Trac plugins = 1 = Trac plugins 2 2 3 [[TracGuideToc]] 3 4 4 5 Trac is extensible with [trac:PluginList plugins]. Plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture], with peculiarities described in the [trac:TracDev/PluginDevelopment plugin development] page. 5 6 6 == Plugin discovery ==7 == Plugin discovery 7 8 8 9 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 10 == Requirements for Trac eggs ==11 == Requirements for Trac eggs 11 12 12 13 To use egg-based plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (version 0.6) installed. … … 14 15 To install `setuptools`, download the bootstrap module [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] and execute it as follows: 15 16 16 {{{ 17 {{{#!sh 17 18 $ python ez_setup.py 18 19 }}} … … 22 23 Plugins can also consist of a single `.py` file dropped directly into either the project's or the shared `plugins` directory. 23 24 24 == Installing a Trac plugin ==25 26 === For a single project ===25 == Installing a Trac plugin 26 27 === For a single project 27 28 28 29 Plugins are typically packaged as [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs]. That means they are .zip archives with the file extension `.egg`. … … 33 34 * Run: 34 35 35 {{{ 36 {{{#!sh 36 37 $ python setup.py bdist_egg 37 38 }}} … … 43 44 To uninstall a plugin installed this way, remove the egg from the `plugins` directory and restart the web server. 44 45 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.46 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.48 49 === For all projects ===50 51 ==== With an .egg file ====46 '''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. 47 48 '''Note''': 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. 49 50 === For all projects 51 52 ==== With an .egg file 52 53 53 54 Some plugins (such as [trac:SpamFilter SpamFilter]) are downloadable as an `.egg` file that can be installed with the `easy_install` program: 54 {{{ 55 easy_install TracSpamFilter56 }}} 57 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).55 {{{#!sh 56 $ easy_install TracSpamFilter 57 }}} 58 59 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. 59 60 60 61 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`: 61 {{{ 62 easy_install --always-unzip TracSpamFilter-0.4.1_r10106-py2.6.egg62 {{{#!sh 63 $ easy_install --always-unzip TracSpamFilter-0.4.1_r10106-py2.6.egg 63 64 }}} 64 65 You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents. … … 66 67 Trac also searches for plugins installed in the shared plugins directory, see TracIni#GlobalConfiguration. This is a convenient way to share the installation of plugins across several, but not all, environments. 67 68 68 ==== From source ====69 ==== From source 69 70 70 71 `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: 71 {{{ 72 easy_install http://svn.edgewall.com/repos/trac/plugins/0.12/spam-filter-captcha73 }}} 74 75 ==== Enabling the plugin ====72 {{{#!sh 73 $ easy_install http://svn.edgewall.com/repos/trac/plugins/0.12/spam-filter-captcha 74 }}} 75 76 ==== Enabling the plugin 76 77 77 78 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 79 80 This is done in the `[components]` section of the configuration file. For example: 80 {{{ 81 {{{#!ini 81 82 [components] 82 83 tracspamfilter.* = enabled … … 87 88 Note: After installing the plugin, you must restart your web server. 88 89 89 ==== Uninstalling ====90 91 `easy_install` or `python setup.py` does not have an uninstall feature. Hower, it is usually quitetrivial to remove a globally-installed egg and reference:90 ==== Uninstalling 91 92 The commands `easy_install` and `python setup.py` do not have an uninstall feature. However, it is usually trivial to remove a globally-installed egg and reference: 92 93 93 94 1. Do `easy_install -m [plugin name]` to remove references from `$PYTHONLIB/site-packages/easy-install.pth` when the plugin installed by setuptools. … … 97 98 98 99 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): 99 {{{ 100 {{{#!python 100 101 >>> import myplugin 101 102 >>> print myplugin.__file__ … … 103 104 }}} 104 105 105 == Setting up the plugin cache ==106 == Setting up the plugin cache 106 107 107 108 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. 108 109 109 110 To do this from the Apache configuration, use the `SetEnv` directive: 110 {{{ 111 {{{#!apache 111 112 SetEnv PYTHON_EGG_CACHE /path/to/dir 112 113 }}} … … 114 115 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. 115 116 116 For example (for CGI):117 {{{ 117 For example for CGI: 118 {{{#!apache 118 119 <Location /trac> 119 120 SetEnv TRAC_ENV /path/to/projenv … … 122 123 }}} 123 124 124 Or (for mod_python):125 {{{ 125 Or for mod_python: 126 {{{#!apache 126 127 <Location /trac> 127 128 SetHandler mod_python … … 131 132 }}} 132 133 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.''134 '''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. 134 135 135 136 For [wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables. 136 137 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 {{{ 138 '''Note''': 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: 139 140 {{{#!apache 140 141 FastCgiConfig -initial-env TRAC_ENV=/var/lib/trac -initial-env PYTHON_EGG_CACHE=/var/lib/trac/plugin-cache 141 142 }}} 142 143 143 === About hook scripts ===144 === About hook scripts 144 145 145 146 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. 146 147 147 == Troubleshooting ==148 149 === Is setuptools properly installed? ===148 == Troubleshooting 149 150 === Is setuptools properly installed? 150 151 151 152 Try this from the command line: 152 {{{ 153 {{{#!sh 153 154 $ python -c "import pkg_resources" 154 155 }}} … … 156 157 If you get '''no output''', setuptools '''is''' installed. Otherwise, you'll need to install it before plugins will work in Trac. 157 158 158 === Did you get the correct version of the Python egg? ===159 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).159 === Did you get the correct version of the Python egg? 160 161 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. 161 162 162 163 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. 163 164 164 === Is the plugin enabled? ===165 === Is the plugin enabled? 165 166 166 167 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: … … 171 172 * ...the section name is "components", not "component". 172 173 173 === Check the permissions on the .egg file ===174 === Check the permissions on the .egg file 174 175 175 176 Trac must be able to read the .egg file. 176 177 177 === Check the log files ===178 === Check the log files 178 179 179 180 Enable [wiki:TracLogging logging] and set the log level to `DEBUG`, then watch the log file for messages about loading plugins. 180 181 181 === Verify you have proper permissions ===182 183 Some plugins require you have special permissions in order to use them. [trac:WebAdmin WebAdmin], for example, requires the user to have TRAC_ADMINpermissions for it to show up on the navigation bar.184 185 === Is the wrong version of the plugin loading? ===182 === Verify you have proper permissions 183 184 Some plugins require you have special permissions 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. 185 186 === Is the wrong version of the plugin loading? 186 187 187 188 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 some basic rules: 188 189 189 * 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.190 * 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. 190 191 * 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. 191 192 * 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. 192 193 * 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. 193 194 194 === If all of the above failed ===195 === If all of the above failed 195 196 196 197 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! 197 198 198 == Web-based plugin administration ==199 == Web-based plugin administration 199 200 200 201 The [trac:WebAdmin] interface offers limited support for plugin configuration through the web to users with `TRAC_ADMIN` permission: … … 203 204 * installing plugins by uploading them as eggs 204 205 205 You probably want to disable the second function for security reasons: in `trac.ini`, in the `[components]` section, add the line 206 {{{ 206 You probably want to disable the second function for security reasons: in `trac.ini`, in the `[components]` section, add the line: 207 {{{#!ini 207 208 trac.admin.web_ui.PluginAdminPanel = disabled 208 209 }}}