Changes between Version 1 and Version 2 of TracPlugins
- Timestamp:
- Jun 16, 2013 4:29:29 PM (11 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracPlugins
v1 v2 3 3 4 4 Since version 0.9, Trac supports [trac:PluginList plugins] that extend the built-in functionality. The plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture]. 5 6 Plugins can be either installed globally, in a shared plugins directory (see [TracIni#GlobalConfiguration Global Configuration]) or locally for specific TracEnvironment, in its `plugins` directory. 7 Except for the later case, the components defined in a plugin should be explicitly enabled in the [[TracIni#components-section| [components] ]] section of the trac.ini file. 5 8 6 9 == Requirements == … … 15 18 If 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. 16 19 17 Plugins can also consist of a single `.py` file dropped into either the environment or global `plugins` directory ''(since [milestone:0.10])''. See TracIni#GlobalConfiguration.20 Plugins can also consist of a single `.py` file dropped into either the environment or the shared plugins directory. 18 21 19 22 == Installing a Trac Plugin == … … 32 35 Then you will have a *.egg file. Examine the output of running python to find where this was created. 33 36 34 Once 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. 37 Once 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. Then, restart the web server (this requirement was not previously mentioned in this document, but in my tests it began working only after I did so). 35 38 36 39 To uninstall a plugin installed this way, remove the egg from `plugins` directory and restart web server. … … 38 41 Note that the Python version that the egg is built with must 39 42 match the Python version with which Trac is run. If for 40 instance you are running Trac under Python 2. 3, but have41 upgraded your standalone Python to 2. 4, the eggs won't be43 instance you are running Trac under Python 2.5, but have 44 upgraded your standalone Python to 2.6, the eggs won't be 42 45 recognized. 43 46 … … 53 56 }}} 54 57 55 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:\Python2 3\Scripts`) to their `PATH` environment variable (see [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes easy_install Windows notes] for more information).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). 56 59 57 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`: … … 61 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. 62 65 63 Trac also searches for globally installed plugins ''(since 0.10)'', see TracIni#GlobalConfiguration.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. 64 67 65 68 ==== From source ==== … … 67 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: 68 71 {{{ 69 easy_install http://svn.edgewall.com/repos/trac/ sandbox/spam-filter72 easy_install http://svn.edgewall.com/repos/trac/plugins/0.11/spam-filter 70 73 }}} 71 74 72 75 ==== Enabling the plugin ==== 73 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 path specified in the `[inherit] plugins_dir` configuration option. This is done in the `[components]` section of the configuration file, for example: 76 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 shared plugins directory, i.e. the path specified in the `[inherit] plugins_dir` configuration option. 77 78 This is done in the `[components]` section of the configuration file, for example: 74 79 {{{ 75 80 [components] … … 98 103 == Setting up the Plugin Cache == 99 104 100 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 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.105 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. 101 106 102 107 To do this from the Apache configuration, use the `SetEnv` directive as follows: … … 105 110 }}} 106 111 107 This works whether you are using the CGI or the mod_pythonfront-end. Put this directive next to where you set the path to the [wiki:TracEnvironment Trac environment], i.e. in the same `<Location>` block.112 This 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. 108 113 109 114 For example (for CGI): … … 120 125 SetHandler mod_python 121 126 ... 122 PythonOptionPYTHON_EGG_CACHE /path/to/dir127 SetEnv PYTHON_EGG_CACHE /path/to/dir 123 128 </Location> 124 129 }}} … … 126 131 ''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.'' 127 132 128 For FastCGI, you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables.133 For [wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables. 129 134 130 135 ''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. … … 151 156 === Did you get the correct version of the Python egg? === 152 157 153 Python 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).158 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). 154 159 155 160 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.
