|
39
|
1 Trac Installation Guide
|
|
|
2 =======================
|
|
|
3 Trac is a lightweight project management tool that is implemented as a
|
|
|
4 web-based application. Trac is written in the Python programming language and
|
|
|
5 can use SQLite or PostgreSQL as database. For HTML rendering, Trac uses the
|
|
|
6 Clearsilver templating system.
|
|
|
7
|
|
|
8
|
|
|
9 Requirements
|
|
|
10 ------------
|
|
|
11 To install Trac, the following software packages must be installed:
|
|
|
12
|
|
|
13 * Python, version >= 2.3.
|
|
|
14 + Please keep in mind, that for RPM-based systems you will also need
|
|
|
15 python-devel and python-xml packages.
|
|
|
16 * Subversion, version >= 1.0. (>= 1.1.x recommended)
|
|
|
17 * Subversion SWIG Python bindings (not PySVN).
|
|
|
18 * PySQLite, version >= 0.5 (1.1.6 recommended)
|
|
|
19 * Clearsilver, version >= 0.9.3 (0.9.14 recommended)
|
|
|
20 * A web server capable of executing CGI/FastCGI scripts, or Apache HTTPD with
|
|
|
21 mod_python. (Trac also comes with a standalone server, but its use is not
|
|
|
22 recommended for use in a production environment.)
|
|
|
23
|
|
|
24
|
|
|
25 Installing Trac
|
|
|
26 ---------------
|
|
|
27 The command:
|
|
|
28
|
|
|
29 $ python ./setup.py install
|
|
|
30
|
|
|
31 will byte-compile the python source code and install it in the
|
|
|
32 site-packages directory of your python installation. The directories cgi-bin,
|
|
|
33 templates, htdocs and wiki-default are all copied to ``$prefix/share/trac/``.
|
|
|
34
|
|
|
35 The script will also install the trac-admin command-line tool, used to create
|
|
|
36 and maintain project environments. Trac-admin is the command center of Trac.
|
|
|
37
|
|
|
38 Note: you'll need root permissions or equivalent for this step.
|
|
|
39
|
|
|
40 To install Trac in a different location, or use other advanced installation
|
|
|
41 options, run:
|
|
|
42
|
|
|
43 $ python ./setup.py --help
|
|
|
44
|
|
|
45
|
|
|
46 Installing Trac on Windows
|
|
|
47 --------------------------
|
|
|
48 If you downloaded the Trac installer (the .exe file), installing is simply a
|
|
|
49 matter of running the installer. After running the installer, configuration
|
|
|
50 and installation is the same as for other platforms.
|
|
|
51
|
|
|
52
|
|
|
53 Creating a Project Environment
|
|
|
54 ------------------------------
|
|
|
55 A Trac environment is the backend storage format where Trac stores information
|
|
|
56 like wiki pages, tickets, reports, settings, etc. A Trac environment consists
|
|
|
57 of the environment configuration file (trac.ini), custom templates, log files,
|
|
|
58 and more.
|
|
|
59
|
|
|
60 A new Trac environment is created with trac-admin:
|
|
|
61
|
|
|
62 $ trac-admin /path/to/projectenv initenv
|
|
|
63
|
|
|
64 Note: The user account under which the web server is run needs write permission
|
|
|
65 to the environment directory and all the files inside.
|
|
|
66
|
|
|
67 trac-admin will prompt you for the name of the project, where your subversion
|
|
|
68 repository is located, what database you want to use, etc.
|
|
|
69
|
|
|
70
|
|
|
71 Running the Standalone Server
|
|
|
72 -----------------------------
|
|
|
73 After having created a Trac environment, you can easily try the web interface
|
|
|
74 by running the standalone server tracd:
|
|
|
75
|
|
|
76 $ tracd --port 8000 /path/to/projectenv
|
|
|
77
|
|
|
78 Then, fire up a browser and visit http://localhost:8000/. You should get a
|
|
|
79 simple listing of all environments that tracd knows about. Follow the link
|
|
|
80 to the environment you just created, and you should see Trac in action.
|
|
|
81
|
|
|
82
|
|
|
83 Running Trac on a Web Server
|
|
|
84 ----------------------------
|
|
|
85 Trac provides three options for connecting to a "real" web server: CGI, FastCGI
|
|
|
86 and mod_python. For decent performance, it is recommended that you use either
|
|
|
87 FastCGI or mod_python.
|
|
|
88
|
|
|
89 Please refer to the TracInstall page for details on these setups. You can find
|
|
|
90 it either in the wiki of the Trac project you just created, or on the main Trac
|
|
|
91 site.
|
|
|
92
|
|
|
93
|
|
|
94 Using Trac
|
|
|
95 ----------
|
|
|
96 Once you have your Trac site up and running, you should be able to browse your
|
|
|
97 subversion repository, create tickets, view the timeline, etc.
|
|
|
98
|
|
|
99 Keep in mind that anonymous (not logged in) users can by default access most
|
|
|
100 but not all of the features. You will need to configure authentication and
|
|
|
101 grant additional permissions to authenticated users to see the full set of
|
|
|
102 features.
|
|
|
103
|
|
|
104 For further documentation, see the TracGuide wiki page.
|
|
|
105
|
|
|
106 Enjoy!
|
|
|
107
|
|
|
108 /The Trac Team
|
|
|
109
|
|
|
110 Please also consider joining the mailing list at
|
|
|
111 <http://lists.edgewall.com/mailman/listinfo/trac/>.
|
|
|
112
|
|
|
113
|
|
|
114 Visit the Trac open source project at <http://trac.edgewall.com/>
|
