Changes between Version 2 and Version 3 of TracInstall


Ignore:
Timestamp:
11/18/04 18:02:59 (16 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v2 v3  
    11= Trac Installation Guide =
     2[[TracGuideToc]]
    23
    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.
     4The 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
     5and 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.
    66
    77
     
    1010To install Trac, the following software packages must be installed:
    1111
    12  * [http://www.python.org/ Python], version >= 2.1.
     12 * [http://www.python.org/ Python], version >= 2.1 (>=2.3 recommended).
    1313   * 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 >= 0.37. (>=1.0.1 recommended)
    15  * [http://subversion.tigris.org/ Subversion Python bindings].
    16  * [http://pysqlite.sf.net/ PySQLite], version >= 0.4.3 (>= 0.5 for better performance)
     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)
    1718 * [http://clearsilver.net/ Clearsilver], version >= 0.9.3
    18  * A CGI-capable web server (we QA-test on [http://httpd.apache.org/ Apache2] )
     19 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.3 (??)
     20 * A CGI-capable web server (tested on [http://httpd.apache.org/ Apache] )
     21
     22=== Optional Packages ===
     23
     24 * [http://www.modpython.org/ mod_python] (see TracModPython)
    1925
    2026== Installing Trac ==
     27Like most Python programs, install the Trac python modules by running the following command at the top of the source directory:
    2128{{{
    2229$ python ./setup.py install
     
    2633of your python installation. The directories {{{cgi-bin}}}, {{{templates}}}, {{{htdocs}}} and {{{wiki-default}}} are all copied to $prefix/share/trac/ .
    2734
    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.
     35The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments].
     36
     37The [wiki:TracAdmin trac-admin] program is the ''control center'' for Trac.
    3038
    3139'''Note:''' you'll need root permissions or equivalent for this step.
    3240
    33 For more information on installing Trac on specific platforms, see:
    34 
    35  * TracOnOsx
    36  * TracOnMandrakelinux
    37  * TracOnGentoo
    38  * TracOnFreeBsd
    39  * TracOnNetBsd
    40  * TracOnDebian
    41  * TracOnWindows
    42  * TracOnRedhat
     41For 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).
    4342
    4443=== Advanced Users ===
    45 To install Trac in a different location, and other advanced installation options, run:
     44To install Trac in a custom location, and view other advanced install options, run:
    4645{{{
    4746$ python ./setup.py --help
     
    5049== Creating a Project Environment ==
    5150
    52 ''Trac Environment'' is the backend storage format where Trac stores
     51TracEnvironment is the backend storage format where Trac stores
    5352information like wiki pages, tickets, reports, settings, etc.
    54 A Trac environment consist of a directory containing an SQLite database,
     53An environment consist of a directory containing an SQLite database,
    5554human-readable configuration file, log-files and attachments.
    5655
    57 A new Trac environment is created with {{{trac-admin}}}:
     56A new Trac environment is created using [wiki:TracAdmin trac-admin], like:
    5857
    5958{{{
    6059$ trac-admin /path/to/projectenv initenv
    6160}}}
    62 '''Note:''' The web server user need write permission to the environment
    63 directory and all the files inside.
    6461
    6562[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).
     63where it can find the trac templates directory (the default value should work for a typical install).
     64
     65'''Note:''' The web server user will require file system write permission to the environment
     66directory and all the files inside. '''Remember to set the appropriate permissions.''
     67
     68The 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.
    6769
    6870== Configuring Apache ==
    6971
    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.
     72Make "{{{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.
    7373
    74 Finally edit the apache config and add this config snippet, with filenams edited to match your installation:
     74Edit the apache config and add this snippet, filenames edited to match your installation:
    7575 
    7676{{{
    77 Alias /trac/ "/usr/share/trac/htdocs/" #or where you installed the trac docs
     77Alias /trac/ "/usr/share/trac/htdocs/" #or where you installed the trac htdocs
    7878#You have to allow people to read the files in htdocs
    79 <Directory "/usr/share/trac/htdocs/">
     79<Directory "/usr/share/trac/htdocs">
    8080        Options Indexes MultiViews
    8181        AllowOverride None
     
    9999        AuthUserFile /somewhere/trac.htpasswd
    100100        Require valid-user
    101 </location>
     101</Location>
    102102}}}
     103
     104'''Note:''' If Apache complains about the Set''''''Env line make sure you have the Load''''''Module for mod_env uncommented (Apache 1.3).
    103105
    104106'''Note:''' When creating a new environment, {{{trac-admin}}} will print a config snippet customized for your project.
    105107
     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).
     109
    106110== Using Trac ==
    107111
    108 You should now have a working Trac installation at:
     112'''Congratulations!''' You should now have a running Trac installation at:
    109113
    110114http://<yourhostname>/cgi-bin/trac.cgi
    111115
    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.
     116You should be able to browse your subversion repository, create tickets,
     117view the timeline and use all the features of Trac.
     118
     119Keep 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).
    115122
    116123Please continue to TracPermissions to learn how to grant additional privileges to authenticated users.
    117124
    118 For further user-documentation, see TracGuide.
     125For user documentation, see TracGuide.
    119126
    120127''Enjoy!''
    121128
     129[http://projects.edgewall.com/trac/wiki/TracTeam The Trac Team]
     130
    122131----
    123 See also:  TracGuide, TracPermissions, TracOnFreeBsd, TracOnNetBsd, TracOnOsx, TracOnMandrakelinux, TracOnDebian, TracOnGentoo
     132See also:  TracGuide, TracUpgrade, TracPermissions, TracInstallPlatforms, TracModPython