Changes between Version 2 and Version 3 of TracInstall


Ignore:
Timestamp:
04/08/13 16:20:19 (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v2 v3  
    1 = Trac Installation Guide for 0.12 =  
     1= Trac Installation Guide for 1.0 =  
    22[[TracGuideToc]] 
    33 
    44Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system. 
    55 
    6 Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able to use the Trac interface in other languages, then make sure you **first** have installed the optional package [#OtherPythonPackages Babel]. Lacking Babel, you will only get the default english version, as usual. If you install Babel later on, you will need to re-install Trac. 
    7  
    8 If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [trac:wiki:TracL10N TracL10N]. 
    9  
    10 What follows are generic instructions for installing and setting up Trac and its requirements. While you may find instructions for installing Trac on specific systems at TracInstallPlatforms on the main Trac site, please be sure to '''first read through these general instructions''' to get a good understanding of the tasks involved. 
     6Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able to use the Trac interface in other languages, then make sure you have installed the optional package [#OtherPythonPackages Babel]. Pay attention to the extra steps for localization support in the [#InstallingTrac Installing Trac] section below. Lacking Babel, you will only get the default english version, as usual. 
     7 
     8If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac:TracL10N]]. 
     9 
     10What follows are generic instructions for installing and setting up Trac and its requirements. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms] on the main Trac site, please be sure to '''first read through these general instructions''' to get a good understanding of the tasks involved. 
    1111 
    1212[[PageOutline(2-3,Installation Steps,inline)]] 
     
    1616To install Trac, the following software packages must be installed: 
    1717 
    18  * [http://www.python.org/ Python], version >= 2.4 and < 3.0 
    19    (note that we dropped the support for Python 2.3 in this release) 
    20  * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 
    21  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 
     18 * [http://www.python.org/ Python], version >= 2.5 and < 3.0 
     19   (note that we dropped the support for Python 2.4 in this release) 
     20 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6, or better yet, [http://pypi.python.org/pypi/distribute distribute] 
     21 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 (unreleased version 0.7dev should work as well) 
    2222 
    2323You also need a database system and the corresponding python bindings. 
     
    2626==== For the SQLite database #ForSQLite 
    2727 
    28 If you're using Python 2.5 or 2.6, you already have everything you need. 
    29  
    30 If you're using Python 2.4 and need pysqlite, you can download from  
    31 [http://code.google.com/p/pysqlite/downloads/list google code] the Windows installers or the tar.gz archive for building from source:  
     28As you must be using Python 2.5, 2.6 or 2.7, you already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module). 
     29 
     30However, if you'd like, you can download the latest and greatest version of [[trac:Pysqlite]] from  
     31[http://code.google.com/p/pysqlite/downloads/list google code], where you'll find the Windows 
     32installers or the `tar.gz` archive for building from source:  
    3233{{{ 
    3334$ tar xvfz <version>.tar.gz  
     
    3637}}} 
    3738  
    38 This will extract the SQLite code and build the bindings.  
    39  
    40 To install SQLite, your system may require the development headers. Without these you will get various GCC related errors when attempting to build: 
    41  
    42 {{{ 
    43 $ apt-get install libsqlite3-dev 
    44 }}} 
    45  
    46 SQLite 2.x is no longer supported, and neither is !PySqlite 1.1.x. 
    47  
    48 A known bug !PySqlite versions 2.5.2-4 prohibits upgrade of trac databases 
     39This will download the latest SQLite code and build the bindings.  
     40 
     41SQLite 2.x is no longer supported. 
     42 
     43A known bug PySqlite versions 2.5.2-4 prohibits upgrade of trac databases 
    4944from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and 
    50 older. See [trac:#9434] for more detail. 
    51  
    52 See additional information in [trac:PySqlite]. 
     45older. See #9434 for more detail. 
     46 
     47See additional information in [trac:PySqlite PySqlite]. 
    5348 
    5449==== For the PostgreSQL database #ForPostgreSQL 
     
    7570 
    7671===== Subversion ===== 
    77  * [http://subversion.apache.org/ Subversion], 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings. Older versions starting from 1.4.0, etc. should still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page. Versions prior to 1.4.0 won't probably work since trac uses svn core functionality (e.g. svn_path_canonicalize) that is not implemented in the python swig wrapper in svn <= 1.3.x (although it exists in the svn lib itself). 
     72 * [http://subversion.apache.org/ Subversion], 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings. Older versions starting from 1.0, like 1.2.4, 1.3.2 or 1.4.2, etc. should still work. For troubleshooting information, check the [trac:TracSubversion#Troubleshooting TracSubversion] page. 
    7873 
    7974There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. (Good luck finding precompiled SWIG bindings for any Windows package at that listing. TracSubversion points you to [http://alagazam.net Algazam], which works for me under Python 2.6.) 
    8075 
    81 Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings. [Is there a ticket for implementing ctype bindings?] 
     76Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.  
    8277 
    8378 
     
    8782===== Others ===== 
    8883 
    89 Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersioningSystemBackend]. 
     84Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem]. 
    9085 
    9186==== Web Server ==== 
     
    9994 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi) 
    10095 * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web 
    101    server (see [trac:TracOnWindowsIisAjp]) 
     96   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp]) 
    10297 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script  
    10398   is highly discouraged''', better use one of the previous options.  
     
    107102 
    108103 * [http://babel.edgewall.org Babel], version >= 0.9.5,  
    109    needed for localization support[[BR]] 
    110    ''Note: '' If you want to be able to use the Trac interface in other languages, then make sure you first have installed the optional package Babel. Lacking Babel, you will only get the default english version, as usual. If you install Babel later on, you will need to re-install Trac.  
     104   needed for localization support (unreleased version 1.0dev should work as well) 
    111105 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9  
    112106   for WikiRestructuredText. 
     
    132126A few examples: 
    133127 
    134  - first install of the latest stable version Trac 0.12.1, with i18n support: 
     128 - install Trac 1.0: 
    135129   {{{ 
    136    easy_install Babel==0.9.5 Genshi==0.6 
    137    easy_install Trac 
     130   easy_install Trac==1.0 
    138131   }}} 
    139    ''It's very important to run the two `easy_install` commands separately, otherwise the message catalogs won't be generated.'' 
    140  
    141  - upgrade to the latest stable version of Trac: 
     132   (NOT YET ENABLED) 
     133 - install latest development version 1.0dev: 
    142134   {{{ 
    143    easy_install -U Trac 
     135   easy_install Trac==dev 
    144136   }}} 
    145  
    146  - upgrade to the latest trunk development version (0.13dev): 
    147    {{{ 
    148    easy_install -U Trac==dev 
    149    }}} 
    150  
    151 For upgrades, reading the TracUpgrade page is mandatory, of course. 
    152  
    153 === From source 
    154 If you want more control, you can download the source in archive form, or do a checkout from one of the official [[Trac:TracRepositories|source code repositories]]. 
    155  
    156 Be sure to have the prerequisites already installed. You can also obtain the Genshi and Babel source packages from http://www.edgewall.org and follow for them a similar installation procedure, or you can just easy_install those, see [#Usingeasy_install above]. 
    157  
    158 Once you've unpacked the Trac archive or performed the checkout, move in the top-level folder and do: 
    159 {{{ 
    160 $ python ./setup.py install 
    161 }}} 
    162  
    163 ''You'll need root permissions or equivalent for this step.'' 
    164  
    165 This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory 
    166 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates. 
    167  
    168 The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments], as well as the [wiki:TracStandalone tracd] standalone server. 
    169  
    170 If you install from source and want to make Trac available in other languages, make sure  Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed): 
    171 {{{ 
    172 $ python ./setup.py install 
    173 }}} 
    174 Alternatively, you can do a `bdist_egg` and copy the .egg from dist/ to the place of your choice, or you can create a Windows installer (`bdist_wininst`). 
    175  
    176 === Advanced Options === 
    177  
    178 To install Trac to a custom location, or find out about other advanced installation options, run: 
    179 {{{ 
    180 easy_install --help 
    181 }}} 
    182  
    183 Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information. 
    184  
    185 Specifically, you might be interested in: 
    186 {{{ 
    187 easy_install --prefix=/path/to/installdir 
    188 }}} 
    189 or, if installing Trac to a Mac OS X system: 
    190 {{{ 
    191 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 
    192 }}} 
    193 Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default 
    194  
    195 The above will place your `tracd` and `trac-admin` commands into `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.5/site-packages`, which is Apple's preferred location for third-party Python application installations. 
     137   Note that in this case you won't have the possibility to run a localized version of Trac; 
     138   either use a released version or install from source  
    196139 
    197140=== Using `pip` 
     
    199142To get a trac installation up and running in less than 5 minutes: 
    200143 
    201 Assuming you want to have your entire pip installation in /opt/user/trac: 
     144Assuming you want to have your entire pip installation in `/opt/user/trac` 
    202145 
    203146 -  
     
    213156Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings. 
    214157 
    215 pip will automatically resolve all dependencies (like Genshi, pygments, etc.) and download the latest packages on pypi.python.org and create a self contained installation in /opt/user/trac . 
    216  
    217 All commands (tracd, trac-admin) are available in /opt/user/trac/bin. This can also be leveraged for mod_python (using !PythonHandler directive) and mod_wsgi (using WSGIDaemonProcess directive) 
     158pip will automatically resolve all dependencies (like Genshi, pygments, etc.) and download the latest packages on pypi.python.org and create a self contained installation in `/opt/user/trac`. 
     159 
     160All commands (`tracd`, `trac-admin`) are available in `/opt/user/trac/bin`. This can also be leveraged for `mod_python` (using `PythonHandler` directive) and `mod_wsgi` (using `WSGIDaemonProcess` directive) 
    218161 
    219162Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip. 
    220163 
     164 
     165 
     166=== From source 
     167Of course, using the python-typical setup at the top of the source directory also works. 
     168 
     169You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-1.0.tar.gz), or you can get the source directly from the repository (see Trac:SubversionRepository for details). 
     170 
     171{{{ 
     172$ python ./setup.py install 
     173}}} 
     174 
     175''You'll need root permissions or equivalent for this step.'' 
     176 
     177This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory 
     178of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates. 
     179 
     180The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments], as well as the [wiki:TracStandalone tracd] standalone server. 
     181 
     182If you install from source and want to make Trac available in other languages, make sure  Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed): 
     183{{{ 
     184$ python ./setup.py install 
     185}}} 
     186Alternatively, you can do a `bdist_egg` and copy the .egg from dist/ to the place of your choice, or you can create a Windows installer (`bdist_wininst`). 
     187 
     188=== Advanced Options === 
     189 
     190To install Trac to a custom location, or find out about other advanced installation options, run: 
     191{{{ 
     192easy_install --help 
     193}}} 
     194 
     195Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information. 
     196 
     197Specifically, you might be interested in: 
     198{{{ 
     199easy_install --prefix=/path/to/installdir 
     200}}} 
     201or, if installing Trac to a Mac OS X system: 
     202{{{ 
     203easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 
     204}}} 
     205Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default 
     206 
     207The above will place your `tracd` and `trac-admin` commands into `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.5/site-packages`, which is Apple's preferred location for third-party Python application installations. 
    221208 
    222209 
     
    249236 
    250237 
    251 == Running the Standalone Server == 
     238== Deploying Trac 
     239 
     240=== Running the Standalone Server === 
    252241 
    253242After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]: 
     
    261250}}} 
    262251 
    263 == Running Trac on a Web Server == 
    264  
    265 Trac provides various options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI], [wiki:TracModWSGI mod_wsgi] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_wsgi. 
    266  
    267 Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. 
    268  
    269 ==== Generating the Trac cgi-bin directory ==== 
     252=== Running Trac on a Web Server === 
     253 
     254Trac provides various options for connecting to a "real" web server:  
     255 - [wiki:TracFastCgi FastCGI] 
     256 - [wiki:TracModWSGI mod_wsgi]  
     257 - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)// 
     258 - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)// 
     259 
     260Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. Other deployment scenarios are possible: [trac:TracNginxRecipe nginx], [http://projects.unbit.it/uwsgi/wiki/Example#Traconapacheinasub-uri uwsgi], [trac:TracOnWindowsIisIsapi Isapi-wsgi] etc. 
     261 
     262==== Generating the Trac cgi-bin directory ==== #cgi-bin 
    270263 
    271264In order for Trac to function properly with FastCGI you need to have a `trac.fcgi` file and for mod_wsgi a `trac.wsgi` file. These are Python scripts which load the appropriate Python code. They can be generated using the `deploy` option of [wiki:TracAdmin trac-admin]. 
     
    279272}}} 
    280273 
     274 
     275==== Mapping Static Resources ==== 
     276 
     277Out of the box, Trac will pass static resources such as style sheets or images through itself. For anything but a tracd only based deployment, this is far from optimal as the web server could be set up to directly serve those static resources (for CGI setup, this is '''highly undesirable''' and will cause abysmal performance). 
     278 
     279Web servers such as [http://httpd.apache.org/ Apache] allow you to create “Aliases” to resources, giving them a virtual URL that doesn't necessarily reflect the layout of the servers file system. We also can map requests for static resources directly to the directory on the file system, avoiding processing these requests by Trac itself. 
     280 
     281There are two primary URL paths for static resources - `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible by `/chrome/<plugin>` path, so its important to override only known paths and not try to make universal `/chrome` alias for everything. 
     282 
     283Note that in order to get those static resources on the filesystem, you need first to extract the relevant resources from Trac using the [TracAdmin trac-admin]` <environment> deploy` command: 
     284[[TracAdminHelp(deploy)]] 
     285 
     286The target `<directory>` will then contain an `htdocs` directory with: 
     287 - `site/` - a copy of the environment's directory `htdocs/`  
     288 - `common/` - the static resources of Trac itself 
     289 - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment 
     290 
     291===== Example: Apache and `ScriptAlias` ===== #ScriptAlias-example 
     292 
     293Assuming the deployment has been done this way: 
     294{{{ 
     295$ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common 
     296}}} 
     297 
     298Add the following snippet to Apache configuration ''before'' the `ScriptAlias` or `WSGIScriptAlias` (which map all the other requests to the Trac application), changing paths to match your deployment: 
     299{{{ 
     300Alias /trac/chrome/common /path/to/trac/htdocs/common 
     301Alias /trac/chrome/site /path/to/trac/htdocs/site 
     302 
     303<Directory "/path/to/www/trac/htdocs"> 
     304  Order allow,deny 
     305  Allow from all 
     306</Directory> 
     307}}} 
     308 
     309If using mod_python, you might want to add this too (otherwise, the alias will be ignored): 
     310{{{ 
     311<Location "/trac/chrome/common/"> 
     312  SetHandler None 
     313</Location> 
     314}}} 
     315 
     316Note that we mapped `/trac` part of the URL to the `trac.*cgi` script, and the path `/trac/chrome/common` is the path you have to append to that location to intercept requests to the static resources.  
     317 
     318Similarly, if you have static resources in a project's `htdocs` directory (which is referenced by `/trac/chrome/site` URL in themes), you can configure Apache to serve those resources (again, put this ''before'' the `ScriptAlias` or `WSGIScriptAlias` for the .*cgi scripts, and adjust names and locations to match your installation): 
     319{{{ 
     320Alias /trac/chrome/site /path/to/projectenv/htdocs 
     321 
     322<Directory "/path/to/projectenv/htdocs"> 
     323  Order allow,deny 
     324  Allow from all 
     325</Directory> 
     326}}} 
     327 
     328Alternatively to aliasing `/trac/chrome/common`, you can tell Trac to generate direct links for those static resources (and only those), using the [[wiki:TracIni#trac-section| [trac] htdocs_location]] configuration setting: 
     329{{{ 
     330[trac] 
     331htdocs_location = http://static.example.org/trac-common/ 
     332}}} 
     333Note that this makes it easy to have a dedicated domain serve those static resources (preferentially [http://code.google.com/speed/page-speed/docs/request.html#ServeFromCookielessDomain cookie-less]). 
     334 
     335Of course, you still need to make the Trac `htdocs/common` directory available through the web server at the specified URL, for example by copying (or linking) the directory into the document root of the web server: 
     336{{{ 
     337$ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common 
     338}}} 
     339 
     340 
    281341==== Setting up the Plugin Cache ==== 
    282342 
     
    285345== Configuring Authentication == 
    286346 
    287 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. The basic procedure is described in the [wiki:TracCgi#AddingAuthentication "Adding Authentication"] section on the TracCgi page. To learn how to setup authentication for the frontend you're using, please refer to one of the following pages: 
    288  
    289  * TracStandalone if you use the standalone server, `tracd`. 
    290  * TracCgi if you use the CGI or FastCGI web front ends. 
    291  * [wiki:TracModWSGI] if you use the Apache mod_wsgi web front end. 
    292  * TracModPython if you use the Apache mod_python web front end. 
    293  
    294  
    295 == Automatic reference to the SVN changesets in Trac tickets == 
     347Trac uses HTTP authentication. You'll need to configure your webserver to request authentication when the `.../login` URL is hit (the virtual path of the "login" button). Trac will automatically pick the REMOTE_USER variable up after you provide your credentials. Therefore, all user management goes through your web server configuration. Please consult the documentation of your web server for more info. 
     348 
     349The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.  
     350 
     351Please refer to one of the following sections: 
     352 * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`. 
     353 * [wiki:TracModWSGI#ConfiguringAuthentication TracModWSGI#ConfiguringAuthentication] if you use the Apache web server, with any of its front end: `mod_wsgi` of course, but the same instructions applies also for `mod_python`, `mod_fcgi` or `mod_fastcgi`. 
     354 * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx) 
     355 
     356== Granting admin rights to the admin user 
     357Grant admin rights to user admin: 
     358{{{ 
     359$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN 
     360}}} 
     361This user will have an "Admin" entry menu that will allow you to admin your trac project. 
     362 
     363== Finishing the install 
     364 
     365=== Automatic reference to the SVN changesets in Trac tickets === 
    296366 
    297367You can configure SVN to automatically add a reference to the changeset into the ticket comments, whenever changes are committed to the repository. The description of the commit needs to contain one of the following formulas: 
     
    305375For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel. 
    306376 
    307 == Using Trac == 
     377=== Using Trac === 
    308378 
    309379Once you have your Trac site up and running, you should be able to create tickets, view the timeline, browse your version control repository if configured, etc. 
    310380 
    311 Keep in mind that anonymous (not logged in) users can by default access most but not all of the features. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features. 
     381Keep in mind that //anonymous// (not logged in) users can by default access only a few of the features, in particular they will have a read-only access to the resources. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features. 
    312382 
    313383'' Enjoy! '' 
     
    316386 
    317387---- 
    318 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions 
     388See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions