Changes between Version 1 and Version 2 of TracInstall


Ignore:
Timestamp:
Jul 17, 2008 10:45:00 AM (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v1 v2  
    1 = Trac Installation Guide for 0.12 =  
     1= Trac Installation Guide for 0.11 =  
    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. 
     6What follows are generic instructions for installing and setting up Trac and its requirements. While you can 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. 
    77 
    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]. 
     8== Short - Install a released version == 
     9For the quick install, make sure you have [http://python.org Python-2.5], [http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install easy_install] and SQlite-3.3.4 installed (or above). 
     10{{{ 
     11sudo easy_install Trac==0.11 
     12}}} 
    913 
    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 [trac:wiki: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. 
     14== Requirements - also older versions possible == 
    1115 
    12 [[PageOutline(2-3,Installation Steps,inline)]] 
    13  
    14 == Dependencies == 
    15 === Mandatory Dependencies 
    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 and that this will be the last Trac release supporting Python 2.4)// 
     18 * [http://www.python.org/ Python], version >= 2.3 
     19   * if using mod_python together with xml-related things, use python-2.5. expat is namespaced there and does not cause apache to crash any more(see [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash here] for details). 
     20   * For RPM-based systems you might also need the `python-devel` and `python-xml` packages. 
     21   * See instructions in ["TracOnWindows/Python2.5"] 
    2022 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6 
    21  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6 (but < 0.7dev, i.e. don't use Genshi trunk) 
     23 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.4.1 
     24 * You also need a database system and the corresponding python drivers for it. 
     25   The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''. 
     26 * optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver] 
    2227 
    23 You also need a database system and the corresponding python bindings. 
    24 The database can be either SQLite, PostgreSQL or MySQL. 
     28=== For SQLite === 
    2529 
    26 ==== For the SQLite database #ForSQLite 
     30 * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred. 
     31 * If not using Python-2.5: [http://pysqlite.org/ PySQLite], version 1.x (for SQLite 2.x) or version 2.x (for SQLite 3.x), version 2.3.2 preferred. For details see PySqlite 
    2732 
    28 If you're using Python 2.5 or 2.6, you already have everything you need. 
     33''Note: It appears that PySQLite 2.x is required for Trac 0.9+/SQLite 3.x if you plan to use the 'trac-post-commit-hook.py' script available from the 'contrib' section of the source repository.'' 
    2934 
    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:  
    32 {{{ 
    33 $ tar xvfz <version>.tar.gz  
    34 $ cd <version>  
    35 $ python setup.py build_static install  
    36 }}} 
    37   
    38 This will extract the SQLite code and build the bindings.  
     35''Note: Users of Mac OS X please take care; the Apple-supplied SQLite contains additional code to support file locking on network filesystems like AFP or SMB. This is not presently (3.3.6) in the mainline sources, so if you build your own SQLite from source it will not function correctly on such filesystems - typically it gives the error "{{{database is locked}}}". [http://www.alastairs-place.net/2006/07/sqlite_and_mac/ A patch] is available for version 3.3.6, based on Apple's code, otherwise you're probably best off using the Apple supplied version (presently 3.1.3).'' 
    3936 
    40 To install SQLite, your system may require the development headers. Without these you will get various GCC related errors when attempting to build: 
     37=== For PostgreSQL === 
    4138 
    42 {{{ 
    43 $ apt-get install libsqlite3-dev 
    44 }}} 
     39 * [http://www.postgresql.org/ PostgreSQL] 
     40 * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL] 
    4541 
    46 SQLite 2.x is no longer supported, and neither is !PySqlite 1.1.x. 
     42'''Warning''': PostgreSQL 8.3 uses a strict type checking mechanism. To use Trac with the 8.3 Version of PostgreSQL, you will need [http://trac.edgewall.org/changeset/6512 trac-0.11] or later. 
    4743 
    48 A known bug !PySqlite versions 2.5.2-4 prohibits upgrade of trac databases 
    49 from 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. 
     44=== For MySQL === 
    5145 
    52 See additional information in [trac:PySqlite]. 
     46'''Warning''': MySQL support is currently ''still'' experimental. That means it works for some people, but several issues remain, in particular regarding the use of unicode and the key length in the repository cache. See MySqlDb for more detailed information. 
    5347 
    54 ==== For the PostgreSQL database #ForPostgreSQL 
     48 * [http://mysql.com/ MySQL], version 4.1 or later 
     49 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later 
    5550 
    56 You need to install the database and its Python bindings: 
    57  * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later 
    58  * [http://pypi.python.org/pypi/psycopg2 psycopg2] 
    59  
    60 See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details. 
    61  
    62  
    63 ==== For the MySQL database #ForMySQL 
    64  
    65 Trac can now work quite well with MySQL, provided you follow the guidelines. 
    66  
    67  * [http://mysql.com/ MySQL], version 5.0 or later 
    68  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later 
    69  
    70 It is '''very''' important to read carefully the  [trac:MySqlDb] page before creating the database. 
    71  
    72 === Optional Dependencies 
     51=== Optional Requirements === 
    7352 
    7453==== Version Control System ==== 
    7554 
    76 ===== Subversion ===== 
     55'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported. 
    7756 
    78 [http://subversion.apache.org/ Subversion] 1.5.x or 1.6.x and the '''''corresponding''''' Python bindings.  
    79  
    80 There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. See also the TracSubversion page for details about Windows packages. 
    81  
    82 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). 
    83  
    84 Note that Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], neither does it work yet with the newer `ctype`-style bindings.  
    85  
    86 '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently [trac:#493 not supported]. 
    87  
    88  
    89 ===== Others ===== 
    90  
    91 Support for other version control systems is provided via third-parties. See [trac:PluginList] and [trac:VersionControlSystem]. 
     57 * [http://subversion.tigris.org/ Subversion], version >= 1.0. (versions recommended: 1.2.4, 1.3.2 or 1.4.2) and the '''''corresponding''''' Python bindings. For troubleshooting, check TracSubversion 
     58   * Trac uses the [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 SWIG] bindings included in the Subversion distribution, '''not''' [http://pysvn.tigris.org/ PySVN] (which is sometimes confused with the standard SWIG bindings). 
     59   * If Subversion was already installed without the SWIG bindings, on Unix you'll need to re-`configure` Subversion and `make swig-py`, `make install-swig-py`. 
     60   * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32.  
     61 * Support for other version control systems is provided via third-parties. See PluginList and VersioningSystemBackend. 
    9262 
    9363==== Web Server ==== 
    94 A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server ] section below. 
     64 * A CGI-capable web server (see TracCgi), or 
     65 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or 
     66 * [http://httpd.apache.org/ Apache] with [http://code.google.com/p/modwsgi/ mod_wsgi] (see [wiki:TracModWSGI]) 
     67    * This should work with Apache 1.3, 2.0 or 2.2 and promises to deliver more performance than using mod_python. A little less mature than mod_python. 
     68 * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython) 
     69    * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files) 
    9570 
    96 Alternatively you configure Trac to run in any of the following environments. 
    97  * [http://httpd.apache.org/ Apache] with  
    98    - [http://code.google.com/p/modwsgi/ mod_wsgi], see [wiki:TracModWSGI] (preferred) 
    99    - //[http://modpython.org/ mod_python 3.3.1], see TracModPython (deprecated)// 
    100  * any [http://www.fastcgi.com/ FastCGI]-capable web server, see TracFastCgi 
    101  * any [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web 
    102    server, see [trac:TracOnWindowsIisAjp] 
    103  * IIS with [http://code.google.com/p/isapi-wsgi/ Isapi-wsgi], see [trac:TracOnWindowsIisIsapi] 
    104  * //as a last resort, a CGI-capable web server (see TracCgi), but usage of Trac as a cgi script  
    105    is highly discouraged, better use one of the previous options.// 
    106     
     71For those stuck with Apache 1.3, it is also possible to get Trac working with [http://www.modpython.org/ mod_python 2.7] (see [wiki:TracModPython2.7 TracModPython2.7]). This guide hasn't been updated since 0.84, so it may or may not work. 
    10772 
    108 ==== Other Python Packages ==== 
     73==== Other Python Utilities ==== 
     74 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText. 
     75 * [http://pygments.pocoo.org Pygments] for [wiki:TracSyntaxColoring syntax highlighting], also [http://silvercity.sourceforge.net/ SilverCity] and/or [http://gnu.org/software/enscript/enscript.html Enscript] may still be used. 
     76    * Note that !SilverCity 0.9.6 has a [http://sourceforge.net/tracker/index.php?func=detail&aid=1424436&group_id=45693&atid=443739 bug] that breaks Python syntax highlighting in Trac. Until an update is made available, we recommend using version 0.9.5. 
     77 * [http://pytz.sf.net pytz] to get a complete list of time zones, otherwise Trac will fall back on a shorter list from an internal time zone implementation. 
    10978 
    110  * [http://babel.edgewall.org Babel], version 0.9.5,  
    111    needed for localization support[[BR]] 
    112    ''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.  
    113  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9  
    114    for WikiRestructuredText. 
    115  * [http://pygments.pocoo.org Pygments] for  
    116    [wiki:TracSyntaxColoring syntax highlighting]. 
    117    [http://silvercity.sourceforge.net/ SilverCity] and/or  
    118    [http://gnu.org/software/enscript/enscript.html Enscript] may still be used 
    119    but are deprecated and you really should be using Pygments. 
    120  * [http://pytz.sf.net pytz] to get a complete list of time zones, 
    121    otherwise Trac will fall back on a shorter list from  
    122    an internal time zone implementation. 
     79'''Attention''': The various available versions of these dependencies are not necessarily interchangable, so please pay attention to the version numbers above. If you are having trouble getting Trac to work please double-check all the dependencies before asking for help on the MailingList or IrcChannel. 
    12380 
    124 '''Attention''': The various available versions of these dependencies are not necessarily interchangable, so please pay attention to the version numbers above. If you are having trouble getting Trac to work please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel]. 
    125  
    126 Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [trac:TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there ''probably concern older versions of Trac than the one you're installing'' (there are even some pages that are still talking about Trac 0.8!). 
    127  
     81Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [wiki:TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there ''probably concern older versions of Trac than the one you're installing'' (there are even some pages that are still talking about Trac 0.8!). 
    12882 
    12983== Installing Trac == 
    130 === Using `easy_install` 
    131 One way to install Trac is using [http://pypi.python.org/pypi/setuptools setuptools]. 
    132 With setuptools you can install Trac from the subversion repository;  
    13384 
    134 A few examples: 
     85One way to install Trac is using `setuptools`. 
     86With setuptools you can install Trac from the subversion repository; for example, 
     87to install release version 0.11b2 do: 
     88{{{ 
     89easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11b2 
     90}}} 
    13591 
    136  - first install of the latest stable version Trac 0.12.3, with i18n support: 
    137    {{{ 
    138    easy_install Babel==0.9.5 
    139    easy_install Trac==0.12 
    140    }}} 
    141    ''It's very important to run the two `easy_install` commands separately, otherwise the message catalogs won't be generated.'' 
    142  
    143  - upgrade to the latest stable version of Trac: 
    144    {{{ 
    145    easy_install -U Trac 
    146    }}} 
    147  
    148  - upgrade to the latest trunk development version: 
    149    {{{ 
    150    easy_install -U Trac==dev 
    151    }}} 
    152  
    153 For upgrades, reading the TracUpgrade page is mandatory, of course. 
    154  
    155 === From source 
    156 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]]. 
    157  
    158 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]. 
    159  
    160 Once you've unpacked the Trac archive or performed the checkout, move in the top-level folder and do: 
     92But of course the python-typical setup at the top of the source directory also works: 
    16193{{{ 
    16294$ python ./setup.py install 
    16395}}} 
    16496 
    165 You'll need root permissions or equivalent for this step. 
     97''Note: you'll need root permissions or equivalent for this step.'' 
    16698 
    16799This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory 
     
    170102The 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. 
    171103 
    172 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): 
    173 {{{ 
    174 $ python ./setup.py install 
    175 }}} 
    176 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`). 
    177  
    178104=== Advanced Options === 
    179  
    180 ==== Custom location with `easy_install` 
    181105 
    182106To install Trac to a custom location, or find out about other advanced installation options, run: 
     
    195119easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages 
    196120}}} 
    197 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 
    198121 
    199122The 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. 
    200123 
    201 ==== Using `pip` 
    202 'pip' is an easy_install replacement that is very useful to quickly install python packages. 
    203 To get a trac installation up and running in less than 5 minutes: 
    204  
    205 Assuming you want to have your entire pip installation in /opt/user/trac: 
    206  
    207  -  
    208 {{{ 
    209 pip -E /opt/user/trac install trac psycopg2  
    210 }}} 
    211 or 
    212  -  
    213 {{{ 
    214 pip -E /opt/user/trac install trac mysql-python  
    215 }}} 
    216  
    217 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings. 
    218  
    219 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 . 
    220  
    221 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) 
    222  
    223 Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip. 
    224  
    225  
    226  
    227124== Creating a Project Environment == 
    228125 
    229 A [TracEnvironment Trac environment] is the backend storage where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable [TracIni configuration file], and various other files and directories. 
     126A [wiki:TracEnvironment Trac environment] is the backend storage where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable configuration file and various other files and directories. 
    230127 
    231128A new environment is created using [wiki:TracAdmin trac-admin]: 
     
    234131}}} 
    235132 
    236 [TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for one of these options, just press `<Enter>` to use the default value.  
     133[wiki:TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project, the type and the path to an existing [wiki:TracEnvironment#SourceCodeRepository source code repository], the [wiki:TracEnvironment#DatabaseConnectionStrings database connection string], and so on. If you're not sure what to specify for one of these options, just leave it blank to use the default value. The database connection string in particular will always work as long as you have SQLite installed. Leaving the path to the source code repository empty will disable any functionality related to version control, but you can always add that back when the basic system is running. 
    237134 
    238 Using the default database connection string in particular will always work as long as you have SQLite installed. 
    239 For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point. 
     135Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file. 
    240136 
    241 Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterward, or the version control support can be disabled completely if you don't need it. 
     137''Note: The user account under which the web server runs will require write permissions to the environment directory and all the files inside.  On Linux, with the web server running as user apache and group apache, enter:'' 
    242138 
    243 Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file. 
    244  
    245 Finally, make sure the user account under which the web front-end runs will have '''write permissions''' to the environment directory and all the files inside. This will be the case if you run `trac-admin ... initenv` as this user. If not, you should set the correct user afterwards. For example on Linux, with the web server running as user `apache` and group `apache`, enter: 
    246 {{{ 
    247 # chown -R apache.apache /path/to/myproject 
    248 }}} 
    249  
    250 {{{#!div class=important 
    251 '''Warning:''' Please only use ASCII-characters for account name and project path, unicode characters are not supported there. 
    252 }}} 
     139  chown -R apache.apache /path/to/myproject 
    253140 
    254141 
    255 == Deploying Trac 
    256  
    257 === Running the Standalone Server === 
     142== Running the Standalone Server == 
    258143 
    259144After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]: 
     
    262147}}} 
    263148 
    264 Then, fire up a browser and visit `http://localhost:8000/`. You should get a simple listing of all environments that `tracd` knows about. Follow the link to the environment you just created, and you should see Trac in action. If you only plan on managing a single project with Trac you can have the standalone server skip the environment list by starting it like this: 
     149Then, fire up a browser and visit `http://localhost:8000/`. You should get a simple listing of all environments that tracd knows about. Follow the link to the environment you just created, and you should see Trac in action. If you only plan on managing a single project with trac you can have the standalone server skip the environment list by starting it like this: 
    265150{{{ 
    266151$ tracd -s --port 8000 /path/to/myproject 
    267152}}} 
    268153 
    269 === Running Trac on a Web Server === 
    270154 
    271 Trac provides various options for connecting to a "real" web server:  
    272  - [wiki:TracFastCgi FastCGI] 
    273  - [wiki:TracModWSGI mod_wsgi]  
    274  - //[wiki:TracModPython mod_python] (no longer recommended, as mod_python is not actively maintained anymore)// 
    275  - //[wiki:TracCgi CGI] (should not be used, as the performance is far from optimal)// 
     155== Running Trac on a Web Server == 
    276156 
    277 Trac 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. 
     157Trac provides three options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_python. 
    278158 
    279 ==== Generating the Trac cgi-bin directory ==== #cgi-bin 
    280  
    281 In 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]. 
    282  
    283 There is, however, a bit of a chicken-and-egg problem. The [wiki:TracAdmin trac-admin] command requires an existing environment to function, but complains if the deploy directory already exists. This is a problem, because environments are often stored in a subdirectory of the deploy. The solution is to do something like this: 
    284 {{{ 
    285 mkdir -p /usr/share/trac/projects/my-project 
    286 trac-admin /usr/share/trac/projects/my-project initenv 
    287 trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy 
    288 mv /tmp/deploy/* /usr/share/trac 
    289 }}} 
    290  
    291  
    292 ==== Mapping Static Resources ==== 
    293  
    294 Out 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). 
    295  
    296 Web 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. 
    297  
    298 There 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. 
    299  
    300 Note 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: 
    301 [[TracAdminHelp(deploy)]] 
    302  
    303 The target `<directory>` will then contain an `htdocs` directory with: 
    304  - `site/` - a copy of the environment's directory `htdocs/`  
    305  - `common/` - the static resources of Trac itself 
    306  - `<plugins>/` - one directory for each resource directory managed by the plugins enabled for this environment 
    307  
    308 ===== Example: Apache and `ScriptAlias` ===== #ScriptAlias-example 
    309  
    310 Assuming the deployment has been done this way: 
    311 {{{ 
    312 $ trac-admin /var/trac/env deploy /path/to/trac/htdocs/common 
    313 }}} 
    314  
    315 Add 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: 
    316 {{{ 
    317 Alias /trac/chrome/common /path/to/trac/htdocs/common 
    318 Alias /trac/chrome/site /path/to/trac/htdocs/site 
    319  
    320 <Directory "/path/to/www/trac/htdocs"> 
    321   Order allow,deny 
    322   Allow from all 
    323 </Directory> 
    324 }}} 
    325  
    326 If using mod_python, you might want to add this too (otherwise, the alias will be ignored): 
    327 {{{ 
    328 <Location "/trac/chrome/common/"> 
    329   SetHandler None 
    330 </Location> 
    331 }}} 
    332  
    333 Note 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.  
    334  
    335 Similarly, 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): 
    336 {{{ 
    337 Alias /trac/chrome/site /path/to/projectenv/htdocs 
    338  
    339 <Directory "/path/to/projectenv/htdocs"> 
    340   Order allow,deny 
    341   Allow from all 
    342 </Directory> 
    343 }}} 
    344  
    345 Alternatively 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: 
    346 {{{ 
    347 [trac] 
    348 htdocs_location = http://static.example.org/trac-common/ 
    349 }}} 
    350 Note 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]). 
    351  
    352 Of 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: 
    353 {{{ 
    354 $ ln -s /path/to/trac/htdocs/common /var/www/static.example.org/trac-common 
    355 }}} 
    356  
    357  
    358 ==== Setting up the Plugin Cache ==== 
    359  
    360 Some Python plugins need to be extracted to a cache directory. By default the cache resides in the home directory of the current user. When running Trac on a Web Server as a dedicated user (which is highly recommended) who has no home directory, this might prevent the plugins from starting. To override the cache location you can set the PYTHON_EGG_CACHE environment variable. Refer to your server documentation for detailed instructions on how to set environment variables. 
     159If you're not afraid of running development code, you can also try running Trac on [wiki:TracModWSGI mod_wsgi]. This should deliver even better performance than mod_python, but the module is not considered stable just yet. 
    361160 
    362161== Configuring Authentication == 
    363162 
    364 Trac 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. 
     163The 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: 
    365164 
    366 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.  
     165 * TracStandalone if you use the standalone server, `tracd`. 
     166 * TracCgi if you use the CGI or FastCGI methods. 
     167 * TracModPython if you use the mod_python method. 
    367168 
    368 Please refer to one of the following sections: 
    369  * TracStandalone#UsingAuthentication if you use the standalone server, `tracd`. 
    370  * [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`. 
    371  * TracFastCgi if you're using another web server with FCGI support (Cherokee, Lighttpd, !LiteSpeed, nginx) 
     169== Trac 0.11 & SVN on Mac OS X Leopard (10.5) == 
    372170 
    373 == Granting admin rights to the admin user 
    374 Grant admin rights to user admin: 
    375 {{{ 
    376 $ trac-admin /path/to/myproject permission add admin TRAC_ADMIN 
    377 }}} 
    378 This user will have an "Admin" entry menu that will allow you to admin your trac project. 
     171 * TracOnLeopardServer 
    379172 
    380 == Finishing the install 
     173== Using Trac == 
    381174 
    382 === Automatic reference to the SVN changesets in Trac tickets === 
     175Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc. 
    383176 
    384 You 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: 
    385  * '''`Refs #123`''' - to reference this changeset in `#123` ticket 
    386  * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed'' 
    387  
    388 This functionality requires a post-commit hook to be installed as described in [wiki:TracRepositoryAdmin#ExplicitSync TracRepositoryAdmin], and enabling the optional commit updater components by adding the following line to the `[components]` section of your [wiki:TracIni#components-section trac.ini], or enabling the components in the "Plugins" admin panel. 
    389 {{{ 
    390 tracopt.ticket.commit_updater.* = enabled 
    391 }}} 
    392 For more information, see the documentation of the `CommitTicketUpdater` component in the "Plugins" admin panel. 
    393  
    394 === Using Trac === 
    395  
    396 Once 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. 
    397  
    398 Keep 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. 
     177Keep 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. 
    399178 
    400179'' Enjoy! '' 
    401180 
    402 [trac:TracTeam The Trac Team] 
     181[wiki:TracTeam The Trac Team] 
    403182 
    404183---- 
    405 See also: [trac:TracInstallPlatforms TracInstallPlatforms], TracGuide, TracUpgrade, TracPermissions 
     184See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions 
     185