Changes between Version 1 and Version 2 of TracInstall


Ignore:
Timestamp:
Apr 9, 2008, 4:17:47 PM (17 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v1 v2  
    1 = Trac Installation Guide =
     1= Trac Installation Guide for 0.11 =
    22[[TracGuideToc]]
    33
    4 The Trac web-based project management tool is implemented as a CGI- or standalone program. Trac is written in the [http://www.python.org/ Python] programming language
    5 and uses the [http://www.sqlite.org/ SQLite] embedded database for persistant storage. For HTML rendering, Trac uses the [http://www.clearsilver.net/ Clearsilver] template system.
     4  '''NOTE: this page is now for 0.11, which will be released soon. For installing previous Trac versions, please refer to wiki:0.10/TracInstall.'''
    65
     6Trac 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.
    77
    8 == Requirements ==
     8What 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.
     9
     10== Short - Install a released version ==
     11For 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).
     12{{{
     13sudo easy_install Pygments
     14sudo easy_install Genshi
     15sudo easy_install Trac
     16}}}
     17
     18== Requirements - also older versions possible ==
    919
    1020To install Trac, the following software packages must be installed:
    1121
    12  * [http://www.python.org/ Python], version >= 2.1 (>=2.3 recommended).
    13    * Please keep in mind, that for RPM-based systems you will also need python-devel and python-xml packages.
    14  * [http://subversion.tigris.org/ Subversion], version >= 1.0. (>=1.1 recommended)
    15  * [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 Subversion Python bindings] (Caveat: Trac uses the [http://www.swig.org/ SWIG] bindings included in the Subversion distribution,  '''not''' the  [http://pysvn.tigris.org/ PySVN] package!)
    16  * [http://www.sqlite.org/ SQLite], version 2.8.x or 3.0.x
    17  * [http://pysqlite.sf.net/ PySQLite], version >= 0.5 but < 1.1.0 (for SQLite 2.8.x), version >= 1.1.1 (for SQLite 3.0.x)
    18  * [http://clearsilver.net/ Clearsilver], version >= 0.9.3
    19  * [http://docutils.sourceforge.net/ docutils], version >= 0.3.3 (??)
    20  * A CGI-capable web server (tested on [http://httpd.apache.org/ Apache] )
     22 * [http://www.python.org/ Python], version >= 2.3
     23   * 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).
     24   * For RPM-based systems you might also need the `python-devel` and `python-xml` packages.
     25   * See instructions in ["TracOnWindows/Python2.5"]
     26 * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
     27 * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.3.6
     28 * You also need a database system and the corresponding python drivers for it.
     29   The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''.
     30 * optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver]
    2131
    22 === Optional Packages ===
     32=== For SQLite ===
    2333
    24  * [http://www.modpython.org/ mod_python] (see TracModPython)
     34 * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred.
     35 * 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
     36
     37''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.''
     38
     39''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).''
     40
     41=== For PostgreSQL ===
     42
     43 * [http://www.postgresql.org/ PostgreSQL]
     44 * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL]
     45
     46=== For MySQL ===
     47
     48'''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 informations.
     49
     50 * [http://mysql.com/ MySQL], version 4.1 or later
     51 * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later
     52
     53=== Optional Requirements ===
     54
     55==== Version Control System ====
     56
     57'''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported.
     58
     59 * [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
     60   * 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).
     61   * 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`.
     62   * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32.
     63 * Support for other version control systems is provided via third-parties. See PluginList and VersioningSystemBackend.
     64
     65==== Web Server ====
     66 * A CGI-capable web server (see TracCgi), or
     67 * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or
     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)
     70 * [http://httpd.apache.org/ Apache] with [http://code.google.com/p/modwsgi/ mod_wsgi] (see [wiki:TracModWSGI])
     71    * While mod_wsgi is very new and somewhat experimental, this should work with Apache 1.3, 2.0 or 2.2 and promises to deliver more performance than using mod_python.
     72
     73For 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.
     74
     75==== Other Python Utilities ====
     76 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText.
     77 * [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.
     78    * 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.
     79 * [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.
     80
     81'''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.
     82
     83Please 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!).
    2584
    2685== Installing Trac ==
    27 Like most Python programs, install the Trac python modules by running the following command at the top of the source directory:
     86
     87One way to install Trac is using `setuptools`.
     88With setuptools you can install Trac from the subversion repository; for example,
     89to install release version 0.11 do:
     90{{{
     91easy_install http://svn.edgewall.com/repos/trac/tags/trac-0.11
     92}}}
     93
     94But of course the python-typical setup at the top of the source directory also works:
    2895{{{
    2996$ python ./setup.py install
    3097}}}
    3198
    32 This will byte-compile the python source code and install it in the {{{site-packages}}} directory
    33 of your python installation. The directories {{{cgi-bin}}}, {{{templates}}}, {{{htdocs}}} and {{{wiki-default}}} are all copied to $prefix/share/trac/ .
     99''Note: you'll need root permissions or equivalent for this step.''
    34100
    35 The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments].
     101This will byte-compile the python source code and install it in the `site-packages` directory
     102of your Python installation. The directories `cgi-bin`, `templates`, `htdocs`, `wiki-default` and `wiki-macros` are all copied to `$prefix/share/trac/`. `conf` and `plugins` stub directories are also created under `$prefix/share/trac/`.
     103On Linux, the default value of `$prefix` is `/usr`, so the installation will be to `/usr/share/trac`, whereas the BSDs use `/usr/local`. Other Unix or Unix-like systems might use a similar prefix or something like `/opt`, please see your system's documentation for details.
    36104
    37 The [wiki:TracAdmin trac-admin] program is the ''control center'' for Trac.
     105The 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.
    38106
    39 '''Note:''' you'll need root permissions or equivalent for this step.
     107=== Advanced Options ===
    40108
    41 For more information on installing Trac on specific platforms, see the [http://projects.edgewall.com/trac/wiki/TracInstallPlatforms TracInstallPlatforms] page (on the main project web site).
     109To install Trac to a custom location, or find out about other advanced installation options, run:
     110{{{
     111easy_install --help
     112}}}
    42113
    43 === Advanced Users ===
    44 To install Trac in a custom location, and view other advanced install options, run:
     114Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
     115
     116Specifically, you might be interested in:
    45117{{{
    46 $ python ./setup.py --help
     118easy_install --prefix=/path/to/installdir
    47119}}}
    48120
    49121== Creating a Project Environment ==
    50122
    51 TracEnvironment is the backend storage format where Trac stores
    52 information like wiki pages, tickets, reports, settings, etc.
    53 An environment consist of a directory containing an SQLite database,
    54 human-readable configuration file, log-files and attachments.
     123A [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.
    55124
    56 A new Trac environment is created using [wiki:TracAdmin trac-admin], like:
    57 
     125A new environment is created using [wiki:TracAdmin trac-admin]:
    58126{{{
    59 $ trac-admin /path/to/projectenv initenv
     127$ trac-admin /path/to/myproject initenv
    60128}}}
    61129
    62 [wiki:TracAdmin trac-admin] will ask you where your subversion repository is located and
    63 where it can find the trac templates directory (the default value should work for a typical install).
     130[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.
    64131
    65 '''Note:''' The web server user will require file system write permission to the environment
    66 directory and all the files inside. '''Remember to set the appropriate permissions.''
     132Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.
    67133
    68 The same applies for the subversion repository files (unless using the [http://svn.collab.net/repos/svn/trunk/notes/fsfs FSFS Subversion backend], something we highly recommend.
     134''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:''
    69135
    70 == Configuring Apache ==
    71 
    72 Make "{{{trac/cgi-bin/trac.cgi}}}" accessible to your web server at {{{/cgi-bin/}}}, either by copying/symlinking or use the "{{{trac/cgi-bin/}}}" directory directly.
    73 
    74 Edit the apache config and add this snippet, filenames edited to match your installation:
    75  
    76 {{{
    77 Alias /trac/ "/usr/share/trac/htdocs/" #or where you installed the trac htdocs
    78 #You have to allow people to read the files in htdocs
    79 <Directory "/usr/share/trac/htdocs">
    80         Options Indexes MultiViews
    81         AllowOverride None
    82         Order allow,deny
    83         Allow from all
    84 </Directory>
     136  chown -R apache.apache /path/to/myproject
    85137
    86138
    87 # Trac need to know where the database is located
    88 <Location "/cgi-bin/trac.cgi">
    89         SetEnv TRAC_ENV "/path/to/projectenv"
    90 </Location>
     139== Running the Standalone Server ==
    91140
    92 # You need this to allow users to authenticate
    93 # trac.htpasswd can be created with
    94 # cmd 'htpasswd -c trac.htpasswd' (UNIX)
    95 # do 'man htpasswd' to see all the options
    96 <Location "/cgi-bin/trac.cgi/login">
    97         AuthType Basic
    98         AuthName "trac"
    99         AuthUserFile /somewhere/trac.htpasswd
    100         Require valid-user
    101 </Location>
     141After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
     142{{{
     143$ tracd --port 8000 /path/to/myproject
    102144}}}
    103145
    104 '''Note:''' If Apache complains about the Set''''''Env line make sure you have the Load''''''Module for mod_env uncommented (Apache 1.3).
     146Then, 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.
    105147
    106 '''Note:''' When creating a new environment, {{{trac-admin}}} will print a config snippet customized for your project.
    107148
    108 '''Note:''' If you are using [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature see [http://projects.edgewall.com/trac/wiki/ApacheSuexec ApacheSuexec] (on the project web site).
     149== Running Trac on a Web Server ==
     150
     151Trac 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.
     152
     153If 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.
     154
     155== Configuring Authentication ==
     156
     157The 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:
     158
     159 * TracStandalone if you use the standalone server, `tracd`.
     160 * TracCgi if you use the CGI or FastCGI methods.
     161 * TracModPython if you use the mod_python method.
    109162
    110163== Using Trac ==
    111164
    112 '''Congratulations!''' You should now have a running Trac installation at:
     165Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc.
    113166
    114 http://<yourhostname>/cgi-bin/trac.cgi
     167Keep 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.
    115168
    116 You should be able to browse your subversion repository, create tickets,
    117 view the timeline and use all the features of Trac.
     169'' Enjoy! ''
    118170
    119 Keep in mind that anonymous users (not logged in) can only access a restricted subset of all Trac features by default.
    120 
    121 '''Note:''' If you don't want long, and relatively ugly, URLs, you can prettify them by changing your Apache config. See [http://projects.edgewall.com/trac/wiki/TracPrettyUrls TracPrettyUrls] (on the project website).
    122 
    123 Please continue to TracPermissions to learn how to grant additional privileges to authenticated users.
    124 
    125 For user documentation, see TracGuide.
    126 
    127 ''Enjoy!''
    128 
    129 [http://projects.edgewall.com/trac/wiki/TracTeam The Trac Team]
     171[wiki:TracTeam The Trac Team]
    130172
    131173----
    132 See also:  TracGuide, TracUpgrade, TracPermissions, TracInstallPlatforms, TracModPython
     174See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions