Changes between Version 2 and Version 3 of TracFastCgi


Ignore:
Timestamp:
May 20, 2020, 7:00:27 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracFastCgi

    v2 v3  
     1[[PageOutline]]
     2
    13= Trac with FastCGI =
    24
    3 [http://www.fastcgi.com/ FastCGI] interface allows Trac to remain resident much like with [wiki:TracModPython mod_python]. It is faster than external CGI interfaces which must start a new process for each request. However, unlike mod_python, FastCGI supports [http://httpd.apache.org/docs/suexec.html Apache SuEXEC], i.e. run with different permissions than web server. Additionally, it is supported by much wider variety of web servers.
    4 
    5 '''Note for Windows:''' Trac's FastCGI does not run under Windows, as Windows does not implement `Socket.fromfd`, which is used by `_fcgi.py`. If you want to connect to IIS, you may want to try [trac:TracOnWindowsIisAjp AJP].
     5[http://www.fastcgi.com/ FastCGI] interface allows Trac to remain resident much like with [wiki:TracModPython mod_python] or [wiki:TracModWSGI mod_wsgi]. It is faster than external CGI interfaces which must start a new process for each request.  Additionally, it is supported by much wider variety of web servers.
     6
     7Note that unlike mod_python, FastCGI supports [http://httpd.apache.org/docs/suexec.html Apache SuEXEC], i.e. run with different permissions than web server running with (`mod_wsgi` supports the `WSGIDaemonProcess` with user / group parameters to achieve the same effect).
     8
     9'''Note for Windows:''' Trac's FastCGI does not run under Windows, as Windows does not implement `Socket.fromfd`, which is used by `_fcgi.py`. If you want to connect to IIS, you may want to try [trac:TracOnWindowsIisAjp AJP]/[trac:TracOnWindowsIisAjp ISAPI].
     10
     11[[PageOutline(2-3,Overview,inline)]]
     12
    613
    714== Simple Apache configuration ==
    … …  
    1017`mod_fcgid` (preferred). The latter is more up-to-date.
    1118
    12 ==== setup with `mod_fastcgi` ====
     19The following sections focus on the FCGI specific setup, see also [wiki:TracModWSGI#ConfiguringAuthentication] for configuring the authentication in Apache.
     20
     21Regardless of which cgi module is used, be sure the web server has executable permissions on the cgi-bin folder. While FastCGI will throw specific permissions errors, mod_fcgid will throw an ambiguous error if this has not been done. (Connection reset by peer: mod_fcgid: error reading data from FastCGI server)
     22
     23=== Set up with `mod_fastcgi` ===
    1324`mod_fastcgi` uses `FastCgiIpcDir` and `FastCgiConfig` directives that should be added to an appropriate Apache configuration file:
    1425{{{
    … …  
    2738calling `trac.fcgi` instead of `trac.cgi`.
    2839
    29 You can set up the `TRAC_ENV` as an overall default:
     40Add the following to the Apache configuration file (below the `FastCgiIpcDir` line) if you intend to set up the `TRAC_ENV` as an overall default:
    3041{{{
    3142FastCgiConfig -initial-env TRAC_ENV=/path/to/env/trac
    3243}}}
    3344
    34 Or you can serve multiple Trac projects in a directory like:
     45Alternatively, you can serve multiple Trac projects in a directory by adding this:
    3546{{{
    3647FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects
    3748}}}
    3849
    39 ==== setup with `mod_fcgid` ====
     50=== Set up with `mod_fcgid` ===
    4051Configure `ScriptAlias` (see TracCgi for details), but call `trac.fcgi`
    4152instead of `trac.cgi`. Note that slash at the end - it is important.
    … …  
    4455}}}
    4556
    46 To setup Trac environment for `mod_fcgid` it is necessary to use
    47 `FCGIDDefaultInitEnv` directive. It cannot be used in `Directory` or
     57To set up Trac environment for `mod_fcgid` it is necessary to use
     58`DefaultInitEnv` directive. It cannot be used in `Directory` or
    4859`Location` context, so if you need to support multiple projects, try
    4960alternative environment setup below.
    5061
    5162{{{
    52 FCGIDDefaultInitEnv TRAC_ENV /path/to/env/trac/
    53 }}}
    54 
    55 ==== alternative environment setup ====
    56 A better method to specify path to Trac environment it to embed the path
     63DefaultInitEnv TRAC_ENV /path/to/env/trac/
     64}}}
     65
     66=== alternative environment setup ===
     67A better method to specify path to Trac environment is to embed the path
    5768into `trac.fcgi` script itself. That doesn't require configuration of server
    5869environment variables, works for both FastCgi modules
    … …  
    93104
    94105After doing this, we will just have to create a new rule managed by the SCGI handler to access Trac. It can be created in a new virtual server, trac.example.net for instance, and will only need two rules. The '''default''' one will use the SCGI handler associated to the previously created information source.
    95 The second rule will be there to serve the few static files needed to correctly display the Trac interface. Create it as ''Directory rule'' for ''/chrome/common'' and just set it to the ''Static files'' handler and with a ''Document root'' that points to the appropriate files: ''/usr/share/trac/htdocs/''
     106The second rule will be there to serve the few static files needed to correctly display the Trac interface. Create it as ''Directory rule'' for ''/common'' and just set it to the ''Static files'' handler and with a ''Document root'' that points to the appropriate files: ''$TRAC_LOCAL/htdocs/'' (where $TRAC_LOCAL is a directory defined by the user or the system administrator to place local trac resources).
     107
     108Note:\\
     109If the tracd process fails to start up, and cherokee displays a 503 error page, you might be missing the [http://trac.saddi.com/flup python-flup] package.\\
     110Python-flup is a dependency which provides trac with SCGI capability. You can install it on debian based systems with:
     111{{{
     112sudo apt-get install python-flup
     113}}}
     114
    96115
    97116== Simple Lighttpd Configuration ==
    … …  
    122141and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf`
    123142using `bin-environment` (as in the section above on Apache configuration).
     143
     144Note that lighttpd has a bug related to 'SCRIPT_NAME' and 'PATH_INFO' when the uri of fastcgi.server is '/' instead of '/trac' in this example (see [trac:#2418]). This should be fixed since lighttpd 1.4.23, and you may need to add `"fix-root-scriptname" => "enable"` as parameter of fastcgi.server.
    124145
    125146For using two projects with lighttpd add the following to your `lighttpd.conf`:
    … …  
    150171Note that the above will result in different processes in any event, even
    151172if both are running from the same `trac.fcgi` script.
     173
    152174{{{
    153175#!div class=important
    154176'''Note''' It's very important the order on which server.modules are loaded, if mod_auth is not loaded '''BEFORE''' mod_fastcgi, then the server will fail to authenticate the user.
    155177}}}
     178
    156179For authentication you should enable mod_auth in lighttpd.conf 'server.modules', select auth.backend and auth rules:
    157180{{{
    … …  
    201224server.modules += ("mod_alias")
    202225
    203 # Setup an alias for the static resources
     226# Set up an alias for the static resources
    204227alias.url = ("/trac/chrome/common" => "/usr/share/trac/htdocs")
    205228
    … …  
    267290For details about languages specification see [trac:TracFaq TracFaq] question 2.13.
    268291
    269 Other important information like [http://trac.lighttpd.net/trac/wiki/TracInstall this updated TracInstall page], [wiki:TracCgi#MappingStaticResources and this] are useful for non-fastcgi specific installation aspects.
    270 
    271 If you use trac-0.9, read [http://lists.edgewall.com/archive/trac/2005-November/005311.html about small bug]
     292Other important information like the [wiki:TracInstall#MappingStaticResources mapping static resources advices] are useful for non-fastcgi specific installation aspects.
     293]
    272294
    273295Relaunch lighttpd, and browse to `http://yourhost.example.org/trac` to access Trac.
    … …  
    275297Note about running lighttpd with reduced permissions:
    276298
    277   If nothing else helps and trac.fcgi doesn't start with lighttpd settings __server.username = "www-data"__, __server.groupname = "www-data"__, then in the `bin-environment` section set `PYTHON_EGG_CACHE` to the home directory of `www-data` or some other directory accessible to this account for writing.
     299If nothing else helps and trac.fcgi doesn't start with lighttpd settings `server.username = "www-data"`, `server.groupname = "www-data"`, then in the `bin-environment` section set `PYTHON_EGG_CACHE` to the home directory of `www-data` or some other directory accessible to this account for writing.
    278300
    279301
    … …  
    284306!LiteSpeed web server is an event-driven asynchronous Apache replacement designed from the ground-up to be secure, scalable, and operate with minimal resources. !LiteSpeed can operate directly from an Apache config file and is targeted for business-critical environments.
    285307
    286 Setup
    287 
    288 1) Please make sure you have first have a working install of a Trac project. Test install with “tracd” first.
    289 
    290 2) Create a Virtual Host for this setup. From now on we will refer to this vhost as TracVhost. For this tutorial we will be assuming that your trac project will be accessible via:
     308 1. Please make sure you have first have a working install of a Trac project. Test install with “tracd” first.
     309
     310 2. Create a Virtual Host for this setup. From now on we will refer to this vhost as !TracVhost. For this tutorial we will be assuming that your trac project will be accessible via:
    291311
    292312{{{
    … …  
    294314}}}
    295315
    296 3) Go “TracVhost → External Apps” tab and create a new “External Application”.
     316 3. Go “!TracVhost → External Apps” tab and create a new “External Application”.
    297317
    298318{{{
    … …  
    312332}}}
    313333
    314 4) Optional. If you need to use htpasswd based authentication. Go to “TracVhost → Security” tab and create a new security “Realm”.
     334 4. Optional. If you need to use htpasswd based authentication. Go to “!TracVhost → Security” tab and create a new security “Realm”.
    315335
    316336{{{
    … …  
    322342If you don’t have a htpasswd file or don’t know how to create the entries within one, go to http://sherylcanter.com/encrypt.php, to generate the user:password combos.
    323343
    324 5) Go to “PythonVhost → Contexts” and create a new “FCGI Context”.
     344 5. Go to “!PythonVhost → Contexts” and create a new “FCGI Context”.
    325345
    326346{{{
    … …  
    330350}}}
    331351
    332 6) Modify /fullpathto/mytracproject/conf/trac.ini
     352 6. Modify `/fullpathto/mytracproject/conf/trac.ini`
    333353
    334354{{{
    … …  
    339359}}}
    340360
    341 7) Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:
     361 7. Restart !LiteSpeed, “lswsctrl restart”, and access your new Trac project at:
    342362
    343363{{{
    … …  
    345365}}}
    346366
    347 === Simple Nginx Configuration ===
    348 
    349 1) Nginx configuration snippet - confirmed to work on 0.6.32
     367
     368== Simple Nginx Configuration ==
     369
     370Nginx is able to communicate with FastCGI processes, but can not spawn them. So you need to start FastCGI server for Trac separately.
     371
     372 1. Nginx configuration with basic authentication handled by Nginx - confirmed to work on 0.6.32
    350373{{{
    351374    server {
    … …  
    366389        if ($uri ~ ^/(.*)) {
    367390             set $path_info /$1;
     391        }
     392
     393        # it makes sense to serve static resources through Nginx
     394        location /chrome/ {
     395             alias /home/trac/instance/static/htdocs/;
    368396        }
    369397
    … …  
    394422            fastcgi_param  SERVER_PORT        $server_port;
    395423            fastcgi_param  SERVER_PROTOCOL    $server_protocol;
    396 
    397             # for authentication to work
     424            fastcgi_param  QUERY_STRING       $query_string;
     425
     426            # For Nginx authentication to work - do not forget to comment these
     427            # lines if not using Nginx for authentication
    398428            fastcgi_param  AUTH_USER          $remote_user;
    399429            fastcgi_param  REMOTE_USER        $remote_user;
     430
     431            # for ip to work
     432            fastcgi_param REMOTE_ADDR         $remote_addr;
     433
     434            # For attchments to work
     435            fastcgi_param    CONTENT_TYPE     $content_type;
     436            fastcgi_param    CONTENT_LENGTH   $content_length;
    400437        }
    401438    }
    402439}}}
    403440
    404 2) Modified trac.fcgi:
     441 2. Modified trac.fcgi:
    405442
    406443{{{
    … …  
    436473}}}
    437474
    438 3) reload nginx and launch trac.fcgi like that:
     475 3. reload nginx and launch trac.fcgi like that:
    439476
    440477{{{
    … …  
    444481The above assumes that:
    445482 * There is a user named 'trac' for running trac instances and keeping trac environments in its home directory.
    446  * /home/trac/instance contains a trac environment
    447  * /home/trac/htpasswd contains authentication information
    448  * /home/trac/run is owned by the same group the nginx runs under
    449   * and if your system is Linux the /home/trac/run has setgid bit set (chmod g+s run)
     483 * `/home/trac/instance` contains a trac environment
     484 * `/home/trac/htpasswd` contains authentication information
     485 * `/home/trac/run` is owned by the same group the nginx runs under
     486  * and if your system is Linux the `/home/trac/run` has setgid bit set (`chmod g+s run`)
    450487  * and patch from ticket #T7239 is applied, or you'll have to fix the socket file permissions every time
    451488