Changes between Version 1 and Version 2 of TracModWSGI


Ignore:
Timestamp:
Apr 4, 2011, 10:40:05 PM (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracModWSGI

    v1 v2  
    11= Trac and mod_wsgi =
    22
    3 '''Important note:''' ''Please use either version 1.3 or 2.3 or later of `mod_wsgi`. Version 2.0 has problems with downloading attachments (see [trac:ticket:7205 #7205]).''
     3'''Important note:''' ''Please use either version 1.6, 2.4 or later of `mod_wsgi`. Versions prior to 2.4 in the 2.X branch have problems with some Apache configurations that use WSGI file wrapper extension. This extension is used in Trac to serve up attachments and static media files such as style sheets. If you are affected by this problem attachments will appear to be empty and formatting of HTML pages will appear not to work due to style sheet files not loading properly. See mod_wsgi tickets [http://code.google.com/p/modwsgi/issues/detail?id=100 #100] and [http://code.google.com/p/modwsgi/issues/detail?id=132 #132].''
    44
    5 [http://code.google.com/p/modwsgi/ mod_wsgi] is an Apache module for running WSGI-compatible Python applications directly on top of Apache:
     5[http://code.google.com/p/modwsgi/ mod_wsgi] is an Apache module for running WSGI-compatible Python applications directly on top of Apache. The mod_wsgi adapter is written completely in C and provides significantly better performance than using existing WSGI adapters for mod_python or CGI.
    66
    7   The mod_wsgi adapter is an Apache module that provides a WSGI compliant interface for hosting Python based web applications within Apache. The adapter is written completely in C code against the Apache C runtime and for hosting WSGI applications within Apache provides significantly better performance than using existing WSGI adapters for mod_python or CGI.
    8 
    9 It is already possible to run Trac on top of mod_wsgi. This can be done by writing the following application script, which is just a Python file, though usually saved with a .wsgi extension).
     7Trac can be run on top of mod_wsgi with the help of the following application script, which is just a Python file, though usually saved with a .wsgi extension). This file can be created using '''trac-admin <env> deploy <dir>''' command which automatically substitutes required paths.
    108
    119{{{
     10#!python
    1211import os
    1312
     
    1918}}}
    2019
    21 The {{{TRAC_ENV}}} variable should naturally be the directory for your Trac environment (if you have several Trac environments in a directory, you can also use {{{TRAC_ENV_PARENT_DIR}}} instead), while the {{{PYTHON_EGG_CACHE}}} should be a directory where Python can temporarily extract Python eggs. [[BR]]
    22 For clarity, you should give this file a {{{.wsgi}}} extension. You should probably put the file in it's own directory, since you will open up its directory to Apache.
    23 You can create a .wsgi files which handles all this for you by running the TracAdmin command {{{deploy}}}.
     20The `TRAC_ENV` variable should naturally be the directory for your Trac environment (if you have several Trac environments in a directory, you can also use `TRAC_ENV_PARENT_DIR` instead), while the `PYTHON_EGG_CACHE` should be a directory where Python can temporarily extract Python eggs.
     21
     22'''Important note:''' If you're using multiple `.wsgi` files (for example one per Trac environment) you must ''not'' use `os.environ['TRAC_ENV']` to set the path to the Trac environment. Using this method may lead to Trac delivering the content of another Trac environment. (The variable may be filled with the path of a previously viewed Trac environment.) To solve this problem, use the following `.wsgi` file instead:
     23
     24{{{
     25#!python
     26import os
     27
     28os.environ['PYTHON_EGG_CACHE'] = '/usr/local/trac/mysite/eggs'
     29
     30import trac.web.main
     31def application(environ, start_response):
     32  environ['trac.env_path'] = '/usr/local/trac/mysite'
     33  return trac.web.main.dispatch_request(environ, start_response)
     34}}}
     35
     36For clarity, you should give this file a `.wsgi` extension. You should probably put the file in it's own directory, since you will open up its directory to Apache. You can create a .wsgi files which handles all this for you by running the TracAdmin command `deploy`.
    2437
    2538If you have installed trac and eggs in a path different from the standard one you should add that path by adding the following code on top of the wsgi script:
     39
    2640{{{
     41#!python
    2742import site
    2843site.addsitedir('/usr/local/trac/lib/python2.4/site-packages')
    2944}}}
     45
    3046Change it according to the path you installed the trac libs at.
    3147
     
    5571
    5672For troubleshooting tips, see the [TracModPython#Troubleshooting mod_python troubleshooting] section, as most Apache-related issues are quite similar, plus discussion of potential [http://code.google.com/p/modwsgi/wiki/ApplicationIssues application issues] when using mod_wsgi.
     73
     74''Note: using mod_wsgi 2.5 and Python 2.6.1 gave an Internal Server Error on my system (Apache 2.2.11 and Trac 0.11.2.1). Upgrading to Python 2.6.2 (as suggested [http://www.mail-archive.com/modwsgi@googlegroups.com/msg01917.html here]) solved this for me[[BR]]-- Graham Shanks''
     75
     76== Apache Basic Authentication for Trac thru mod_wsgi ==
     77
     78Per the mod_wsgi documentation linked to above, here is an example Apache configuration that a) serves the trac from a virtualhost subdomain and b) uses Apache basic authentication for Trac authentication.
     79
     80
     81If you want your trac to be served from e.g. !http://trac.my-proj.my-site.org, then from the folder e.g. {{{/home/trac-for-my-proj}}}, if you used the command {{{trac-admin the-env initenv}}} to create a folder {{{the-env}}}, and you used {{{trac-admin the-env deploy the-deploy}}} to create a folder {{{the-deploy}}}, then:
     82
     83create the htpasswd file:
     84{{{
     85cd /home/trac-for-my-proj/the-env
     86htpasswd -c htpasswd firstuser
     87### and add more users to it as needed:
     88htpasswd htpasswd seconduser
     89}}}
     90(for security keep the file above your document root)
     91
     92create this file e.g. (ubuntu) {{{/etc/apache2/sites-enabled/trac.my-proj.my-site.org.conf}}} with these contents:
     93
     94{{{
     95<Directory /home/trac-for-my-proj/the-deploy/cgi-bin/trac.wsgi>
     96  WSGIApplicationGroup %{GLOBAL}
     97  Order deny,allow
     98  Allow from all
     99</Directory>
     100
     101<VirtualHost *:80>
     102  ServerName trac.my-proj.my-site.org
     103  DocumentRoot /home/trac-for-my-proj/the-env/htdocs/
     104  WSGIScriptAlias / /home/trac-for-my-proj/the-deploy/cgi-bin/trac.wsgi
     105  <Location '/'>
     106    AuthType Basic
     107    AuthName "Trac"
     108    AuthUserFile /home/trac-for-my-proj/the-env/htpasswd
     109    Require valid-user
     110  </Location>
     111</VirtualHost>
     112
     113}}}
     114
     115
     116(for subdomains to work you would probably also need to alter /etc/hosts and add A-Records to your host's DNS.)
    57117
    58118== Trac with PostgreSQL ==