source: wiki/pages/TracPlugins @ 40542

Last change on this file since 40542 was 40542, checked in by obi, 2 years ago

reset wiki files

File size: 12.9 KB
Line 
1[[PageOutline(2-5,Contents,pullout)]]
2
3= Trac plugins
4
5Trac is extensible with [trac:PluginList plugins]. Plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture], with special cases described in the [trac:TracDev/PluginDevelopment plugin development] page.
6
7== Plugin discovery
8
9From the user's point of view, a plugin is either a standalone .py file or an .egg package. Trac looks for plugins in Python's `site-packages` directory, the [TracIni#GlobalConfiguration global shared] `plugins` directory and the [TracEnvironment project environment] `plugins` directory. Components defined in globally-installed plugins must be explicitly enabled in the [[TracIni#components-section| [components] ]] section of the `trac.ini` file. Components defined in the `plugins` directory of the project environment are enabled, unless explicitly disabled in the `[components]` section of the `trac.ini` file.
10
11== Requirements for Trac eggs
12
13To use egg-based plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (version >= 0.6) installed.
14
15To install `setuptools`, download the bootstrap module [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] and execute it as follows:
16
17{{{#!sh
18$ python ez_setup.py
19}}}
20
21If the `ez_setup.py` script fails to install the setuptools release, you can download it from [pypi:setuptools PyPI] and install it manually.
22
23Plugins can also consist of a single `.py` file dropped directly into either the project's or the shared `plugins` directory.
24
25== Installing a Trac plugin
26
27=== For a single project
28
29Plugins are typically packaged as [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs]. That means they are .zip archives with the file extension `.egg`.
30
31If you have downloaded a source distribution of a plugin, and want to build the `.egg` file:
32
33 * Unpack the source. It should provide `setup.py`.
34 * Run:
35 {{{#!sh
36$ python setup.py bdist_egg
37}}}
38
39You should now have an *.egg file. Examine the output of running Python to find where this was created.
40
41Once 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, ie kill the process and run again.
42
43To uninstall a plugin installed this way, remove the egg from the `plugins` directory and restart the web server.
44
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 are running Trac under Python 2.6, but have upgraded your standalone Python to 2.7, the eggs won't be recognized.
46
47'''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.
48
49=== For all projects
50
51==== With an .egg file
52
53Some plugins, such as [trac:SpamFilter SpamFilter], are downloadable as an `.egg` file that can be installed with `easy_install` or `pip`:
54{{{#!sh
55$ easy_install TracSpamFilter
56$ pip install TracSpamFilter
57}}}
58
59If `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:\Python27\Scripts`) to their `PATH` environment variable, or use the full path to `easy_install` (for example, `C:\Python27\Scripts\easy_install.py`). See [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes easy_install Windows notes] for more information.
60
61`pip` is included in Python 2.7.9. In earlier versions of Python it can be installed through the package manager of your OS (e.g. `apt-get install python-pip`) or using the [https://pip.pypa.io/en/latest/installing.html#install-pip get_pip.py].
62
63If Trac reports permission errors after installing a zipped egg, and you would rather not bother providing an 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`:
64{{{#!sh
65$ easy_install --always-unzip TracSpamFilter-0.4.1_r10106-py2.6.egg
66}}}
67You should end up with a directory having the same name as the zipped egg, complete with `.egg` extension, and containing its uncompressed contents.
68
69Trac 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.
70
71==== From source
72
73`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:
74{{{#!sh
75$ easy_install http://svn.edgewall.com/repos/trac/plugins/0.12/spam-filter-captcha
76}}}
77
78==== Enabling the plugin
79
80Unlike 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, ie the path specified in the `[inherit] plugins_dir` configuration option.
81
82This is done in the `[components]` section of the configuration file `trac.ini`. For example:
83{{{#!ini
84[components]
85tracspamfilter.* = enabled
86}}}
87
88The 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`.
89
90After installing the plugin, you must restart your web server.
91
92==== Uninstalling
93
94Neither `easy_install` nor `python setup.py` have an uninstall feature. However, it is usually trivial to remove a globally installed egg and reference:
95
96 1. Do `easy_install -m [plugin name]` to remove references from `$PYTHONLIB/site-packages/easy-install.pth` when the plugin installed by setuptools.
97 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`.
98 1. Delete the .egg file or folder from where it's installed, usually inside `$PYTHONLIB/site-packages/`.
99 1. Restart the web server.
100
101If you are uncertain about the location of the egg file, you can try to locate it by replacing `myplugin` with whatever namespace the plugin uses (as used when enabling the plugin):
102{{{#!pycon
103>>> import myplugin
104>>> print myplugin.__file__
105/opt/local/python24/lib/site-packages/myplugin-0.4.2-py2.4.egg/myplugin/__init__.pyc
106}}}
107
108== Setting up the plugin cache
109
110Some plugins 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 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.
111
112To do this from the Apache configuration, use the `SetEnv` directive:
113{{{#!apache
114SetEnv PYTHON_EGG_CACHE /path/to/dir
115}}}
116
117This 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], ie in the same `<Location>` block.
118
119For example for CGI:
120{{{#!apache
121 <Location /trac>
122   SetEnv TRAC_ENV /path/to/projenv
123   SetEnv PYTHON_EGG_CACHE /path/to/dir
124 </Location>
125}}}
126
127Or for mod_python:
128{{{#!apache
129 <Location /trac>
130   SetHandler mod_python
131   ...
132   SetEnv PYTHON_EGG_CACHE /path/to/dir
133 </Location>
134}}}
135
136'''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.
137
138For [wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables.
139
140'''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:
141
142{{{#!apache
143FastCgiConfig -initial-env TRAC_ENV=/var/lib/trac -initial-env PYTHON_EGG_CACHE=/var/lib/trac/plugin-cache
144}}}
145
146=== About hook scripts
147
148If 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.
149
150== Web-based plugin administration
151
152The [trac:WebAdmin] interface offers limited support for plugin configuration through the web to users with `TRAC_ADMIN` permission:
153
154* en/disabling installed plugins
155* installing plugins by uploading them as eggs
156
157If you wish to disable the second function for security reasons, add the following to your `trac.ini` file:
158{{{#!ini
159[components]
160trac.admin.web_ui.PluginAdminPanel = disabled
161}}}
162This disables the whole panel, so the first function will no longer be available either.
163
164== Troubleshooting
165
166=== Is setuptools properly installed?
167
168Try this from the command line:
169{{{#!sh
170$ python -c "import pkg_resources"
171}}}
172
173If you get '''no output''', setuptools '''is''' installed. Otherwise, you'll need to install it before plugins will work in Trac.
174
175=== Did you get the correct version of the Python egg?
176
177Python 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).
178
179Also, 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.
180
181=== Is the plugin enabled?
182
183If 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:
184
185 * you actually added the necessary line(s) to the `[components]` section.
186 * the package/module names are correct and do not contain typos.
187 * the value is "enabled", not "enable" or "Enable".
188 * the section name is "components", not "component".
189
190=== Check the permissions on the .egg file
191
192Trac must be able to read the .egg file.
193
194=== Check the log files
195
196Enable [wiki:TracLogging logging] and set the log level to `DEBUG`, then watch the log file for messages about loading plugins.
197
198=== Verify you have the proper permissions
199
200Some 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.
201
202=== Is the wrong version of the plugin loading?
203
204If 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:
205
206 * 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.
207 * 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.
208 * 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.
209 * Having more than one version listed inside Python site-packages is fine, ie installed with `setup.py install`, because 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 the version number nor the 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.
210
211=== If all of the above failed
212
213Okay, 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!
214
215----
216See also TracGuide, [trac:PluginList plugin list], [trac:TracDev/ComponentArchitecture component architecture].
Note: See TracBrowser for help on using the repository browser.