Changes between Version 1 and Version 2 of TracInstall

Dec 11, 2006, 2:49:39 PM (15 years ago)



  • TracInstall

    v1 v2  
    1 = Trac Installation Guide =
     1= Trac Installation Guide = 
    4 The Trac web-based project management tool is implemented as a CGI- or standalone program. Trac is written in the [ Python] programming language
    5 and uses the [ SQLite] embedded database for persistant storage. For HTML rendering, Trac uses the [ Clearsilver] template system.
     4Trac is a lightweight project management tool that is implemented as a web-based application. Trac is written in the Python programming language and needs a database (either [ SQLite], [ PostgreSQL], or [ MySQL] works). For HTML rendering, Trac uses the [ ClearSilver] templating system.
     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.
    88== Requirements ==
    1010To install Trac, the following software packages must be installed:
    12  * [ 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  * [ Subversion], version >= 1.0. (>=1.1 recommended)
    15  * [ Subversion Python bindings] (Caveat: Trac uses the [ SWIG] bindings included in the Subversion distribution,  '''not''' the  [ PySVN] package!)
    16  * [ SQLite], version 2.8.x or 3.0.x
    17  * [ PySQLite], version >= 0.5 but < 1.1.0 (for SQLite 2.8.x), version >= 1.1.1 (for SQLite 3.0.x)
    18  * [ Clearsilver], version >= 0.9.3
    19  * [ docutils], version >= 0.3.3 (??)
    20  * A CGI-capable web server (tested on [ Apache] )
     12 * [ Python], version >= 2.3.
     13   * For RPM-based systems you might also need the `python-devel` and `python-xml` packages.
     14   * If you want to use Trac with Subversion on Windows, note that there are no precompiled Subversion bindings for Python 2.4, so you probably need Python 2.3.
     15    * 2006-09-20: This seems to be no longer true, see For subversion 1.4.0 python 2.4 binary bindings are available.
     16 * [ ClearSilver], version >= 0.9.3
     17   * With python-bindings (`./configure --with-python=/usr/bin/python`)
     18 * You also need a database system and the corresponding python drivers for it.
     19   The database can be either SQLite, PostgreSQL or MySQL ''(experimental)''.
    22 === Optional Packages ===
     21=== For SQLite ===
    24  * [ mod_python] (see TracModPython)
     23 * [ SQLite], version 2.8.x or 3.x (preferred)
     24 * [ PySQLite], version 1.x (for SQLite 2.x) or version 2.x (for SQLite 3.x). For details see [ PySqlite]
     26''Note: Versions of Trac prior to 0.9 do '''not''' work with PySQLite 2.x.''
     28''Note: It appears that PySQLite 2.x is required for Trac 0.9+/SQLite 3.x if you plan to use the '' script available from the 'contrib' section of the source repository.''
     30''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}}}". [ 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).''
     32=== For PostgreSQL ===
     34 * [ PostgreSQL]
     35 * [ psycopg2] or [ pyPgSQL]
     37''Note: PostgreSQL support requires Trac version 0.9 or later.''
     39=== For MySQL ===
     41'''Warning''': MySQL support is currently experimental. That means it works for some people, but has not been tested extensively yet.
     43 * [ MySQL], version 4.1 or later
     44 * [ MySQLdb], version 1.2.1 or later
     46''Note: MySQL support requires Trac version 0.10 or later.''
     48=== Optional Requirements ===
     50==== Version Control System ====
     51 * [ Subversion], version >= 1.0. (either 1.2.3 or >= 1.3.1 recommended) and corresponding [ Python bindings]. For troubleshooting, check [ TracSubversion]
     52   * Trac uses the [ SWIG] bindings included in the Subversion distribution, '''not''' [ PySVN] (which is sometimes confused with the standard SWIG bindings).
     53   * If Subversion was already installed without the SWIG bindings, you'll need to re-`configure` Subversion and `make swig-py`, `make install-swig-py`.
     54 * Support for other version control systems is provided via third-parties. See [ PluginList] and [ VersioningSystemBackend].
     56==== Web Server ====
     57 * A CGI-capable web server (see TracCgi), or
     58 * a [ FastCGI]-capable web server (see TracFastCgi), or
     59 * [ Apache] with [ mod_python 3.1.3+] (see TracModPython)
     60    * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files)
     62For those stuck with Apache 1.3, it is also possible to get Trac 0.8.4 working with [ mod_python 2.7] (see [wiki:TracModPython2.7 TracModPython2.7]). This hasn't been tested with Trac 0.9, so it may or may not work.
     64==== Other Python Utilities ====
     65 * [ setuptools], version >= 0.6 for using plugins (see TracPlugins)
     66 * [ docutils], version >= 0.3.9 for WikiRestructuredText.
     67 * [ SilverCity] and/or [ Enscript] for [wiki:TracSyntaxColoring syntax highlighting].
     68    * Note that !SilverCity 0.9.6 has a [ bug] that breaks Python syntax highlighting in Trac. Until an update is made available, we recommend using version 0.9.5.
     70'''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].
     72Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [ platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there might concern older versions of Trac than the one you're installing (in particular,
     73there are still some pages that are about Trac 0.8).
    2675== Installing Trac ==
    27 Like most Python programs, install the Trac python modules by running the following command at the top of the source directory:
     77Like most Python programs, the Trac Python package is installed by running the following command at the top of the source directory:
    2979$ python ./ install
    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/ .
     82''Note: you'll need root permissions or equivalent for this step.''
    35 The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments].
     84This will byte-compile the python source code and install it in the `site-packages` directory
     85of 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/` (''since [milestone:0.10]'').
    37 The [wiki:TracAdmin trac-admin] program is the ''control center'' for Trac.
     87The 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.
    39 '''Note:''' you'll need root permissions or equivalent for this step.
     89=== Advanced Options ===
    41 For more information on installing Trac on specific platforms, see the [ TracInstallPlatforms] page (on the main project web site).
     91To install Trac to a custom location, or find out about other advanced installation options, run:
     93$ python ./ install --help
    43 === Advanced Users ===
    44 To install Trac in a custom location, and view other advanced install options, run:
     96Also see [ Installing Python Modules] for detailed information.
     98Specifically, you might be interested in:
    46 $ python ./ --help
     100$ python ./ install --prefix=/path/to/installdir
    49103== Creating a Project Environment ==
    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.
     105A [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.
    56 A new Trac environment is created using [wiki:TracAdmin trac-admin], like:
     107A new environment is created using [wiki:TracAdmin trac-admin]:
    59 $ trac-admin /path/to/projectenv initenv
     109$ trac-admin /path/to/myproject initenv
    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).
     112[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.
    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.''
     114Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.
    68 The same applies for the subversion repository files (unless using the [ FSFS Subversion backend], something we highly recommend.
    70 == Configuring Apache ==
    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.
    74 Edit the apache config and add this snippet, filenames edited to match your installation:
    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>
     116''Note: The user account under which the web server runs will require write permissions to the environment
     117directory and all the files inside.''
    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>
     120== Running the Standalone Server ==
    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>
     122After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
     124$ tracd --port 8000 /path/to/myproject
    104 '''Note:''' If Apache complains about the Set''''''Env line make sure you have the Load''''''Module for mod_env uncommented (Apache 1.3).
     127Then, 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.
    106 '''Note:''' When creating a new environment, {{{trac-admin}}} will print a config snippet customized for your project.
    108 '''Note:''' If you are using [ Apache suEXEC] feature see [ ApacheSuexec] (on the project web site).
     130== Running Trac on a Web Server ==
     132Trac 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.
     134== Configuring Authentication ==
     136The 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:
     138 * TracStandalone if you use the standalone server, `tracd`.
     139 * TracCgi if you use the CGI or FastCGI methods.
     140 * TracModPython if you use the mod_python method.
    110142== Using Trac ==
    112 '''Congratulations!''' You should now have a running Trac installation at:
     144Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc.
    114 http://<yourhostname>/cgi-bin/trac.cgi
     146Keep 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.
    116 You should be able to browse your subversion repository, create tickets,
    117 view the timeline and use all the features of Trac.
    119 Keep in mind that anonymous users (not logged in) can only access a restricted subset of all Trac features by default.
    121 '''Note:''' If you don't want long, and relatively ugly, URLs, you can prettify them by changing your Apache config. See [ TracPrettyUrls] (on the project website).
    123 Please continue to TracPermissions to learn how to grant additional privileges to authenticated users.
    125 For user documentation, see TracGuide.
    127 ''Enjoy!''
     148'' Enjoy! ''
    129150[ The Trac Team]
    132 See also:  TracGuide, TracUpgrade, TracPermissions, TracInstallPlatforms, TracModPython
     153See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, TracUpgrade, TracPermissions