Changes between Version 7 and Version 8 of TracPlugins
- Timestamp:
- Jul 25, 2015, 7:08:55 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracPlugins
v7 v8 1 = Trac plugins 2 1 = Trac plugins = 3 2 [[TracGuideToc]] 4 3 5 4 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. 6 5 7 == Plugin discovery 6 == Plugin discovery == 8 7 9 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. 10 9 11 == Requirements for Trac eggs 10 == Requirements for Trac eggs == 12 11 13 12 To use egg-based plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (version 0.6) installed. … … 15 14 To install `setuptools`, download the bootstrap module [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] and execute it as follows: 16 15 17 {{{ #!sh16 {{{ 18 17 $ python ez_setup.py 19 18 }}} … … 23 22 Plugins can also consist of a single `.py` file dropped directly into either the project's or the shared `plugins` directory. 24 23 25 == Installing a Trac plugin 26 27 === For a single project 24 == Installing a Trac plugin == 25 26 === For a single project === 28 27 29 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`. … … 34 33 * Run: 35 34 36 {{{ #!sh35 {{{ 37 36 $ python setup.py bdist_egg 38 37 }}} 39 38 40 You should have a *.egg file. Examine the output of running Python to find where this was created.39 You should have a *.egg file. Examine the output of running python to find where this was created. 41 40 42 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). … … 44 43 To uninstall a plugin installed this way, remove the egg from the `plugins` directory and restart the web server. 45 44 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 53 54 Some plugins , such as [trac:SpamFilter SpamFilter], are downloadable as an `.egg` file that can be installed with `easy_install`:55 {{{ #!sh56 $easy_install TracSpamFilter57 }}} 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.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 ==== 52 53 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 TracSpamFilter 56 }}} 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). 60 59 61 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`: 62 {{{ #!sh63 $easy_install --always-unzip TracSpamFilter-0.4.1_r10106-py2.6.egg61 {{{ 62 easy_install --always-unzip TracSpamFilter-0.4.1_r10106-py2.6.egg 64 63 }}} 65 64 You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents. … … 67 66 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. 68 67 69 ==== From source 68 ==== From source ==== 70 69 71 70 `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: 72 {{{ #!sh73 $easy_install http://svn.edgewall.com/repos/trac/plugins/0.12/spam-filter-captcha74 }}} 75 76 ==== Enabling the plugin 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 ethe path specified in the `[inherit] plugins_dir` configuration option.71 {{{ 72 easy_install http://svn.edgewall.com/repos/trac/plugins/0.12/spam-filter-captcha 73 }}} 74 75 ==== 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. 79 78 80 79 This is done in the `[components]` section of the configuration file. For example: 81 {{{ #!ini80 {{{ 82 81 [components] 83 82 tracspamfilter.* = enabled … … 86 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`). 87 86 88 After installing the plugin, you must restart your web server.89 90 ==== Uninstalling 87 Note: After installing the plugin, you must restart your web server. 88 89 ==== Uninstalling ==== 91 90 92 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: … … 98 97 99 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): 100 {{{ #!pycon99 {{{ 101 100 >>> import myplugin 102 101 >>> print myplugin.__file__ … … 104 103 }}} 105 104 106 == Setting up the plugin cache 105 == Setting up the plugin cache == 107 106 108 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. 109 108 110 109 To do this from the Apache configuration, use the `SetEnv` directive: 111 {{{ #!apache110 {{{ 112 111 SetEnv PYTHON_EGG_CACHE /path/to/dir 113 112 }}} 114 113 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 ein the same `<Location>` block.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. 116 115 117 116 For example (for CGI): 118 {{{ #!apache117 {{{ 119 118 <Location /trac> 120 119 SetEnv TRAC_ENV /path/to/projenv … … 124 123 125 124 Or (for mod_python): 126 {{{ #!apache125 {{{ 127 126 <Location /trac> 128 127 SetHandler mod_python … … 132 131 }}} 133 132 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. 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.'' 135 134 136 135 For [wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables. 137 136 138 '''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: 139 140 {{{ #!apache137 ''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 {{{ 141 140 FastCgiConfig -initial-env TRAC_ENV=/var/lib/trac -initial-env PYTHON_EGG_CACHE=/var/lib/trac/plugin-cache 142 141 }}} 143 142 144 === About hook scripts 143 === About hook scripts === 145 144 146 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. 147 146 148 == Troubleshooting 149 150 === Is setuptools properly installed? 147 == Troubleshooting == 148 149 === Is setuptools properly installed? === 151 150 152 151 Try this from the command line: 153 {{{ #!sh152 {{{ 154 153 $ python -c "import pkg_resources" 155 154 }}} … … 157 156 If you get '''no output''', setuptools '''is''' installed. Otherwise, you'll need to install it before plugins will work in Trac. 158 157 159 === Did you get the correct version of the Python egg? 158 === Did you get the correct version of the Python egg? === 160 159 161 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). … … 163 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. 164 163 165 === Is the plugin enabled? 166 167 If you install a plugin globally , ie ''not'' inside the `plugins` directory of the Trac project environment, you must explicitly enable it in [TracIni trac.ini]. Make sure that:168 169 * you actually added the necessary line(s) to the `[components]` section.170 * the package/module names are correct.171 * the value is "enabled", not "enable" or "Enable".172 * the section name is "components", not "component".173 174 === Check the permissions on the .egg file 164 === Is the plugin enabled? === 165 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: 167 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". 171 * ...the section name is "components", not "component". 172 173 === Check the permissions on the .egg file === 175 174 176 175 Trac must be able to read the .egg file. 177 176 178 === Check the log files 177 === Check the log files === 179 178 180 179 Enable [wiki:TracLogging logging] and set the log level to `DEBUG`, then watch the log file for messages about loading plugins. 181 180 182 === Verify you have proper permissions 181 === Verify you have proper permissions === 183 182 184 183 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. 185 184 186 === Is the wrong version of the plugin loading? 185 === Is the wrong version of the plugin loading? === 187 186 188 187 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: … … 193 192 * 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. 194 193 195 === If all of the above failed 194 === If all of the above failed === 196 195 197 196 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! 198 197 199 == Web-based plugin administration 198 == Web-based plugin administration == 200 199 201 200 The [trac:WebAdmin] interface offers limited support for plugin configuration through the web to users with `TRAC_ADMIN` permission: … … 204 203 * installing plugins by uploading them as eggs 205 204 206 If you wish to disable the second function for security reasons, add the following to the `[components]` section of trac.ini: 207 {{{ #!ini205 You probably want to disable the second function for security reasons: in `trac.ini`, in the `[components]` section, add the line 206 {{{ 208 207 trac.admin.web_ui.PluginAdminPanel = disabled 209 208 }}}
