Changes between Version 1 and Version 2 of TracInstall

Jan 16, 2006, 10:33:20 AM (16 years ago)



  • TracInstall

    v1 v2  
    1 = Trac Installation Guide =
     1= Trac Installation Guide =
    3 The Trac web-based project management tool is implemented as a server
    4 side cgi-program. Trac is written in the Python programming language
    5 and uses SQLite as an embedded database. 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 can use [ SQLite] or [ PostgreSQL] as  database. 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.
    13    * Please keep in mind, that for RPM-based systems you will also need python-devel and python-xml packages.
    14  * [ Subversion], version >= 0.37. (>=1.0.1 recommended)
    15  * [ Subversion Python bindings].
    16  * [ PySQLite], version >= 0.4.3 (>= 0.5 for better performance)
    17  * [ Clearsilver], version >= 0.9.3
    18  * A CGI-capable web server (we QA-test on [ Apache2] )
     12 * [ Python], version >= 2.3.
     13   * Python 2.4 is not supported on Windows since there are no Subversion bindings available for it.
     14   * For RPM-based systems you might also need the `python-devel` and `python-xml` packages.
     15 * [ Subversion], version >= 1.0. (>= 1.1 recommended) and corresponding [ Python bindings]
     16   * Trac uses the [ SWIG] bindings included in the Subversion distribution, '''not''' [ PySVN] (which is sometimes confused with the standard SWIG bindings).
     17   * If Subversion was already installed without the SWIG bindings, you'll need to re-`configure` Subversion and `make swig-py`, `make install-swig-py`.
     18 * [ ClearSilver], version >= 0.9.3
     19   * With python-bindings (`./configure --with-python=/usr/bin/python`)
     21=== For SQLite ===
     23 * [ SQLite], version 2.8.x or 3.x
     24 * [ PySQLite]
     25   * version 1.0.x (for SQLite 2.8.x)
     26   * version 1.1.x or 2.x (for SQLite 3.x)
     28=== For PostgreSQL ===
     30 * [ PostgreSQL]
     31 * [ psycopg1], [ psycopg2], or [ pyPgSQL]
     33=== Optional Requirements ===
     35 * A CGI-capable web server (see TracCgi), or
     36 * a [ FastCGI]-capable web server (see TracFastCgi), or
     37 * [ Apache] with [ mod_python 3.1.3+] (see TracModPython)
     38 * [ setuptools], version >= 0.5a13 for using plugins (see TracPlugins)
     39 * [ docutils], version >= 0.3.3 for WikiRestructuredText.
     40 * [ SilverCity] and/or [ Enscript] for [wiki:TracSyntaxColoring syntax highlighting].
     42'''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].
     44Please 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.
    2046== Installing Trac ==
     48Like most Python programs, the Trac Python package is installed by running the following command at the top of the source directory:
    2250$ python ./ install
    25 This will byte-compile the python source code and install it in the {{{site-packages}}} directory
    26 of your python installation. The directories {{{cgi-bin}}}, {{{templates}}}, {{{htdocs}}} and {{{wiki-default}}} are all copied to $prefix/share/trac/ .
     53''Note: you'll need root permissions or equivalent for this step.''
    28 The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain project
    29 environments. Trac-admin is the ''command center'' of Trac.
     55This will byte-compile the python source code and install it in the `site-packages` directory
     56of your Python installation. The directories `cgi-bin`, `templates`, `htdocs`, `wiki-default` and `wiki-macros` are all copied to `$prefix/share/trac/.`
    31 '''Note:''' you'll need root permissions or equivalent for this step.
    33 For more information on installing Trac on specific platforms, see:
    35  * TracOnOsx
    36  * TracOnMandrakelinux
    37  * TracOnGentoo
    38  * TracOnFreeBsd
    39  * TracOnNetBsd
    40  * TracOnDebian
    41  * TracOnWindows
    42  * TracOnRedhat
     58The 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.
    4460=== Advanced Users ===
    45 To install Trac in a different location, and other advanced installation options, run:
     62To install Trac to a custom location, or find out about other advanced installation options, run:
    4764$ python ./ --help
     67Specifically, you might be interested in:
     69$ python ./ install --prefix=/path/you/want
    5073== Creating a Project Environment ==
    52 ''Trac Environment'' is the backend storage format where Trac stores
    53 information like wiki pages, tickets, reports, settings, etc.
    54 A Trac environment consist of a directory containing an SQLite database,
    55 human-readable configuration file, log-files and attachments.
     75A [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.
    57 A new Trac environment is created with {{{trac-admin}}}:
     77A new environment is created using [wiki:TracAdmin trac-admin]:
     79$ trac-admin /path/to/trac_project_env initenv
    59 {{{
    60 $ trac-admin /path/to/projectenv initenv
    61 }}}
    62 '''Note:''' The web server user need write permission to the environment
    63 directory and all the files inside.
     82[wiki:TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project, the path to an existing subversion 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. The only option where the default value is likely to not work is the path to the Subversion repository, so make sure that one's correct.
    65 [wiki:TracAdmin trac-admin] will ask you where your subversion repository is located and
    66 where it can find the trac templates directory (the default value should be fine).
     84Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.
    68 == Configuring Apache ==
    70 Copy (or symlink) "{{{trac/cgi-bin/trac.cgi}}}" to
    71 you web servers {{{/cgi-bin/}}} directory. You can also configure apache
    72 to use the "{{{trac/cgi-bin/}}}" directory directly if you like, it's a matter of taste.
    74 Finally edit the apache config and add this config snippet, with filenams edited to match your installation:
    76 {{{
    77 Alias /trac/ "/usr/share/trac/htdocs/" #or where you installed the trac docs
    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>
     86''Note: The user account under which the web server runs will require write permissions to the environment
     87directory 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>
     90== 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>
     92After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
     94$ tracd --port 8000 /path/to/projectenv
    104 '''Note:''' When creating a new environment, {{{trac-admin}}} will print a config snippet customized for your project.
     97Then, 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.
     100== Running Trac on a Web Server ==
     102Trac 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.
     104== Configuring Authentication ==
     106The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.  To learn about how to accomplish these tasks, please visit one of the following pages:
     108 * TracStandalone if you use the standalone server, `tracd`.
     109 * TracCgi if you use the CGI or FastCGI methods.
     110 * TracModPython if you use the mod_python method.
    106112== Using Trac ==
    108 You should now have a working Trac installation at:
     114Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc.
    110 http://<yourhostname>/cgi-bin/trac.cgi
    112 There you should be able to browse your subversion repository, create tickets,
    113 view the timeline etc. Keep in mind that anonymous users (not logged in)
    114 can only access a restricted subset of all Trac features.
    116 Please continue to TracPermissions to learn how to grant additional privileges to authenticated users.
    118 For further user-documentation, see TracGuide.
     116Keep 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.
     120[ The Trac Team]
    123 See also:  TracGuide, TracPermissions, TracOnFreeBsd, TracOnNetBsd, TracOnOsx, TracOnMandrakelinux, TracOnDebian, TracOnGentoo
     123See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, TracUpgrade, TracPermissions