Changes between Version 6 and Version 7 of TracInstall


Ignore:
Timestamp:
Jun 20, 2020, 9:43:52 PM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracInstall

    v6 v7  
    1 = Trac Installation Guide for 1.1
     1= Trac Installation Guide for 1.2
    22[[TracGuideToc]]
    33
    4 Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system.
     4Trac is written in the Python programming language and needs a database, [https://sqlite.org/ SQLite], [https://www.postgresql.org/ PostgreSQL], or [https://www.mysql.com/ MySQL]. For HTML rendering, Trac uses the [https://genshi.edgewall.org/ Genshi] templating system.
    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.
     
    1616To install Trac, the following software packages must be installed:
    1717
    18  * [http://www.python.org/ Python], version >= 2.6 and < 3.0
     18 * [https://www.python.org/ Python], version >= 2.6 and < 3.0
    1919   (note that we dropped the support for Python 2.5 in this release)
    20  * [http://pypi.python.org/pypi/setuptools setuptools], version >= 0.6
    21  * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.6
     20 * [https://pypi.org/project/setuptools setuptools], version >= 0.6
     21 * [https://pypi.org/project/Genshi Genshi], version >= 0.6
    2222
    2323You also need a database system and the corresponding python bindings. The database can be either SQLite, PostgreSQL or MySQL.
     
    2727As you must be using Python 2.6 or 2.7, you already have the SQLite database bindings bundled with the standard distribution of Python (the `sqlite3` module).
    2828
    29 Optionally, you may install a newer version of [http://pypi.python.org/pypi/pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
     29Optionally, you may install a newer version of [https://pypi.org/project/pysqlite pysqlite] than the one provided by the Python distribution. See [trac:PySqlite#ThePysqlite2bindings PySqlite] for details.
    3030
    3131==== For the PostgreSQL database #ForPostgreSQL
    3232
    3333You need to install the database and its Python bindings:
    34  * [http://www.postgresql.org/ PostgreSQL], version 8.0 or later
    35  * [http://pypi.python.org/pypi/psycopg2 psycopg2], version 2.0 or later
     34 * [https://www.postgresql.org/ PostgreSQL], version 8.0 or later
     35 * [https://pypi.org/project/psycopg2 psycopg2], version 2.0 or later
    3636
    3737See [trac:DatabaseBackend#Postgresql DatabaseBackend] for details.
     
    4141Trac works well with MySQL, provided you follow the guidelines:
    4242
    43  * [http://mysql.com/ MySQL], version 5.0 or later
    44  * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
     43 * [https://www.mysql.com/ MySQL], version 5.0 or later
     44 * [https://sf.net/projects/mysql-python MySQLdb], version 1.2.2 or later
    4545
    4646Given the caveats and known issues surrounding MySQL, read carefully the [trac:MySqlDb] page before creating the database.
     
    5050==== Subversion
    5151
    52 [http://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings.
    53 
    54 There are [http://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. (Good luck finding precompiled SWIG bindings for any Windows package at that listing. [trac:TracSubversion] points you to [http://alagazam.net Alagazam], which works for me under Python 2.6.)
     52[https://subversion.apache.org/ Subversion], 1.6.x or later and the '''''corresponding''''' Python bindings.
     53
     54There are [https://subversion.apache.org/packages.html pre-compiled SWIG bindings] available for various platforms. (Good luck finding precompiled SWIG bindings for any Windows package at that listing. [trac:TracSubversion] points you to [https://alagazam.net Alagazam], which works for me under Python 2.6.)
    5555
    5656For troubleshooting information, see the [trac:TracSubversion#Troubleshooting TracSubversion] page.
     
    6464==== Git
    6565
    66 [http://git-scm.com/ Git] 1.5.6 or later is supported. More information is available on the [trac:TracGit] page.
     66[https://git-scm.com/ Git] 1.5.6 or later is supported. More information is available on the [trac:TracGit] page.
    6767
    6868==== Other Version Control Systems
     
    7474
    7575Alternatively you can configure Trac to run in any of the following environments:
    76  * [http://httpd.apache.org/ Apache] with
    77    - [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and
    78      [http://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
    79    - [http://modpython.org/ mod_python 3.5.0], see TracModPython
    80  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
    81  * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
     76 * [https://httpd.apache.org/ Apache] with
     77  * [https://github.com/GrahamDumpleton/mod_wsgi mod_wsgi], see [wiki:TracModWSGI] and [https://code.google.com/p/modwsgi/wiki/IntegrationWithTrac ModWSGI IntegrationWithTrac].
     78  * [http://modpython.org/ mod_python 3.5.0], see TracModPython
     79 * a [https://fastcgi-archives.github.io/ FastCGI]-capable web server (see TracFastCgi)
     80 * an [https://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    8281   server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
    8382 * Microsoft IIS with FastCGI and a FastCGI-to-WSGI gateway (see [trac:CookBook/Installation/TracOnWindowsIisWfastcgi IIS with FastCGI])
     
    111110
    112111=== Using `easy_install`
    113 Trac can be installed from PyPI or the Subversion repository using [http://pypi.python.org/pypi/setuptools setuptools].
     112Trac can be installed from PyPI or the Subversion repository using [https://pypi.org/project/setuptools setuptools].
    114113
    115114A few examples:
     
    121120 - Install latest development version:
    122121 {{{#!sh
    123 $ easy_install http://download.edgewall.org/trac/Trac-latest-dev.tar.gz
     122$ easy_install https://download.edgewall.org/trac/Trac-latest-dev.tar.gz
    124123}}}
    125124   Note that in this case you won't have the possibility to run a localized version of Trac;
     
    138137Assuming you want to have your entire pip installation in `/opt/user/trac`
    139138
    140  -
    141139 {{{#!sh
    142 pip install trac psycopg2
     140$ pip install trac psycopg2
    143141}}}
    144142or
    145  -
    146143 {{{#!sh
    147 pip install trac mysql-python
     144$ pip install trac mysql-python
    148145}}}
    149146
     
    186183To install Trac to a custom location, or find out about other advanced installation options, run:
    187184{{{#!sh
    188 easy_install --help
    189 }}}
    190 
    191 Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
     185$ easy_install --help
     186}}}
     187
     188Also see [https://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
    192189
    193190Specifically, you might be interested in:
    194191{{{#!sh
    195 easy_install --prefix=/path/to/installdir
     192$ easy_install --prefix=/path/to/installdir
    196193}}}
    197194or, if installing Trac on a Mac OS X system:
    198195{{{#!sh
    199 easy_install --prefix=/usr/local --install-dir=/Library/Python/2.6/site-packages
     196$ easy_install --prefix=/usr/local --install-dir=/Library/Python/2.6/site-packages
    200197}}}
    201198
     
    215212}}}
    216213
    217 [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.
     214You will be prompted for the information needed 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.
    218215
    219216Using 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.
     
    274271 - [wiki:TracModWSGI Apache with mod_wsgi]
    275272 - [TracModPython Apache with mod_python]
    276  - //[TracCgi CGI] (should not be used, as the performance is far from optimal)//
    277 
    278 Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. Other deployment scenarios are possible: [trac:TracNginxRecipe nginx], [http://projects.unbit.it/uwsgi/wiki/Example#Traconapacheinasub-uri uwsgi], [trac:TracOnWindowsIisIsapi Isapi-wsgi] etc.
     273 - [TracCgi CGI] //(should not be used, as the performance is far from optimal)//
     274
     275Trac also supports [trac:TracOnWindowsIisAjp AJP] which may be your choice if you want to connect to IIS. Other deployment scenarios are possible: [trac:TracNginxRecipe nginx], [https://uwsgi-docs.readthedocs.io/en/latest/#Traconapacheinasub-uri uwsgi], [trac:TracOnWindowsIisIsapi Isapi-wsgi] etc.
    279276
    280277==== Generating the Trac cgi-bin directory #cgi-bin
    281278
    282 In order for Trac to function properly with FastCGI you need to have a `trac.fcgi` file and for mod_wsgi a `trac.wsgi` file. These are Python scripts which load the appropriate Python code. They can be generated using the `deploy` option of [TracAdmin trac-admin].
    283 
    284 There is, however, a bit of a chicken-and-egg problem. The [TracAdmin trac-admin] command requires an existing environment to function, but complains if the deploy directory already exists. This is a problem, because environments are often stored in a subdirectory of the deploy. The solution is to do something like this:
    285 {{{#!sh
    286 mkdir -p /usr/share/trac/projects/my-project
    287 trac-admin /usr/share/trac/projects/my-project initenv
    288 trac-admin /usr/share/trac/projects/my-project deploy /tmp/deploy
    289 mv /tmp/deploy/* /usr/share/trac
    290 }}}
    291 Don't forget to check that the web server has the execution right on scripts in the `/usr/share/trac/cgi-bin` directory.
     279Application scripts for CGI, FastCGI and mod-wsgi can be generated using the [TracAdmin trac-admin] `deploy` command:
     280[[TracAdminHelp(deploy)]]
     281
     282Grant the web server execution right on scripts in the `cgi-bin` directory.
     283
     284For example, the following yields a typical directory structure:
     285{{{#!sh
     286$ mkdir -p /var/trac
     287$ trac-admin /var/trac/<project> initenv
     288$ trac-admin /var/trac/<project> deploy /var/www
     289$ ls /var/www
     290cgi-bin htdocs
     291$ chmod ugo+x /var/www/cgi-bin/*
     292}}}
    292293
    293294==== Mapping Static Resources
     
    295296Without additional configuration, Trac will handle requests for static resources such as stylesheets and images. For anything other than a TracStandalone deployment, this is not optimal as the web server can be set up to directly serve the static resources. For CGI setup, this is '''highly undesirable''' as it causes abysmal performance.
    296297
    297 Web servers such as [http://httpd.apache.org/ Apache] allow you to create //Aliases// to resources, giving them a virtual URL that doesn't necessarily reflect their location on the file system. We can map requests for static resources directly to directories on the file system, to avoid Trac processing the requests.
     298Web servers such as [https://httpd.apache.org/ Apache] allow you to create //Aliases// to resources, giving them a virtual URL that doesn't necessarily reflect their location on the file system. We can map requests for static resources directly to directories on the file system, to avoid Trac processing the requests.
    298299
    299300There are two primary URL paths for static resources: `/chrome/common` and `/chrome/site`. Plugins can add their own resources, usually accessible at the `/chrome/<plugin>` path.
    300301
    301 A single `/chrome` alias can used if the static resources are extracted for all plugins. This means that the `deploy` command must be executed after installing or updating a plugin that provides static resources, or after modifying resources in the `$env/htdocs` directory. This is probably appropriate for most installations but may not be what you want if, for example, you wish to upload plugins through the //Plugins// administration page.
    302 
    303 The resources are extracted using the [TracAdmin trac-admin]` <environment> deploy` command:
    304 [[TracAdminHelp(deploy)]]
    305 
    306 The target `<directory>` will contain an `htdocs` directory with:
     302A single `/chrome` alias can used if the static resources are extracted for all plugins. This means that the `deploy` command (discussed in the previous section) must be executed after installing or updating a plugin that provides static resources, or after modifying resources in the `$env/htdocs` directory. This is probably appropriate for most installations but may not be what you want if, for example, you wish to upload plugins through the //Plugins// administration page.
     303
     304The `deploy` command creates an `htdocs` directory with:
    307305 - `common/` - the static resources of Trac
    308306 - `site/` - a copy of the environment's `htdocs/` directory
     
    322320Assuming the deployment has been done this way:
    323321{{{#!sh
    324 $ trac-admin /var/trac/env deploy /path/to/shared/trac
     322$ trac-admin /var/trac/<project> deploy /var/www
    325323}}}
    326324
     
    366364}}}
    367365
    368 Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [[TracIni#trac-section| [trac] htdocs_location]] configuration setting:
     366Another alternative to aliasing `/trac/chrome/common` is having Trac generate direct links for those static resources (and only those), using the [TracIni#trac-section htdocs_location] configuration setting:
    369367{{{#!ini
    370368[trac]
     
    379377}}}
    380378
    381 ==== Setting up the Plugin Cache
     379==== Setting up the Plugin Cache #egg-cache
    382380
    383381Some Python plugins need to be extracted to a cache directory. By default the cache resides in the home directory of the current user. When running Trac on a Web Server as a dedicated user (which is highly recommended) who has no home directory, this might prevent the plugins from starting. To override the cache location you can set the `PYTHON_EGG_CACHE` environment variable. Refer to your server documentation for detailed instructions on how to set environment variables.
     382
     383If you setup hook scripts that call Trac, such as the Subversion post-commit hook script provided in the `/contrib` directory, make sure you define the `PYTHON_EGG_CACHE` environment variable within these scripts as well.
    384384
    385385== Configuring Authentication