Changes between Version 8 and Version 9 of TracInstall


Ignore:
Timestamp:
10/05/2023 07:15:55 AM (7 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v8 v9  
    1 = Trac Installation Guide for 1.3
     1= Trac Installation Guide for 1.5
    22[[TracGuideToc]]
    33
    4 Trac is written in the Python programming language and needs a database, [https://sqlite.org/ SQLite], [https://www.postgresql.org/ PostgreSQL], or [https://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://jinja.pocoo.org Jinja2] templating system, though Genshi templates will still be supported until at least Trac 1.5.1.
     4Trac is written in the Python programming language and needs a database, [https://sqlite.org/ SQLite], [https://www.postgresql.org/ PostgreSQL], or [https://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://jinja.pocoo.org Jinja2] templating system, though Genshi templates are supported until Trac 1.5.1.
    55
    66Trac can also be localized, and there is probably a translation available in your language. If you want to use the Trac interface in other languages, then make sure you have installed the optional package [#OtherPythonPackages Babel]. Pay attention to the extra steps for localization support in the [#InstallingTrac Installing Trac] section below. Lacking Babel, you will only get the default English version.
    … …  
    88If you're interested in contributing new translations for other languages or enhancing the existing translations, please have a look at [trac:wiki:TracL10N TracL10N].
    99
    10 What follows are generic instructions for installing and setting up Trac. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms], please '''first read through these general instructions''' to get a good understanding of the tasks involved.
     10These are generic instructions for installing and setting up Trac. While you may find instructions for installing Trac on specific systems at [trac:TracInstallPlatforms TracInstallPlatforms], please '''first read through these general instructions''' to get a good understanding of the tasks involved.
    1111
    1212[[PageOutline(2-3,Installation Steps,inline)]]
    … …  
    1414== Dependencies
    1515=== Mandatory Dependencies
     16
    1617To install Trac, the following software packages must be installed:
    1718
    18  * [https://www.python.org/ Python], version >= 2.7 and < 3.0
    19    (note that we dropped the support for Python 2.6 in this release)
    20  * [https://pypi.org/project/setuptools setuptools], version >= 0.6
     19 * [https://www.python.org/ Python], version >= 3.5
     20 * [https://pypi.org/project/setuptools setuptools], version > 5.6
    2121 * [https://pypi.org/project/Jinja2 Jinja2], version >= 2.9.3
    2222
    23 {{{#!div style="border: 1pt dotted; margin: 1em"
    24 **Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation. More information may be found in [#DeployingTrac Deploying Trac].
    25 }}}
    26 
    27 You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL.
     23You also need a database system and the corresponding Python bindings. The database can be either SQLite, PostgreSQL or MySQL.
    2824
    2925==== For the SQLite database #ForSQLite
    … …  
    3733You need to install the database and its Python bindings:
    3834 * [https://www.postgresql.org/ PostgreSQL], version 9.1 or later
    39  * [https://pypi.org/project/psycopg2 psycopg2], version 2.0 or later
     35 * [https://pypi.org/project/psycopg2 psycopg2], version 2.5 or later
    4036
    4137See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
    … …  
    5450==== Subversion
    5551
    56 [https://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings.
     52[https://subversion.apache.org/ Subversion], 1.14.x or later and the '''corresponding''' Python bindings.
    5753
    5854There are [https://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. See [trac:TracSubversion#GettingSubversion getting Subversion] for more information.
    … …  
    6056{{{#!div style="border: 1pt dotted; margin: 1em"
    6157**Note:**
    62 * Trac '''doesn't''' use [http://pysvn.tigris.org/ PySVN], nor does it work yet with the newer `ctype`-style bindings.
     58* Trac '''doesn't''' use [https://pypi.org/project/PySVN PySVN], nor does it work yet with the newer `ctype`-style bindings.
    6359* If using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are [trac:ticket:493 not supported].
    6460}}}
    … …  
    7571
    7672==== Web Server
     73
    7774A web server is optional because Trac is shipped with a server included, see the [#RunningtheStandaloneServer Running the Standalone Server] section below.
    7875
    7976Alternatively you can configure Trac to run in any of the following environments:
    80  * [https://httpd.apache.org/ Apache] with 
    81    - [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and 
     77 * [https://httpd.apache.org/ Apache] with
     78   - [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and
    8279     [https://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
    8380   - [http://modpython.org/ mod_python 3.5.0], see TracModPython
    8481 * a [https://fastcgi-archives.github.io FastCGI]-capable web server (see TracFastCgi)
    85  * an [https://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    86    server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
     82 * an [https://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
    8783 * Microsoft IIS with FastCGI and a FastCGI-to-WSGI gateway (see [trac:CookBook/Installation/TracOnWindowsIisWfastcgi IIS with FastCGI])
    88  * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script
    89    is highly discouraged''', better use one of the previous options.
    90    
     84 * a CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script is highly discouraged''', better use one of the previous options.
    9185
    9286==== Other Python Packages
    9387
    94  * [http://babel.pocoo.org Babel], version 0.9.6 or >= 1.3,
    95    needed for localization support
    96  * [http://docutils.sourceforge.net docutils], version >= 0.3.9
    97    for WikiRestructuredText.
    98  * [http://pygments.org Pygments] for
    99    [TracSyntaxColoring syntax highlighting].
    100  * [https://pypi.org/project/textile Textile] for rendering the [https://github.com/textile/python-textile Textile markup language].
    101  * [http://pytz.sourceforge.net pytz] to get a complete list of time zones,
    102    otherwise Trac will fall back on a shorter list from
    103    an internal time zone implementation.
     88 * [http://babel.pocoo.org Babel], version >= 2.2, needed for localization support
     89 * [http://pytz.sourceforge.net pytz] to get a complete list of time zones, otherwise Trac will fall back on a shorter list from an internal time zone implementation. Installing Babel will install pytz.
     90 * [http://docutils.sourceforge.net docutils], version >= 0.14, for WikiRestructuredText.
     91 * [http://pygments.org Pygments], version >= 1.0, for [TracSyntaxColoring syntax highlighting].
     92 * [https://pypi.org/project/textile Textile], version >= 2.3, for rendering the [https://github.com/textile/python-textile Textile markup language].
    10493 * [https://pypi.org/project/passlib passlib] on Windows to decode [TracStandalone#BasicAuthorization:Usingahtpasswdpasswordfile htpasswd formats] other than `SHA-1`.
    10594 * [https://pypi.org/project/pyreadline pyreadline] on Windows for trac-admin [TracAdmin#InteractiveMode command completion].
    … …  
    118107
    119108=== Using `pip`
    120 `pip` is the modern Python package manager and is included in Python 2.7.9 and later. Use [https://bootstrap.pypa.io/get-pip.py get-pip.py] to install `pip` for an earlier version of Python.
    121 
    122 {{{#!sh
    123 $ pip install Trac
    124 }}}
    125 
    126 `pip` will automatically resolve the //required// dependencies (Jinja2 and setuptools) and download the latest packages from pypi.org.
     109
     110`pip` is the modern Python package manager and is included in Python distributions. `pip` will automatically resolve the //required// dependencies (Jinja2 and setuptools) and download the latest packages from pypi.org.
    127111
    128112You can also install directly from a source package. You can obtain the source in a tar or zip from the [trac:TracDownload] page. After extracting the archive, change to the directory containing `setup.py` and run:
    … …  
    134118`pip` supports numerous other install mechanisms. It can be passed the URL of an archive or other download location. Here are some examples:
    135119
    136 * Install the latest stable version from a zip archive:
    137 {{{#!sh
    138 $ pip install https://download.edgewall.org/trac/Trac-latest.zip
    139 }}}
    140120* Install the latest development version from a tar archive:
    141121{{{#!sh
    142122$ pip install https://download.edgewall.org/trac/Trac-latest-dev.tar.gz
    143123}}}
    144 * Install the unreleased 1.2-stable from subversion:
    145 {{{#!sh
    146 $ pip install svn+https://svn.edgewall.org/repos/trac/branches/1.2-stable
     124* Install the unreleased 1.4-stable from subversion:
     125{{{#!sh
     126$ pip install svn+https://svn.edgewall.org/repos/trac/branches/1.4-stable
    147127}}}
    148128* Install the latest development preview (//not recommended for production installs//):
    … …  
    153133The optional dependencies can be installed from PyPI using `pip`:
    154134{{{#!sh
    155 $ pip install babel docutils pygments pytz textile
    156 }}}
     135$ pip install babel docutils pygments textile
     136}}}
     137
     138The optional dependencies can alternatively be
     139specified using the `extras` keys in the setup file:
     140{{{#!sh
     141$ pip install Trac[babel,rest,pygments,textile]
     142}}}
     143
     144`rest` is the extra that installs the `docutils`
     145dependency.
     146
     147Include `mysql` or `psycopg2-binary` in the
     148list if using the MySQL or PostgreSQL database.
    157149
    158150Additionally, you can install several Trac plugins from PyPI (listed [https://pypi.org/search/?c=Framework+%3A%3A+Trac here]) using pip. See TracPlugins for more information.
    … …  
    175167}}}
    176168
    177 [TracAdmin trac-admin] will prompt you for the information it needs to create the environment: the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for any of these options, just press `<Enter>` to use the default value. 
     169[TracAdmin trac-admin] will prompt you for the information it needs to create the environment: the name of the project and the [TracEnvironment#DatabaseConnectionStrings database connection string]. If you're not sure what to specify for any of these options, just press `<Enter>` to use the default value.
    178170
    179171Using the default database connection string will always work as long as you have SQLite installed. For the other [trac:DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    … …  
    194186== Deploying Trac
    195187
    196 {{{#!div style="border: 1pt dotted; margin: 1em"
    197 **Setuptools Warning:** If the version of your setuptools is in the range 5.4 through 5.6, the environment variable `PKG_RESOURCES_CACHE_ZIP_MANIFESTS` must be set in order to avoid significant performance degradation.
    198 
    199 If running `tracd`, the environment variable can be set system-wide or for just the user that runs the `tracd` process. There are several ways to accomplish this in addition to what is discussed here, and depending on the distribution of your OS.
    200 
    201 To be effective system-wide a shell script with the `export` statement may be added to `/etc/profile.d`. To be effective for a user session the `export` statement may be added to `~/.profile`.
    202 {{{#!sh
    203 export PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1
    204 }}}
    205 
    206 Alternatively, the variable can be set in the shell before executing `tracd`:
    207 {{{#!sh
    208 $ PKG_RESOURCES_CACHE_ZIP_MANIFESTS=1 tracd --port 8000 /path/to/myproject
    209 }}}
    210 
    211 If running the Apache web server, !Ubuntu/Debian users should add the `export` statement to `/etc/apache2/envvars`. !RedHat/CentOS/Fedora should can add the `export` statement to `/etc/sysconfig/httpd`.
    212 }}}
    213 
    214188=== Running the Standalone Server
    215189
    … …  
    226200=== Running Trac on a Web Server
    227201
    228 Trac provides various options for connecting to a "real" web server: 
     202Trac provides various options for connecting to a "real" web server:
    229203 - [TracFastCgi FastCGI]
    230  - [wiki:TracModWSGI Apache with mod_wsgi] 
     204 - [wiki:TracModWSGI Apache with mod_wsgi]
    231205 - [TracModPython Apache with mod_python]
    232206 - [TracCgi CGI] //(should not be used, as the performance is far from optimal)//
    … …  
    279253Assuming the deployment has been done this way:
    280254{{{#!sh
    281 $ trac-admin /var/trac/<project> deploy /var/www
     255$ trac-admin /var/trac/<project> deploy /var/www/trac
    282256}}}
    283257
    284258Add the following snippet to Apache configuration, changing paths to match your deployment. The snippet must be placed ''before'' the `ScriptAlias` or `WSGIScriptAlias` directive, because those directives map all requests to the Trac application:
    285259{{{#!apache
    286 Alias /trac/chrome /path/to/trac/htdocs
    287 
    288 <Directory "/path/to/www/trac/htdocs">
     260Alias /trac/chrome /var/www/trac/htdocs
     261
     262<Directory "/var/www/trac/htdocs">
    289263  # For Apache 2.2
    290264  <IfModule !mod_authz_core.c>
    … …  
    342316== Configuring Authentication
    343317
    344 Trac uses HTTP authentication. You'll need to configure your webserver to request authentication when the `.../login` URL is hit (the virtual path of the "login" button). Trac will automatically pick the `REMOTE_USER` variable up after you provide your credentials. Therefore, all user management goes through your web server configuration. Please consult the documentation of your web server for more info.
    345 
    346 The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. 
     318Trac uses HTTP authentication. You'll need to configure your web server to request authentication when the `.../login` URL is hit (the virtual path of the "login" button). Trac will automatically pick the `REMOTE_USER` variable up after you provide your credentials. Therefore, all user management goes through your web server configuration. Please consult the documentation of your web server for more info.
     319
     320The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
    347321
    348322Please refer to one of the following sections: