Edgewall Software

Changes between Version 358 and Version 359 of TracInstall


Ignore:
Timestamp:
Dec 7, 2012, 10:00:03 AM (11 years ago)
Author:
Thijs Triemstra
Comment:

fix typos

Legend:

Unmodified
Added
Removed
Modified

  • TracInstall

    v358 v359  
    22#!div style="margin-top: .5em; padding: 0 1em; background-color: #ffd; border:1px outset #ddc; text-align: center"
    33
    4  '''NOTE: the information in this page applies to Trac 1.0, the upcoming version of Trac. \\
     4 '''NOTE: the information in this page applies to Trac 1.0, the current version of Trac. \\
    55 For installing previous Trac versions, please refer to [[wiki:0.12/TracInstall]] (for Trac 0.12)'''
    66}}}
    … …  
    1111Trac 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.
    1212
    13 Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able 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, as usual.
     13Since version 0.12, Trac can also be localized, and there's probably a translation available for your language. If you want to be able 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, as usual.
    1414
    1515If you're interested in contributing new translations for other languages or enhance the existing translations, then please have a look at [[trac:TracL10N]].
    … …  
    4848SQLite 2.x is no longer supported.
    4949
    50 A known bug PySqlite versions 2.5.2-4 prohibits upgrade of trac databases
     50A known bug in PySqlite versions 2.5.2-4 prohibits upgrades of Trac databases
    5151from 0.11.x to 0.12. Please use versions 2.5.5 and newer or 2.5.1 and
    5252older. See #9434 for more detail.
    … …  
    112112 * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9
    113113   for WikiRestructuredText.
    114  * [http://pygments.pocoo.org Pygments] for
     114 * [http://pygments.org Pygments] for
    115115   [wiki:TracSyntaxColoring syntax highlighting].
    116116   [http://silvercity.sourceforge.net/ SilverCity] and/or
    … …  
    121121   an internal time zone implementation.
    122122
    123 '''Attention''': The various available versions of these dependencies are not necessarily interchangable, so please pay attention to the version numbers above. If you are having trouble getting Trac to work please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel].
     123'''Attention''': The various available versions of these dependencies are not necessarily interchangeable, so please pay attention to the version numbers above. If you are having trouble getting Trac to work please double-check all the dependencies before asking for help on the [trac:MailingList] or [trac:IrcChannel].
    124124
    125125Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [trac:TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there ''probably concern older versions of Trac than the one you're installing'' (there are even some pages that are still talking about Trac 0.8!).
    … …  
    147147=== Using `pip`
    148148'pip' is an easy_install replacement that is very useful to quickly install python packages.
    149 To get a trac installation up and running in less than 5 minutes:
     149To get a Trac installation up and running in less than 5 minutes:
    150150
    151151Assuming you want to have your entire pip installation in `/opt/user/trac`
    … …  
    161161}}}
    162162
    163 '''This code does not work anymore in pip 1.1 which dropped the -E option. Can someone update it?'''
    164 
    165 Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
     163'''This code does no longer work in pip 1.1 which dropped the -E option. Can someone update it?'''
     164
     165Make sure your OS specific headers are available for pip to automatically build PostgreSQL (`libpq-dev`) or MySQL (`libmysqlclient-dev`) bindings.
    166166
    167167pip will automatically resolve all dependencies (like Genshi, pygments, etc.) and download the latest packages on pypi.python.org and create a self contained installation in `/opt/user/trac`.
    … …  
    169169All commands (`tracd`, `trac-admin`) are available in `/opt/user/trac/bin`. This can also be leveraged for `mod_python` (using `PythonHandler` directive) and `mod_wsgi` (using `WSGIDaemonProcess` directive)
    170170
    171 Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
     171Additionally, you can install several Trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
    172172
    173173
    … …  
    176176Of course, using the python-typical setup at the top of the source directory also works.
    177177
    178 You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. Trac-1.0.tar.gz), or you can get the source directly from the repository (see Trac:SubversionRepository for details).
     178You can obtain the source for a .tar.gz or .zip file corresponding to a release (e.g. `Trac-1.0.tar.gz`), or you can get the source directly from the repository (see Trac:SubversionRepository for details).
    179179
    180180{{{
    … …  
    184184''You'll need root permissions or equivalent for this step.''
    185185
    186 This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
    187 of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.
     186This will byte-compile the Python source code and install it as an .egg file or folder in the `site-packages` directory
     187of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as `htdocs` and `templates`.
    188188
    189189The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments], as well as the [wiki:TracStandalone tracd] standalone server.
    190190
    191 If you install from source and want to make Trac available in other languages, make sure  Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed):
     191If you install from source and want to make Trac available in other languages, make sure Babel is installed. Only then, perform the `install` (or simply redo the `install` once again afterwards if you realize Babel was not yet installed):
    192192{{{
    193193$ python ./setup.py install
    194194}}}
    195 Alternatively, you can do a `bdist_egg` and copy the .egg from dist/ to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
     195Alternatively, you can run `bdist_egg` and copy the .egg from `dist/` to the place of your choice, or you can create a Windows installer (`bdist_wininst`).
    196196
    197197=== Advanced Options ===
    … …  
    202202}}}
    203203
    204 Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.
     204Also see [http://docs.python.org/2/install/index.html Installing Python Modules] for detailed information.
    205205
    206206Specifically, you might be interested in:
    … …  
    208208easy_install --prefix=/path/to/installdir
    209209}}}
    210 or, if installing Trac to a Mac OS X system:
     210or, if installing Trac on a Mac OS X system:
    211211{{{
    212212easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
    213213}}}
    214 Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default
     214Note: If installing on Mac OS X 10.6 running {{{ easy_install http://svn.edgewall.org/repos/trac/trunk }}} will install into {{{ /usr/local }}} and {{{ /Library/Python/2.6/site-packages }}} by default.
    215215
    216216The above will place your `tracd` and `trac-admin` commands into `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.5/site-packages`, which is Apple's preferred location for third-party Python application installations.
    … …  
    231231For the other [DatabaseBackend database backends] you should plan ahead and already have a database ready to use at this point.
    232232
    233 Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterward, or the version control support can be disabled completely if you don't need it.
     233Since 0.12, Trac doesn't ask for a [TracEnvironment#SourceCodeRepository source code repository] anymore when creating an environment. Repositories can be [TracRepositoryAdmin added] afterwards, or the version control support can be disabled completely if you don't need it.
    234234
    235235Also note that the values you specify here can be changed later by directly editing the [TracIni conf/trac.ini] configuration file.
    … …  
    237237Finally, make sure the user account under which the web front-end runs will have '''write permissions''' to the environment directory and all the files inside. This will be the case if you run `trac-admin ... initenv` as this user. If not, you should set the correct user afterwards. For example on Linux, with the web server running as user `apache` and group `apache`, enter:
    238238{{{
    239 # chown -R apache.apache /path/to/myproject
     239$ chown -R apache.apache /path/to/myproject
    240240}}}
    241241
    … …  
    351351==== Setting up the Plugin Cache ====
    352352
    353 Some 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.
     353Some 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.
    354354
    355355== Configuring Authentication ==
    356356
    357 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.
     357Trac 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.
    358358
    359359The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac.
    … …  
    369369$ trac-admin /path/to/myproject permission add admin TRAC_ADMIN
    370370}}}
    371 This user will have an "Admin" entry menu that will allow you to admin your trac project.
     371This user will have an "Admin" entry menu that will allow you to administrate your Trac project.
    372372
    373373== Finishing the install