| 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 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 | | |
| 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: |
| 16 | | |
| 17 | | {{{#!sh |
| 18 | | $ python ez_setup.py |
| 19 | | }}} |
| 20 | | |
| 21 | | If the `ez_setup.py` script fails to install the setuptools release, you can download it from [pypi:setuptools PyPI] and install it manually. |
| 22 | | |
| 23 | | Plugins can also consist of a single `.py` file dropped directly into either the project's or the shared `plugins` directory. |
| | 9 | From the user's point of view, a plugin is either a standalone .py file or a package (egg or wheel). 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. |
| 53 | | Some 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 | | |
| 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:\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. |
| | 39 | Some plugins, such as [https://trac-hacks.org/wiki/TagsPlugin TracTags], are downloadable as an `.egg` file that can be installed with `easy_install` or `pip`: |
| | 40 | {{{#!sh |
| | 41 | $ easy_install TracTags |
| | 42 | }}} |
| | 43 | {{{#!sh |
| | 44 | $ pip install TracTags |
| | 45 | }}} |
| | 46 | |
| | 47 | If `easy_install` is not on your system, see the [trac:setuptools#Installsetuptools Trac setuptools documentation]. |
| 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 | | }}} |
| | 61 | `easy_install` and `pip` make installing from source a snap. Just give it the URL to either a repository or a tarball/zip of the source: |
| | 62 | {{{#!sh |
| | 63 | $ easy_install https://trac-hacks.org/svn/tagsplugin/trunk |
| | 64 | }}} |
| | 65 | {{{#!sh |
| | 66 | $ pip install svn+https://trac-hacks.org/svn/tagsplugin/trunk |
| | 67 | }}} |
| | 68 | When installing from a repository using `pip`, be sure to use the repository type in the protocol. For example, `svn+https` for Subversion and `git+https` for Git. |
| | 84 | ==== Upgrading the environment |
| | 85 | |
| | 86 | Some plugins may require an environment upgrade. This will typically be necessary for plugins that implement `IEnvironmentSetupParticipant`. Common reasons for requiring an environment upgrade are to add tables to the database or add configuration parameters to trac.ini. A notification will be displayed when accessing Trac for the first time after installing a plugin and restarting the web server. To upgrade the environment, run the command: |
| | 87 | |
| | 88 | {{{#!sh |
| | 89 | $ trac-admin /path/to/env upgrade |
| | 90 | }}} |
| | 91 | |
| | 92 | A database backup will be made before upgrading the environment, unless the `--no-backup` option is specified. For more information, refer to the documentation output by `trac-admin /path/to/env help upgrade`. |
| | 93 | |
| | 94 | ==== Redeploying static resources |
| | 95 | |
| | 96 | If you [TracInstall#MappingStaticResources mapped static resources] so they are served by the web server, and the plugin contains static resources (CSS, !JavaScript and image files), the resources will need to be deployed to the location on the filesystem that is served by the web server. |
| | 97 | |
| | 98 | Execute the `deploy` command, as was done during install and [TracUpgrade#a5.Refreshstaticresources upgrade]: |
| | 99 | |
| | 100 | {{{#!sh |
| | 101 | $ trac-admin /path/to/env deploy /deploy/path |
| | 102 | }}} |
| | 103 | |
| | 104 | After executing the command, you must restart your web server. |
| | 105 | |
| | 106 | {{{#!div style="border: 1pt dotted; margin: 1em" |
| | 107 | **Note:** Some web browsers (IE, Opera) cache CSS and Javascript files, so you should instruct your users to manually erase the contents of their browser's cache. A forced refreshed (SHIFT + <F5>) should be enough. |
| | 108 | {{{#!comment |
| | 109 | Remove above note once #9936 is fixed. |
| | 110 | }}} |
| | 111 | }}} |
| | 112 | |
| | 113 | ==== Upgrading a Plugin |
| | 114 | |
| | 115 | Normally, upgrading a plugin is simply a matter of repeating the install process. You may want to [#Uninstalling uninstall] old versions of the plugin. |
| | 116 | |
| | 117 | The `pip install` command has an `--upgrade (-U)` switch that will uninstall the old version and install the new version. The command can have some unintended side-effects though, because it will also upgrade the plugin dependencies. For example, if `Trac` is listed as a dependency of the plugin in `setup.py`, the latest version of Trac will be downloaded and installed. This may not be what you want if you are running an older version of Trac because not all your plugins are compatible with the latest version of Trac, or you simply haven't done the appropriate planning for upgrading Trac. Uninstalling and then installing the plugin can be a safer option: |
| | 118 | {{{#!sh |
| | 119 | $ pip uninstall <pluginname> |
| | 120 | $ pip install <pluginname> |
| | 121 | }}} |
| | 122 | |
| | 123 | Alternatively you can use a [https://pip.pypa.io/en/stable/user_guide/#requirements-files requirements file] and pin the versions of the packages that you don't want to implicitly upgrade. |
| | 124 | |
| 110 | | Some 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 | | |
| 112 | | To do this from the Apache configuration, use the `SetEnv` directive: |
| 113 | | {{{#!apache |
| 114 | | SetEnv PYTHON_EGG_CACHE /path/to/dir |
| 115 | | }}} |
| 116 | | |
| 117 | | 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], ie in the same `<Location>` block. |
| 118 | | |
| 119 | | For 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 | | |
| 127 | | Or 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 | | |
| 138 | | For [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 |
| 143 | | FastCgiConfig -initial-env TRAC_ENV=/var/lib/trac -initial-env PYTHON_EGG_CACHE=/var/lib/trac/plugin-cache |
| 144 | | }}} |
| 145 | | |
| 146 | | === About hook scripts |
| 147 | | |
| 148 | | 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. |
| | 150 | Some plugins will need to be extracted by the Python egg's runtime. See [wiki:TracInstall#egg-cache] for information on setting up the egg cache. |
