Changes between Version 5 and Version 6 of 1.3/TracPlugins
- Timestamp:
- Aug 27, 2019, 1:08:41 AM (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
1.3/TracPlugins
v5 v6 17 17 Packages built for a single project must use the egg 18 18 format, as the wheel format (described below) is not 19 supported by the setuptool loading mechanism. Build the `egg` file from the plugin source:19 supported by the setuptools loading mechanism. Build the `egg` file from the plugin source: 20 20 21 21 * Checkout or download and unpack the source. … … 30 30 Make sure the web server has sufficient permissions to read the plugin egg and restart the web server. If you are running as a [TracStandalone "tracd" standalone server], restart tracd (i.e. kill the process and run again). 31 31 32 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.33 34 '''Note''': the minor version number of the Python used to build the egg ''must'' match the minor version number of the Python running Trac. For example, if you are running Trac with Python 2.6, but build the egg with Python 2.7, the egg won't be recognized.35 36 '''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.32 Trac also searches for plugins installed in the [TracIni#GlobalConfiguration global shared] plugins directory. This is a convenient way to share the installation of plugins across several, but not all, environments. 33 34 '''Note''': The minor version number of the Python used to build the egg ''must'' match the minor version number of the Python running Trac. For example, if you are running Trac with Python 2.6, but build the egg with Python 2.7, the egg won't be recognized. 35 36 '''Note''': In a multi-project setup, a pool of Python interpreters 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 plugin in different projects of a multi-project setup. Install plugins for all projects (see below) and enable them as needed for each project. 37 37 38 38 ==== Uninstalling … … 59 59 The version can be specified, which can be useful if you don't want to install the latest: 60 60 {{{#!sh 61 $ pip install TracTags==0. 961 $ pip install TracTags==0.10 62 62 }}} 63 63 … … 93 93 }}} 94 94 95 The name of the option is the plugin package name. 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 containsa file named `__init__.py`.95 The name of the option is the plugin package name. This should be specified in the documentation of the plugin, but can also be discovered by looking at the source: it is usually the top-level directory name containing a file named `__init__.py`. 96 96 97 97 Plugins can also be enabled from the [#Web-basedpluginadministration administration] page. … … 151 151 == Web-based plugin administration 152 152 153 The !WebAdmin interface offers limited support for plugin configuration through the webto users with `TRAC_ADMIN` permission:154 155 * en/dis abling installed plugins153 The admin page offers limited support for plugin configuration to users with `TRAC_ADMIN` permission: 154 155 * en/dis-abling installed plugins 156 156 * installing plugins by uploading them as eggs 157 157 … … 165 165 == Setting up the plugin cache 166 166 167 Some plugins installed as eggs will need to be extracted by the Python egg's runtime (`pkg_resources`), so that their contents are actual files on the file system. The directory inwhich 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.167 Some plugins installed as eggs will need to be extracted by the Python egg's runtime (`pkg_resources`), so that their contents are actual files on the file system. The directory to 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. 168 168 169 169 To do this from the Apache configuration, use the `SetEnv` directive: … … 172 172 }}} 173 173 174 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], iein the same `<Location>` block.174 This works whether you're using the [TracCgi CGI] or the [TracModPython mod_python] front-end. Put this directive next to where you set the path to the [TracEnvironment Trac environment], i.e. in the same `<Location>` block. 175 175 176 176 For example for CGI: … … 193 193 '''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. 194 194 195 For [ wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables.195 For [TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables. 196 196 197 197 '''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: … … 203 203 === About hook scripts 204 204 205 If 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.205 If you have Subversion hook scripts that invoke Trac, 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. 206 206 207 207 == Writing Trac Plugins … … 210 210 * [trac:TracDev Developer documentation] 211 211 * [https://trac-hacks.org Examples on trac-hacks.org] 212 * [trac:browser:branches/1. 2-stable/sample-plugins sample-plugins]212 * [trac:browser:branches/1.4-stable/sample-plugins sample-plugins] 213 213 214 214 == Troubleshooting … … 218 218 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). 219 219 220 Also, verify that the egg file you downloaded is indeed a .zip archive. If you downloaded it from a Trac site, chances are youdownloaded the HTML preview page instead.220 Also, verify that the egg file you downloaded is indeed a .zip archive. If you downloaded it from a Trac site, you may have downloaded the HTML preview page instead. 221 221 222 222 === Is the plugin enabled? 223 223 224 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:224 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: 225 225 226 226 * you added the necessary line(s) to the `[components]` section. … … 229 229 * the section name is `components`, not `component`. 230 230 231 === Check the permissions on the .egg file232 233 Trac must be able to read the . egg file.231 === Check the permissions 232 233 Trac must be able to read the .py file or package (.egg or .whl). 234 234 235 235 === Check the log files … … 239 239 === Verify you have the proper permissions 240 240 241 Some plugins require you have special permissions in order to use them. !TracTags, for example, requires `TAGS_VIEW` permissions for the //Tags// navigation item to be added.241 Some plugins require you have special permissions. !TracTags, for example, requires `TAGS_VIEW` permissions for the //Tags// navigation item to be added. 242 242 243 243 === Is the wrong version of the plugin loading? 244 244 245 If you put your plugins in side pluginsdirectories, 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:246 247 * Only one version of the plugin can be loaded for each running Trac server, i eeach 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.245 If you put your plugins in one of the `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: 246 247 * 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. 248 248 * A globally installed plugin will override any version in the global or project plugins directories. A plugin from the global plugins directory will be discovered ''before'' any project plugins directory. 249 249 * 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 unpredicatable 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. … … 252 252 === If all of the above failed 253 253 254 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] or [trac:MailingList].254 See TracSupport. 255 255 256 256 ---- 257 See also TracGuide, [trac:PluginList plugin list], [trac:TracDev/ComponentArchitecture component architecture].257 See also TracGuide, TracIni.
