Changes between Version 1 and Version 2 of TracPlugins

Timestamp:

Sep 4, 2005, 10:49:38 PM (19 years ago)

Author:

Christopher Lenz

Comment:

Cleanup

TracPlugins

@@ -1 @@
-= Trac Plugin Installation Guide =
+= Trac Plugins =
 
-Trac [milestone:0.9 0.9] and later supports plugins that extend the builtin functionality. The plugin functionality is based on the [wiki:TracDev/ComponentArchitecture component architecture].
+Since version 0.9, Trac supports plugins that extend the built-in functionality. The plugin functionality is based on the [http://projects.edgewall.com/trac/wiki/TracDev/ComponentArchitecture component architecture].
 
 == Requirements ==
 
-To plugins in Trac, the following software packages must be installed:
+To use plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version 0.5a13 installed.
 
- * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.5a13 for using plugins
-
+To install `setuptools`, download the bootstrap module [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] and execute it as follows:
+{{{
+$ python ez_setup.py setuptools==0.5a13
+}}}
 
 == Installing a Trac Plugin ==
 
-As example we use the TracWebAdmin plugin.
+Plugins are packaged as [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs]. That means they are ZIP archives with the file extension `.egg`. If you have downloaded a source distribution of a plugin, you can run:
+{{{
+$ setup.py bdist_egg
+}}}
+to build the `.egg` file.
 
-=== Step 1. downloading TracWebAdmin ===
+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.
 
-Checkout the lastes version:
-{{{
-$ svn co http://svn.edgewall.com/repos/trac/branches/jonas-dev/webadmin webadmin
-}}}
+== Setting up the Plugin Cache ==
 
-=== Step 2. build the plugin ===
+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.
 
-Build the Trac Plugin by running the following command at the top of the source directory
-{{{
-$ python ./setup.py bdist_egg clean
-}}}
-
-=== Step 3. copy the Plugin into your Trac Environment Plugin Directory ===
-
-{{{
-$ cp ./dist/TracWebAdmin-0.1.egg /path/to/projectenv/plugins/
-}}}
-
-''Note: The user account under which the web server runs will require read permissions to the environment plugin directory and all the files inside.''
-
-=== Step 4. configure your Trac plugin ===
-
-Please consult the documentation of each plugin for further configuration.[[BR]]
-For TracWebAdmin you need to login as an user with TRAC_ADMIN rights.
-
-''Enjoy!''
-
-== Troubleshooting ==
-
-'''Setting up plugin cache directory'''
-
-Plugins need a cache directory, the user account under which the web server runs will require write permissions to that directory.
-
-Put the following in your httpd.conf in the <Location> block
+To do this from the Apache configuration, use the `SetEnv` directive as follows:
 {{{
 SetEnv PYTHON_EGG_CACHE /path/to/dir
 }}}
 
-'''installing [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.5a13 '''
-
-Install Setup-Tools by running the following command at the top of the plugin source directory
-{{{
-python ez_setup/__init__.py
-}}}
+This works whether your using the [wiki:TracCgi CGI] or the [wiki:TracModPython mod_python] front-end. For [wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables.
 
 ----