Mercurial > genshi > mirror

comparison examples/trac/wiki-default/TracModPython @ 39:93b4dcbafd7b trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Copy Trac to main branch.
author cmlenz
date Mon, 03 Jul 2006 18:53:27 +0000
parents
children
comparison
equal deleted inserted replaced
38:ee669cb9cccc 39:93b4dcbafd7b
1 = Trac and mod_python =
2
3 Trac supports [http://www.modpython.org/ mod_python], which speeds up Trac's response times considerably and permits use of many Apache features not possible with [wiki:TracStandalone tracd]/mod_proxy.
4
5 == Simple configuration ==
6
7 If you just installed mod_python, you may have to add a line to load the module in the Apache configuration:
8 {{{
9 LoadModule python_module modules/mod_python.so
10 }}}
11
12 A simple setup of Trac on mod_python looks like this:
13 {{{
14 <Location /projects/myproject>
15 SetHandler mod_python
16 PythonHandler trac.web.modpython_frontend
17 PythonOption TracEnv /var/trac/myproject
18 PythonOption TracUriRoot /projects/myproject
19 </Location>
20 }}}
21
22 Note that the option `TracUriRoot` may or may not be necessary in your setup. Try without first, and if the URLs produced by Trac look wrong or if Trac does not seem to recognize the URLs correctly, add the `TracUriRoot` option.
23
24 Configuring authentication works the same as for [wiki:TracCgi#AddingAuthentication CGI]:
25 {{{
26 <Location "/projects/myproject/login">
27 AuthType Basic
28 AuthName "myproject"
29 AuthUserFile /var/trac/myproject/.htaccess
30 Require valid-user
31 </Location>
32 }}}
33
34 If the Trac installation isn't installed in your Python path, you'll have to tell Apache where to find the Trac mod_python handler using the `PythonPath` directive:
35 {{{
36 <Location /projects/myproject>
37 ...
38 PythonPath "sys.path + ['/path/to/trac']"
39 ...
40 </Location>
41 }}}
42
43
44 == Setting up multiple projects ==
45
46 The Trac mod_python handler handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`:
47 {{{
48 <Location /projects>
49 SetHandler mod_python
50 PythonHandler trac.web.modpython_frontend
51 PythonOption TracEnvParentDir /var/trac
52 PythonOption TracUriRoot /projects
53 </Location>
54 }}}
55
56 When you request the `/projects` URL, you will get a listing of all subdirectories of the directory you set as `TracEnvParentDir`. Selecting any project in the list will bring you to the corresponding Trac environment.
57
58 If you don't want to have the subdirectory listing as your projects home page you can use a
59 {{{
60 <LocationMatch "/.+/">
61 }}}
62
63 This will instruct Apache to use mod_python for all locations different from root while having the possibility of placing a custom home page for root in your !DocumentRoot folder.
64
65 You can also use the same authentication realm for all of the projects using a `<LocationMatch>` directive:
66 {{{
67 <LocationMatch "/[^/]+/login">
68 AuthType Basic
69 AuthName "Trac"
70 AuthUserFile /var/trac/.htaccess
71 Require valid-user
72 </LocationMatch>
73 }}}
74
75 == Virtual Host Configuration ==
76
77 Below is the sample configuration required to set up your trac as a virtual server (i.e. when you access it at the URLs like
78 !http://trac.mycompany.com):
79
80 {{{
81 <VirtualHost * >
82 DocumentRoot /var/trac/myproject
83 ServerName trac.mycompany.com
84 <Directory />
85 SetHandler mod_python
86 PythonHandler trac.web.modpython_frontend
87 PythonOption TracEnv /var/trac/myproject
88 PythonOption TracUriRoot /
89 </Directory>
90 <Location /login>
91 AuthType Basic
92 AuthName "MyCompany Trac Server"
93 AuthUserFile /var/trac/myproject/.htusers
94 Require valid-user
95 </Location>
96 </VirtualHost>
97 }}}
98
99 == Troubleshooting ==
100
101 === Form submission problems ===
102
103 If you're experiencing problems submitting some of the forms in Trac (a common problem is that you get redirected to the start page after submission), check whether your {{{DocumentRoot}}} contains a folder or file with the same path that you mapped the mod_python handler to. For some reason, mod_python gets confused when it is mapped to a location that also matches a static resource.
104
105 === Using .htaccess ===
106
107 Although it may seem trivial to rewrite the above configuration as a directory in your document root with a `.htaccess` file, this does not work. Apache will append a "/" to any Trac URLs, which interferes with its correct operation.
108
109 It may be possible to work around this with mod_rewrite, but I failed to get this working. In all, it is more hassle than it is worth. Stick to the provided instructions. :)
110
111 === Win32 Issues ===
112
113 If you run trac with mod_python (3.1.3 or 3.1.4) on Windows,
114 uploading attachments will '''not''' work.
115 This is a known problem which we can't solve cleanly at the Trac level.
116
117 However, there is a workaround for this at the mod_python level,
118 which is to apply the following patch [http://projects.edgewall.com/trac/attachment/ticket/554/util_py.patch attachment:ticket:554:util_py.patch]
119 to the (Lib/site-packages)/modpython/util.py file.
120
121 If you don't have the `patch` command, that file can be replaced with the [http://svn.apache.org/viewcvs.cgi/httpd/mod_python/trunk/lib/python/mod_python/util.py?rev=103562&view=markup fixed util.py] (fix which, although done prior to the 3.1.4 release, is ''not''
122 present in 3.1.4).
123
124 === OS X issues ===
125
126 When using mod_python on OS X you will not be able to restart Apache using `apachectl restart`. This is apparently fixed in mod_python 3.2, but there's also a patch available for earlier versions [http://www.dscpl.com.au/projects/vampire/patches.html here].
127
128 ----
129 See also TracGuide, TracInstall, TracCgi, TracFastCgi
Copyright (C) 2012-2017 Edgewall Software