Edgewall Software

Changes between Version 1 and Version 2 of TracOnOpenSolaris


Ignore:
Timestamp:
Mar 11, 2010, 4:58:07 PM (14 years ago)
Author:
tjyang2001@…
Comment:

daft using INSTALL from src tree.

Legend:

Unmodified
Added
Removed
Modified
  • TracOnOpenSolaris

    v1 v2  
     1
     2
     3
     4
     5= Trac Installation Guide for OpenSolaris =
     6
     7Trac is a lightweight project management tool that is implemented as a
     8web-based application. Trac is written in the Python programming language and
     9can use SQLite, PostgreSQL or MySQL as database. For HTML rendering, Trac uses
     10the Genshi templating system.
     11
     12
     13Note that you should also read the trac/wiki/default-pages/TracInstall
     14documentation file present in the source distribution.
     15If you're upgrading an already installed environment, please also read
     16trac/wiki/default-pages/TracUpgrade.
     17
    118
    219wget http://ftp.edgewall.com/pub/trac/Trac-0.11.7.tar.gz
    320wget http://peak.telecommunity.com/dist/ez_setup.py
    421
     22
     23= Requirements =
     24
     25To install Trac, the following software packages must be installed:
     26
     27 * Python, version >= 2.3.
     28 * setuptools, version >= 0.6
     29 * Genshi, version >= 0.5
     30 * Optionally, Subversion, version >= 1.1.x and the Subversion SWIG Python
     31   bindings (not PySVN, that's something different).
     32 * One of the following Python bindings, depending on the database used:
     33    * pysqlite version 2.x for SQLite 3.x (is part of the standard library
     34      starting with Python 2.5)
     35    * psycopg2 version 2.0.x for the PostgreSQL database
     36    * MySQLdb, version 1.2.2 for the MySQL database
     37 * A web server capable of executing CGI/FastCGI scripts, or Apache HTTPD with
     38   mod_python or mod_wsgi. (Trac also comes with a standalone server, tracd)
     39
     40Any of the above python library can usually be installed using easy_install,
     41which itself can be installed using the following bootstrap script:
     42
     43  $ wget http://peak.telecommunity.com/dist/ez_setup.py
     44
     45  $ python ez_setup.py
     46
     47After that, you can do for example: easy_install Genshi
     48
     49If you're using Python 2.3 or 2.4 and need pysqlite, you can download from
     50http://code.google.com/p/pysqlite/downloads/list the Windows installers or the
     51tar.gz archive for building from source:
     52
     53  $ tar xvfz <version>.tar.gz
     54
     55  $ cd <version>
     56
     57  $ python setup.py build_static install
     58
     59That way, the latest SQLite version will be downloaded and built into the
     60bindings.
     61
     62
     63= Installing Trac =
     64---------------
     65The command:
     66
     67  $ python ./setup.py install
     68
     69will byte-compile the python source code and install it in the
     70site-packages directory of your python installation. The directories cgi-bin,
     71templates, htdocs and wiki-default are all copied to ``$prefix/share/trac/``.
     72
     73The script will also install the trac-admin command-line tool, used to create
     74and maintain project environments. Trac-admin is the command center of Trac.
     75
     76Note: you'll need root permissions or equivalent for this step.
     77
     78To install Trac in a different location, or use other advanced installation
     79options, run:
     80
     81  $ python ./setup.py --help
     82
     83
     84= Installing Trac on Windows =
     85
     86
     87If you downloaded the Trac installer (the .exe file), installing is simply a
     88matter of running the installer.  After running the installer, configuration
     89and installation is the same as for other platforms.
     90
     91
     92Creating a Project Environment
     93------------------------------
     94A Trac environment is the backend storage format where Trac stores information
     95like wiki pages, tickets, reports, settings, etc. A Trac environment consists
     96of the environment configuration file (trac.ini), custom templates, log files,
     97and more.
     98
     99A new Trac environment is created with trac-admin:
     100
     101  $ trac-admin /path/to/projectenv initenv
     102
     103Note: The user account under which the web server is run needs write permission
     104to the environment directory and all the files inside.
     105
     106trac-admin will prompt you for the name of the project, where your subversion
     107repository is located, what database you want to use, etc.
     108
     109
     110= Running the Standalone Server =
     111
     112After having created a Trac environment, you can easily try the web interface
     113by running the standalone server tracd:
     114
     115  $ tracd --port 8000 /path/to/projectenv
     116
     117Then, fire up a browser and visit http://localhost:8000/. You should get a
     118simple listing of all environments that tracd knows about. Follow the link
     119to the environment you just created, and you should see Trac in action.
     120
     121
     122= Running Trac on a Web Server =
     123
     124Trac provides three options for connecting to a "real" web server: CGI, FastCGI
     125and mod_python. For decent performance, it is recommended that you use either
     126FastCGI or mod_python.
     127
     128Please refer to the TracInstall page for details on these setups. You can find
     129it either in the wiki of the Trac project you just created, or on the main Trac
     130site.
     131
     132
     133= Using Trac =
     134
     135Once you have your Trac site up and running, you should be able to browse your
     136subversion repository, create tickets, view the timeline, etc.
     137
     138Keep in mind that anonymous (not logged in) users can by default access most
     139but not all of the features. You will need to configure authentication and
     140grant additional permissions to authenticated users to see the full set of
     141features.
     142
     143For further documentation, see the TracGuide wiki page.
     144
     145
     146
     147