Commits

Christian Boos  committed 2e662e9

TracGuide: updated from t.e.o's content, as of today.

  • Participants
  • Parent commits e853c9b
  • Branches trunk

Comments (0)

Files changed (10)

File trac/wiki/default-pages/TracFineGrainedPermissions

 
  - Install [http://www.voidspace.org.uk/python/configobj.html ConfigObj] (required).
  - Copy authz_policy.py into your plugins directory.
- - Put a [http://swapoff.org/files/authzpolicy.conf authzpolicy.conf] file somewhere (preferably on a secured location on the server, not readable for others than the webuser.
+ - Put a [http://swapoff.org/files/authzpolicy.conf authzpolicy.conf] file somewhere, preferably on a secured location on the server, not readable for others than the webuser. If the  file contains non-ASCII characters, the UTF-8 encoding should be used.
  - Update your `trac.ini`:
    1. modify the [TracIni#trac-section permission_policies] entry in the `[trac]` section
 {{{
 Don't forget to restart Trac engine to apply new configuration if you are running tracd standalone server.
 
 ----
-See also: TracPermissions
-http://trac-hacks.org/wiki/FineGrainedPageAuthzEditorPlugin for a simple editor plugin.
+See also: TracPermissions,
+[http://trac-hacks.org/wiki/FineGrainedPageAuthzEditorPlugin TracHacks:FineGrainedPageAuthzEditorPlugin] for a simple editor plugin.

File trac/wiki/default-pages/TracInstall

 {{{
-#!div style="margin-top: .5em; padding: 0 1em; background-color: #ffd; border:1px outset #ddc;"
+#!div style="margin-top: .5em; padding: 0 1em; background-color: #ffd; border:1px outset #ddc; text-align: center"
 
-  '''NOTE: this page is for 0.12dev (trunk), the version currently in development. For installing previous Trac versions, please refer to [[0.11/TracInstall]]'''
+  '''NOTE: this page is for 0.12dev (trunk), the version soon to be released. \\
+  For installing previous Trac versions, please refer to [[0.11/TracInstall]]'''
 }}}
 = Trac Installation Guide for 0.12dev = 
 [[TracGuideToc]]
  * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi)
  * an [http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html AJP]-capable web
    server (see [trac:TracOnWindowsIisAjp TracOnWindowsIisAjp])
- * A CGI-capable web server (see TracCgi), '''but usage of Trac as a cgi script 
-   is highly discouraged''', better use one of the following options, 
+ * 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. 
    
 
 ==== Other Python Packages ====
    Note that in this case you won't have the possibility to run a localized version of Trac;
    either use a released version or install from source 
 
+=== Using `pip`
+'pip' is an easy_install replacement that is very useful to quickly install python packages.
+To get a trac installation up and running in less than 5 minutes:
+
+Assuming you want to have your entire pip installation in /opt/user/trac
+
+ - 
+{{{
+pip -E /opt/user/trac install trac psycopg2 
+}}}
+or
+ - 
+{{{
+pip -E /opt/user/trac install trac mysql-python 
+}}}
+
+Make sure your OS specific headers are available for pip to automatically build PostgreSQL (libpq-dev) or MySQL (libmysqlclient-dev) bindings.
+
+pip 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 
+
+All 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)
+
+Additionally, you can install several trac plugins (listed [http://pypi.python.org/pypi?:action=search&term=trac&submit=search here]) through pip.
+
+
+
 === From source
 Of course, using the python-typical setup at the top of the source directory also works.
 
 
 The 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.
 
-If you install from source and want to make Trac available in other languages, make sure you have installed Babel and then run this additional step before doing the `install` (or simply redo the `install` afterwards):
+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):
 {{{
-$ python ./setup.py compile_catalog -f
+$ python ./setup.py install
 }}}
-(the `-f` flag is needed as long as some translations are marked ''fuzzy'', i.e. incomplete, which will most probably be the case during the whole development period, as  strings are continuously added or modified)
-
+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`).
 
 === Advanced Options ===
 

File trac/wiki/default-pages/TracInterfaceCustomization

 icon = /favicon.ico
 }}}
 
+Should your browser have issues with your favicon showing up in the address bar, you may put a "?" (less the quotation marks) after your favicon file extension. 
+
+{{{
+[project]
+icon = /favicon.ico?
+}}}
+
 == Custom Navigation Entries ==
 The new [mainnav] and [metanav] can now be used to customize the text and link used for the navigation items, or even to disable them (but not for adding new ones).
 

File trac/wiki/default-pages/TracModPython

 
 Using <Location /> together with `SetHandler` resulted in having everything handled by mod_python, which leads to not being able download any CSS or images/icons. I used <Location /trac> `SetHandler None` </Location> to circumvent the problem, though I do not know if this is the most elegant solution.
 
+=== Problem with zipped egg ===
+
+It's possible that your version of mod_python will not import modules from zipped eggs. If you encounter an `ImportError: No module named trac` in your Apache logs but you think everything is where it should be, this might be your problem. Look in your site-packages directory; if the Trac module appears as a ''file'' rather than a ''directory'', then this might be your problem. To rectify, try installing Trac using the `--always-unzip` option, like this:
+
+{{{
+easy_install --always-unzip Trac-0.12b1.zip
+}}}
+
 === Using .htaccess ===
 
 Although it may seem trivial to rewrite the above configuration as a directory in your document root with a `.htaccess` file, this does not work. Apache will append a "/" to any Trac URLs, which interferes with its correct operation.

File trac/wiki/default-pages/TracPermissions

 || `TICKET_MODIFY` || Includes both `TICKET_APPEND` and `TICKET_CHGPROP`, and in addition allows resolving [wiki:TracTickets tickets]. Tickets can be assigned to users through a [TracTickets#Assign-toasDrop-DownList drop-down list] when the list of possible owners has been restricted. ||
 || `TICKET_EDIT_CC` || Full modify cc field ||
 || `TICKET_EDIT_DESCRIPTION` || Modify description field ||
+|| `TICKET_EDIT_COMMENT` || Modify comments ||
 || `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments and modification of the reporter and description fields. It also allows managing ticket properties in the WebAdmin panel. ||
 
 Attention: the "view tickets" button appears with the `REPORT_VIEW` permission.

File trac/wiki/default-pages/TracQuery

 || '''`!^=`''' || the field content does not start with any of the values ||
 || '''`!$=`''' || the field content does not end with any of the values ||
 
-The date fields `created` and `modified` can be constrained by using the `=` operator and specifying a value containing two dates separated by a semicolon (`;`). Either end of the date range can be left empty, meaning that the corresponding end of the range is open. The date parser understands a few natural date specifications like "3 weeks ago", "last month" and "now", as well as Bugzilla-style date specifications like "1d", "2w", "3m" or "4y" for 1 day, 2 weeks, 3 months and 4 years, respectively. Spaces in date specifications can be left out to avoid having to quote the query string. 
-|| '''`created=2007-01-01;2008-01-01`''' || query tickets created in 2007 ||
-|| '''`created=lastmonth;thismonth`''' || query tickets created during the previous month ||
-|| '''`modified=1weekago;`''' || query tickets that have been modified in the last week ||
-|| '''`modified=;30daysago`''' || query tickets that have been inactive for the last 30 days ||
+The date fields `created` and `modified` can be constrained by using the `=` operator and specifying a value containing two dates separated by two dots (`..`). Either end of the date range can be left empty, meaning that the corresponding end of the range is open. The date parser understands a few natural date specifications like "3 weeks ago", "last month" and "now", as well as Bugzilla-style date specifications like "1d", "2w", "3m" or "4y" for 1 day, 2 weeks, 3 months and 4 years, respectively. Spaces in date specifications can be left out to avoid having to quote the query string. 
+|| '''`created=2007-01-01..2008-01-01`''' || query tickets created in 2007 ||
+|| '''`created=lastmonth..thismonth`''' || query tickets created during the previous month ||
+|| '''`modified=1weekago..`''' || query tickets that have been modified in the last week ||
+|| '''`modified=..30daysago`''' || query tickets that have been inactive for the last 30 days ||
 
 ----
 See also: TracTickets, TracReports, TracGuide

File trac/wiki/default-pages/TracStandalone

 To create a .htpasswd file using htpasswd:
 
 {{{
- $ sudo htpasswd -c /path/to/env/.htpasswd username
+ $ htpasswd -c /path/to/env/.htpasswd username
 }}}
 then for additional users:
 {{{
- $ sudo htpasswd /path/to/env/.htpasswd username2
+ $ htpasswd /path/to/env/.htpasswd username2
 }}}
 then for starting the tracd (on windows skip the "=" after --basic-auth):
 {{{
 where:
 
  * '''base_project_dir''': the base directory of the project specified as follows:
-   * when serving multiple projects: ''relative'' to the `project_bath`
+   * when serving multiple projects: ''relative'' to the `project_path`
    * when serving only a single project (`-s`): the name of the project directory
  Don't use an absolute path here as this won't work. ''Note:'' This parameter is case-sensitive even for environments on Windows.
  * '''password_file_path''': path to the password file

File trac/wiki/default-pages/TracSyntaxColoring

 
 ''[=#a2 (2)] since Silvercity 0.9.7 released on 2006-11-23
 
-''[=#a3 (3)] By default `.m` files are considered Objective-C files. In order to treat `.m` files as MATLAB files, add "text/x-matlab:m" to the "mime_map" setting in the [wiki:TracIni#mimeviewer-section "[mimeviewer] section of trac.ini"].
+''[=#a3 (3)] By default `.m` files are considered Objective-C files. In order to treat `.m` files as MATLAB files, add "text/matlab:m" to the "mime_map" setting in the [wiki:TracIni#mimeviewer-section "[mimeviewer] section of trac.ini"].
 
 == Extra Software ==
  * GNU Enscript -- http://directory.fsf.org/GNU/enscript.html

File trac/wiki/default-pages/TracTimeline

 a brief excerpt of the actual comment or text, if available.
 
 It is possible to filter the displayed events with the various filters in the option panel:
- * ''View changes from'' — the date from which to start displaying events. Events that occurred after this date will not be shown, only those that occurred before that date.
+ * ''View changes from'' — the date from which to start displaying events (current date if empty). Events that occurred after this date will not be shown, only those that occurred before that date.
  * ''and X days back'' — how many days backwards in time to get events.
  * ''done by'' — the author of an event. It accepts a space-separated list of authors for which events should be included. Alternatively, if the author names are prefixed by a "-" character, then the events having those authors will be excluded, and all the others included. Single or double quotes can be used for specifying author names containing space characters. ''(since 0.12)''
- * ''Changesets in all repositories'' — if you have more than one repository connected to your Trac project, then you can filter the output so events from specific repositories are not show. ''(since 0.12)''
+ * ''Changesets in all repositories'' — if you have more than one repository connected to your Trac project, then you can filter the output so events from specific repositories are not shown. ''(since 0.12)''
  * ''Milestones reached'' — display or hide milestones reached.
  * ''Opened and closed tickets'' — display or hide ticket open or close events.
  * ''Wiki changes'' — display or hide Wiki change events.

File trac/wiki/default-pages/TracUpgrade

 
 == Instructions ==
 
-Typically, there are five steps involved in upgrading to a newer version of Trac:
+Typically, there are seven steps involved in upgrading to a newer version of Trac:
 
 === 1. Update the Trac Code === #UpdatetheTracCode
 
 If you already have a 0.11 version of Trac installed via `easy_install`, it might be the easiest to use it also to upgrade you Trac installation.
 
 {{{
-# easy_install --upgrade Trac=0.12beta1
+# easy_install --upgrade Trac==0.12b1
 }}}
 (once beta1 is released, that is)
 
 Each [TracEnvironment Trac environment] must be resynchronized against the source code repository in order to avoid errors such as "[http://trac.edgewall.org/ticket/6120 No changeset ??? in the repository]" while browsing the source through the Trac interface:
 
 {{{
-trac-admin /path/to/projenv resync
+trac-admin /path/to/projenv repository resync '*'
 }}}
 
-=== 5. Steps specific to a given Trac version  ===
+=== 5. Refresh static resources ===
+
+If you've setup web server to give out static resources directly (accessed using /chrome/ URL) then you need to refresh them using the same command:
+{{{
+trac-admin /path/to/env deploy /deploy/path
+}}}
+this will extract static resources and CGI scripts (trac.wsgi, etc) from new Trac version and its plugins into `/deploy/path`.
+
+=== 6. Steps specific to a given Trac version  ===
 ==== Upgrading from Trac 0.11 to Trac 0.12 ====
 ===== Python 2.3 no longer supported =====
 The minimum supported version of python is now 2.4
 ===== Web Admin plugin integrated =====
 If you had the webadmin plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
 
-=== 6. Restart the Web Server === #RestarttheWebServer
+=== 7. Restart the Web Server === #RestarttheWebServer
 
 If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.