Changes between Initial Version and Version 1 of TracPlugins

Timestamp:

Aug 31, 2005, 4:22:41 PM (19 years ago)

Author:

dna

Comment:

how to install trac plugins as python eggs in Trac 0.9

TracPlugins

@@ +1 @@
+= Trac Plugin Installation Guide =
+
+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].
+
+== Requirements ==
+
+To plugins in Trac, the following software packages must be installed:
+
+ * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.5a13 for using plugins
+
+
+== Installing a Trac Plugin ==
+
+As example we use the TracWebAdmin plugin.
+
+=== Step 1. downloading TracWebAdmin ===
+
+Checkout the lastes version:
+{{{
+$ svn co http://svn.edgewall.com/repos/trac/branches/jonas-dev/webadmin webadmin
+}}}
+
+=== Step 2. build the plugin ===
+
+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
+{{{
+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
+}}}
+
+----
+See also TracGuide, [wiki:TracDev/ComponentArchitecture component architecture]