Difference between revisions of "Trac"

From OSGeo
Jump to: navigation, search
(remove upgrade plan as it is complete and then some.)
 
(65 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
= Summary =  
 
= Summary =  
  
Trac 0.11.7 is running at http://trac.osgeo.org/ (the tracsvn VM at OSU OSL).
+
October 12, 2018 tracvm was migrated to lxd container called tracsvn on osgeo7
 +
As of February 2017 Trac 1.2.1dev (r15513 [https://trac.osgeo.org/osgeo/ticket/1863#comment:3 patched]) is running at http://trac.osgeo.org/ (the [[TracsvnVM|tracsvn VM]] at OSU OSL).
  
 
* [http://trac.edgewall.org/wiki/TracGuide Trac Guide]
 
* [http://trac.edgewall.org/wiki/TracGuide Trac Guide]
* All data and configurations live under /var/www/trac
+
* Configurations are in /var/www/trac/*/conf/trac.ini and inherit /etc/trac/trac-common.ini
* virtual server configurations are under /etc/httpd/conf.d/trac
+
* All data lives under /var/www/trac and in trac_* PostgreSQL databases
 +
* Authentication uses the OSGeo [[SAC:LDAP|LDAP]] database
 +
* virtual server configurations are under /etc/apache2/includes/trac/*.conf, included by /etc/apache2/sites-available/trac.conf
 
* [http://trac.osgeo.org/ Existing Instances]
 
* [http://trac.osgeo.org/ Existing Instances]
* Actual python is installed in /usr/lib/python2.3/site-packages/trac
+
* Actual python is installed in /usr/local/lib/python2.6/dist-packages/Trac*.egg (May 2015)
 
* Frank Warmerdam and Howard Butler have configuration experience, and can help maintain instances.
 
* Frank Warmerdam and Howard Butler have configuration experience, and can help maintain instances.
* available plugins:
+
* Sandro Santilli is helping with trac since late 2015, driving the upgrade from 1.0.5 to 1.2.1dev in Feb 2017
** [http://trac-hacks.org/wiki/TocMacro TOC] - multi page tables of contents.
+
** MediaWikiMacro - provides media wiki like format support (link? details?
+
** [http://trac-hacks.org/wiki/DoxygenPlugin TracDoxygen] - mix doxygen docs into trac interface (needs extra admin support)
+
** SecureTickets - The authz policy mechanism provides fine-grained permissions for tickets.
+
  
 
= Procedures =  
 
= Procedures =  
Line 19: Line 18:
 
== Local Customizations ==  
 
== Local Customizations ==  
  
The file /usr/lib/python2.3/site-packages/trac/notification.py was substantially modified to support looking up email addresses in LDAP, and will need to be re-adjusted if we upgrade to a new version of Trac.
+
As of 2017-02-01, after upgrading to Trac-1.2.1, there is a minor modifications
 +
to allow notifying OSGeo users who have never logged into trac yet.
  
* http://trac.osgeo.org/osgeo/ticket/39
+
See https://trac.osgeo.org/osgeo/ticket/1863
  
 
== Creating a trac instance ==
 
== Creating a trac instance ==
  
   $ sudo createdb -U postgres trac_<proj_name>
+
   $ sudo -u postgres createdb -O trac trac_<proj_name>
   $ sudo trac-admin /var/www/trac/<proj_name> initenv
+
   $ sudo trac-admin \
 +
    /var/www/trac/env/<proj_name> initenv \
 +
    --inherit=/etc/trac/trac-common.ini
  
* Make sure to set the db connection to postgres://postgres@/trac_<proj_name>
+
* Make sure to set the db connection to postgres://trac@/trac_<proj_name> (password for the user is kept in ~www-data/.pgpass)
* Use /var/www/svn/repos/<proj_name> for the svn path
+
* Use /var/www/svn/repos/<proj_name> for the svn path or /var/www/git/repos/<proj_name> for the git path
 +
* For SVN, write a /var/www/repos/<proj_name>/post-commit with this content:
 +
 
 +
  REPOS="$1"
 +
  REV="$2"
 +
  TRAC_ENV=`basename ${REPOS}`
 +
  /var/www/svn/hookscripts/osgeo-post-commit-hook "${TRAC_ENV}" "${REPOS}" "${REV}" &
 +
 
 +
* Set the project admin user:
  
 
   $ sudo trac-admin /var/www/trac/<proj_name> permission add <osgeo_userid> TRAC_ADMIN
 
   $ sudo trac-admin /var/www/trac/<proj_name> permission add <osgeo_userid> TRAC_ADMIN
 +
 +
* Set permissions on the trac environment dir:
 +
 
   $ sudo chown -R www-data:www-data /var/www/trac/<proj_name>
 
   $ sudo chown -R www-data:www-data /var/www/trac/<proj_name>
  
* Update /var/www/trac//<proj_name>/conf/trac.ini to enable email notification.
+
* Update /var/www/trac/<proj_name>/conf/trac.ini to enable email notification (TODO: move to /etc/trac/trac-common.ini)
 
* Add virtual host file /etc/apache2/conf.d/trac/<proj_name>.conf enabling LDAP based authentication.  
 
* Add virtual host file /etc/apache2/conf.d/trac/<proj_name>.conf enabling LDAP based authentication.  
 
* Logo can be referenced in /var/www/trac/<proj_name>/conf/trac.ini and placed in /var/www/trac/<proj_name>/htdocs
 
* Logo can be referenced in /var/www/trac/<proj_name>/conf/trac.ini and placed in /var/www/trac/<proj_name>/htdocs
* modify webadmin.* setting in trac.ini to enabled for web based administration.
 
 
* Add to /var/www/trac/index.html
 
* Add to /var/www/trac/index.html
 +
* Add to /var/www/trac/trac_instances.txt
 +
* Add to /etc/trac/intertrac.ini
 
* Regenerate the robots.txt file with the command:
 
* Regenerate the robots.txt file with the command:
  
 
   $ sudo /var/www/trac/mkrobots.sh
 
   $ sudo /var/www/trac/mkrobots.sh
 +
 +
=== Permissions ===
  
 
Recommended Trac permissions:
 
Recommended Trac permissions:
Line 68: Line 84:
 
         warmerdam      developers
 
         warmerdam      developers
 
         warmerdam      TRAC_ADMIN
 
         warmerdam      TRAC_ADMIN
 +
        strk            TRAC_ADMIN
 
         ...
 
         ...
  
Line 73: Line 90:
  
 
You will have to modify the SQL statement of the ''All Ticket by Milestone'' report. This can be done by accessing the trac report page and click the ''Edit report'' button (You need to be an admin of the trac instance). Check the sql statement of another trac instance and replace the one of the new instance.
 
You will have to modify the SQL statement of the ''All Ticket by Milestone'' report. This can be done by accessing the trac report page and click the ''Edit report'' button (You need to be an admin of the trac instance). Check the sql statement of another trac instance and replace the one of the new instance.
 +
 +
[https://trac.edgewall.org/wiki/TracPermissions Permissions Reference]
  
 
== Plugins ==
 
== Plugins ==
  
Installed plugins (do in every trac instance, [http://trac.edgewall.org/wiki/TracPlugins installation guide]):
+
Shared plugins are installed in /usr/local/lib/python2.6/dist-packages/ (usually having a name starting with "Trac") and need be explicitly enabled for each project (can be done by trac admin).
  
* http://trac-hacks.org/wiki/TocMacro
+
Project specific plugins (discouraged) are under /var/www/trac/<project>/plugins/ and are enabled by default.
  
== Custom fields ==
+
For more info see the [http://trac.edgewall.org/wiki/TracPlugins plugin install guide].
 +
 
 +
Available shared plugins (updated May '16):
 +
 
 +
 
 +
* [https://git.osgeo.org/gogs/sac/TracLDAPEmailResolverPlugin TracLDAPEmailResolverPlugin] <sub>0.1</sub> - uses LDAP lookup to resolve OSGeo users email. '''WORKS with Trac 1.2'''
 +
* [https://trac-hacks.org/wiki/TracStatsPlugin TracStatsPlugin] <sub>0.6</sub> - shows project statistics. '''WORKS with Trac 1.2'''
 +
* [https://trac.edgewall.org/wiki/SpamFilter TracSpamFilter] <sub>1.0.10dev</sub> - spam filtering plugin. '''WORKS with Trac 1.2'''
 +
* [http://trac-hacks.org/wiki/DoxygenPlugin TracDoxygen] <sub>0.11.0</sub> - mix doxygen docs into trac interface (needs extra admin support). . '''WORKS with Trac 1.2'''
 +
* [https://trac-hacks.org/wiki/SectionEditPlugin TracSectionEditPlugin] <sub>1.2.0dev</sub> - ability to edit one section in a wiki page. '''WORKS with Trac 1.2'''
 +
* [http://trac-hacks.org/wiki/TocMacro TracTocMacro] <sub>11.0.0.6</sub> - multi page tables of contents. '''WORKS with Trac 1.2'''
 +
* <strike>[http://trac-hacks.org/wiki/SecureTicketsPlugin TracSecureTickets] <sub>0.1.4</sub> - The authz policy mechanism provides fine-grained permissions for tickets.</strike> '''REMOVED in Jan 2017'''
 +
* <strike>[https://trac-hacks.org/wiki/TracTicketStatsPlugin Tracticketsstats] <sub>3.0.0dev</sub> - visualizes trac ticket statistics</strike> '''REMOVED in Jan 2017'''
 +
* <strike>[https://trac-hacks.org/wiki/AdvParseArgsPlugin TracAdvParseArgsPlugin] <sub>1.0.5</sub> - dependency of TicketStatsMacro</strike> '''REMOVED in Jan 2017'''
 +
* <strike>sensitivetickets 0.22 (deprecated by SecureTicketsPlugin ?)</strike> '''REMOVED in Jan 2017'''
 +
* <strike>MediaWikiMacro - provides media wiki like format support (link? details?)</strike> '''NOT FOUND as of Nov 2015'''
 +
* <strike>[https://trac-hacks.org/wiki/TracMetrixPlugin TracMetrixPlugin] <sub>0.1.8dev</sub> - quality metrix and progress statistics.</strike> '''REMOVED in Jan 2017 as it FAILED with Trac 1.2 - https://trac-hacks.org/ticket/13041'''
 +
 
 +
=== Custom fields ===
  
 
See http://trac.edgewall.org/wiki/TracTicketsCustomFields
 
See http://trac.edgewall.org/wiki/TracTicketsCustomFields
Line 97: Line 134:
 
     cpu.value = Unspecified
 
     cpu.value = Unspecified
  
 +
=== ZIP support for directories ===
  
== Secure Tickets ==
+
Docs: https://trac.edgewall.org/wiki/TracIni#browser-section
  
See http://trac-hacks.org/wiki/SecureTicketsPlugin (Note that the installed plugin has been modified for OSGeo)
+
Used in GRASS GIS trac instance to enable zip download support for [https://grass.osgeo.org/grass72/manuals/g.extension.html g.extension] addon manager downloads:
 +
Directories are to be enabled as a comma separated list.
  
The initial behavior of the plugin was to set all tickets private, then let the user
+
<pre>
defines what are the public components. It has been modified this to fit osgeo needs.  
+
# file: /var/www/trac/grass/conf/trac.ini
Since everything is public by default, we'll set manually the private
+
[browser]
components and everything else will be public.
+
downloadable_paths = /grass-addons/grass7/*/*,/sandbox/*/*
 +
</pre>
  
'''Using the plugin'''
+
== Making Trac Read-Only ==
  
1- Enable the plugin in trac.ini:
+
It appears the usual way of making Trac read-only is to remove all permissions on the "authenticated" group in the Admin/Permissions dialog. This will remove the authenticated group and then only those with special admin priviledges can edit the wiki, create tickets, etc.
 
+
  [components]
+
  securetickets.* = enabled
+
 
+
2- Modify the permission_policies in trac.ini:
+
 
+
  permission_policies = SecureTicketsPolicy, DefaultPermissionPolicy, ...
+
 
+
3- Define private components in trac.ini:
+
 
+
  [securetickets]
+
  private_components = Vulnerabilities, Component2, ...
+
 
+
To allow a user or a group to view the private tickets, you'll have to add him
+
the permission SECURE_TICKET_VIEW
+
  
 
== Timeline with filename indication ==
 
== Timeline with filename indication ==
Line 145: Line 170:
 
We have had problems with trac spam when ticket create and ticket modify permissions were set to anonymous (the default).  To get around this most (all?) instances have been changed to require authenticated users to do these actions.  
 
We have had problems with trac spam when ticket create and ticket modify permissions were set to anonymous (the default).  To get around this most (all?) instances have been changed to require authenticated users to do these actions.  
  
But some projects strongly desire to support anonymous ticket creation and modification and at some point this might be viable using image captcha technology to keep out the spammers.  A Trac plugin for this is apparently under development, and described at:
+
But some projects strongly desire to support anonymous ticket creation and modification and at some point this might be viable using image captcha technology to keep out the spammers.  A Trac plugin for this is currently installed, see [https://trac.edgewall.org/wiki/SpamFilter SpamFilter] for usage.
 +
 
 +
== SpamFilter management ==
 +
 
 +
The bare minimum that each instance admin should take care of:
 +
 
 +
* Edit of a BadContent page, made read-only, for example: https://trac.osgeo.org/XXXX/wiki/BadContent
 +
* Frequently check the monitoring page training bayes for ham/spam: https://trac.osgeo.org/XXXX/admin/spamfilter/monitor
 +
 
 +
A global SpamFilter configuration is used unless any instance admin changed the configuration via the GUI ("Apply Changes").
 +
The global configuration (in /etc/trac/spamfilter.ini) sets, other than the defaults:
 +
 
 +
* SessionFilterStrategy: 0
 +
* Karma of authenticated users: 0
 +
 
  
http://trac.edgewall.org/browser/sandbox/spam-filter-captcha
+
Instructions to delete a spam user from LDAP: see [[SAC:LDAP#Editing_the_LDAP_database]]
  
 
= Trac notification forward to project mailing list =  
 
= Trac notification forward to project mailing list =  
Line 166: Line 205:
  
 
[[Category:Infrastructure]]
 
[[Category:Infrastructure]]
 +
[[Category:Services]]

Latest revision as of 23:35, 11 October 2019

Summary

October 12, 2018 tracvm was migrated to lxd container called tracsvn on osgeo7 As of February 2017 Trac 1.2.1dev (r15513 patched) is running at http://trac.osgeo.org/ (the tracsvn VM at OSU OSL).

  • Trac Guide
  • Configurations are in /var/www/trac/*/conf/trac.ini and inherit /etc/trac/trac-common.ini
  • All data lives under /var/www/trac and in trac_* PostgreSQL databases
  • Authentication uses the OSGeo LDAP database
  • virtual server configurations are under /etc/apache2/includes/trac/*.conf, included by /etc/apache2/sites-available/trac.conf
  • Existing Instances
  • Actual python is installed in /usr/local/lib/python2.6/dist-packages/Trac*.egg (May 2015)
  • Frank Warmerdam and Howard Butler have configuration experience, and can help maintain instances.
  • Sandro Santilli is helping with trac since late 2015, driving the upgrade from 1.0.5 to 1.2.1dev in Feb 2017

Procedures

Local Customizations

As of 2017-02-01, after upgrading to Trac-1.2.1, there is a minor modifications to allow notifying OSGeo users who have never logged into trac yet.

See https://trac.osgeo.org/osgeo/ticket/1863

Creating a trac instance

  $ sudo -u postgres createdb -O trac trac_<proj_name>
  $ sudo trac-admin \
    /var/www/trac/env/<proj_name> initenv \
    --inherit=/etc/trac/trac-common.ini 
  • Make sure to set the db connection to postgres://trac@/trac_<proj_name> (password for the user is kept in ~www-data/.pgpass)
  • Use /var/www/svn/repos/<proj_name> for the svn path or /var/www/git/repos/<proj_name> for the git path
  • For SVN, write a /var/www/repos/<proj_name>/post-commit with this content:
 REPOS="$1"
 REV="$2"
 TRAC_ENV=`basename ${REPOS}`
 /var/www/svn/hookscripts/osgeo-post-commit-hook "${TRAC_ENV}" "${REPOS}" "${REV}" &
  • Set the project admin user:
  $ sudo trac-admin /var/www/trac/<proj_name> permission add <osgeo_userid> TRAC_ADMIN
  • Set permissions on the trac environment dir:
  $ sudo chown -R www-data:www-data /var/www/trac/<proj_name>
  • Update /var/www/trac/<proj_name>/conf/trac.ini to enable email notification (TODO: move to /etc/trac/trac-common.ini)
  • Add virtual host file /etc/apache2/conf.d/trac/<proj_name>.conf enabling LDAP based authentication.
  • Logo can be referenced in /var/www/trac/<proj_name>/conf/trac.ini and placed in /var/www/trac/<proj_name>/htdocs
  • Add to /var/www/trac/index.html
  • Add to /var/www/trac/trac_instances.txt
  • Add to /etc/trac/intertrac.ini
  • Regenerate the robots.txt file with the command:
 $ sudo /var/www/trac/mkrobots.sh

Permissions

Recommended Trac permissions:

       anonymous       BROWSER_VIEW
       anonymous       CHANGESET_VIEW
       anonymous       FILE_VIEW
       anonymous       LOG_VIEW
       anonymous       MILESTONE_VIEW
       anonymous       REPORT_SQL_VIEW
       anonymous       REPORT_VIEW
       anonymous       ROADMAP_VIEW
       anonymous       SEARCH_VIEW
       anonymous       TICKET_VIEW
       anonymous       TIMELINE_VIEW
       anonymous       WIKI_VIEW
       authenticated   TICKET_CHGPROP
       authenticated   TICKET_CREATE
       authenticated   TICKET_MODIFY
       authenticated   WIKI_CREATE
       authenticated   WIKI_MODIFY
       developers      DOXYGEN_VIEW
       developers      MILESTONE_ADMIN
       developers      REPORT_ADMIN
       developers      REPORT_CREATE
       developers      WIKI_ADMIN
       warmerdam       developers
       warmerdam       TRAC_ADMIN
       strk            TRAC_ADMIN
       ...

SQL Compatability Issue with Postgres

You will have to modify the SQL statement of the All Ticket by Milestone report. This can be done by accessing the trac report page and click the Edit report button (You need to be an admin of the trac instance). Check the sql statement of another trac instance and replace the one of the new instance.

Permissions Reference

Plugins

Shared plugins are installed in /usr/local/lib/python2.6/dist-packages/ (usually having a name starting with "Trac") and need be explicitly enabled for each project (can be done by trac admin).

Project specific plugins (discouraged) are under /var/www/trac/<project>/plugins/ and are enabled by default.

For more info see the plugin install guide.

Available shared plugins (updated May '16):


  • TracLDAPEmailResolverPlugin 0.1 - uses LDAP lookup to resolve OSGeo users email. WORKS with Trac 1.2
  • TracStatsPlugin 0.6 - shows project statistics. WORKS with Trac 1.2
  • TracSpamFilter 1.0.10dev - spam filtering plugin. WORKS with Trac 1.2
  • TracDoxygen 0.11.0 - mix doxygen docs into trac interface (needs extra admin support). . WORKS with Trac 1.2
  • TracSectionEditPlugin 1.2.0dev - ability to edit one section in a wiki page. WORKS with Trac 1.2
  • TracTocMacro 11.0.0.6 - multi page tables of contents. WORKS with Trac 1.2
  • TracSecureTickets 0.1.4 - The authz policy mechanism provides fine-grained permissions for tickets. REMOVED in Jan 2017
  • Tracticketsstats 3.0.0dev - visualizes trac ticket statistics REMOVED in Jan 2017
  • TracAdvParseArgsPlugin 1.0.5 - dependency of TicketStatsMacro REMOVED in Jan 2017
  • sensitivetickets 0.22 (deprecated by SecureTicketsPlugin ?) REMOVED in Jan 2017
  • MediaWikiMacro - provides media wiki like format support (link? details?) NOT FOUND as of Nov 2015
  • TracMetrixPlugin 0.1.8dev - quality metrix and progress statistics. REMOVED in Jan 2017 as it FAILED with Trac 1.2 - https://trac-hacks.org/ticket/13041

Custom fields

See http://trac.edgewall.org/wiki/TracTicketsCustomFields

for example, in trac.ini:

    [ticket-custom]
    platform = select
    platform.label = Platform
    platform.options = Unspecified|MSWindows 2K|MSWindows XP|MSWindows Vista|MSWindows CygWin|MacOSX|Linux|Other Unix|All
    platform.value = Unspecified
    cpu = select
    cpu.label = CPU
    cpu.options = Unspecified|x86-32|x86-64|OSX/PPC|OSX/Intel|Other|All
    cpu.value = Unspecified

ZIP support for directories

Docs: https://trac.edgewall.org/wiki/TracIni#browser-section

Used in GRASS GIS trac instance to enable zip download support for g.extension addon manager downloads: Directories are to be enabled as a comma separated list.

# file: /var/www/trac/grass/conf/trac.ini
[browser]
downloadable_paths = /grass-addons/grass7/*/*,/sandbox/*/*

Making Trac Read-Only

It appears the usual way of making Trac read-only is to remove all permissions on the "authenticated" group in the Admin/Permissions dialog. This will remove the authenticated group and then only those with special admin priviledges can edit the wiki, create tickets, etc.

Timeline with filename indication

 [timeline]
 changeset_long_messages = false
 changeset_show_files = 1
 changeset_files_count = 3
 default_daysback = 30
 ticket_show_details = false

(see for example here)

Hotcopy a trac instance

  $ sudo trac-admin /var/www/html/trac/<proj_name> hotcopy /path/to/copy/trac/to

Trac Spam

We have had problems with trac spam when ticket create and ticket modify permissions were set to anonymous (the default). To get around this most (all?) instances have been changed to require authenticated users to do these actions.

But some projects strongly desire to support anonymous ticket creation and modification and at some point this might be viable using image captcha technology to keep out the spammers. A Trac plugin for this is currently installed, see SpamFilter for usage.

SpamFilter management

The bare minimum that each instance admin should take care of:

A global SpamFilter configuration is used unless any instance admin changed the configuration via the GUI ("Apply Changes"). The global configuration (in /etc/trac/spamfilter.ini) sets, other than the defaults:

  • SessionFilterStrategy: 0
  • Karma of authenticated users: 0


Instructions to delete a spam user from LDAP: see SAC:LDAP#Editing_the_LDAP_database

Trac notification forward to project mailing list

To fwd notifications from trac to e.g. a project developers mailing list, you need to

  • set in trac the mailing list address as default (trac Admin section)
  • add the trac@osgeo.org address (or trac_osgeo@.., or ...) in Mailman to
    • "Privacy options"
      • "Subscription rules"
      • "[Sender filters]"
        • "Non-member filters"
          • "List of non-member addresses whose postings should be automatically accepted."
  • As the mail may be addressed to "undisclosed recipients" instead of directly to the list, the messages may be held for moderator approval. To avoid this add "undisclosed recipients" to the list of acceptable aliases at
    • "Privacy options"
      • "[Recipient filters]"
        • acceptable_aliases