Yolinux.com Tutorial

Linux Subversion Server and Trac Server:

This tutorial covers the installation, configuration and administration of a Linux Subversion Server and Trac server.

Subversion is a Change Management (CM) system for software source code configuration control. It can also be applied to any other types of files or purpose (i.e. web site content version control) but is most noted for control of source code text files.

Trac is a software bug and enhancement tracking system. One first defines a development roadmap of milestones and then tickets are issued for bugs or new enhancements pertaining to mile-stones in the "roadmap". Bugs and enhancements are then assigned to developers. Trac also includes a Wiki to support collaborative development.

In This Tutorials

# Subversion Configuration

# Trac Configuration

# Host multiple repositories


Related YoLinux Tutorials:

°Subversion Commands

°Subversion Repository Transfer

°Git & Trac

°Trac Plugins

°Trac-agile: Agilo

°Trac wiki markup

°Jenkins Build Server

°Cabie Build System (and Subversion)

°Apache web server configuration

°Apache login authentication

°Trac / Git server

°Clearcase Commands

°Clearcase Client

°Clearcase Server

°Subversion vs Clearcase

°YoLinux Tutorials Index




Free Information Technology Magazines and Document Downloads
TradePub link image


Free Information Technology Software and Development Magazine Subscriptions and Document Downloads


Subversion server installation and Configuration:
Subversion logo

Subversion server configuration options:

  • svnserve: This is a simple stand-alone server which comes with the Subversion release.
  • svn+ssh: This is a simple stand-alone server which uses ssh security,
  • Apache httpd server with Subversion:
    • allows more integration with Apache infrastructure and other web applications
    • allows use of Apache authentication
    • allows web server viewing straight from the repository
    • ability to mount repository as a network share (WEBDAV capability offered through Apache)
This tutorial covers the Apache-Subversion installation and configuration for web browser and Subversion client access..

Subversion download options:

  • Use the version of Subversion which comes with your release of Linux:
    • Red Hat Enterprise Linux 6/CentOS 6 (Apache 2.2, Python 2.6, ...) - Subversion 1.6
    • Red Hat Enterprise Linux 5/CentOS 5 (Apache 2.2, Python 2.4, ...) - Subversion 1.4
    • Red Hat Enterprise Linux 4/CentOS 4 (Apache 2.0, Python 2.3, ...) - Subversion 1.1
  • Install or upgrade to the RepoForge RPM Subversion packages with recent and OS compatible versions. Support for the latest Subversion RPM releases with RHEL 4, 5 and 6.
  • Use the latest CollabNet bundled release of Apache, Subversion and ViewVC. Unfortuanetly this bundle includes a stripped down version of Apache without support for Perl modules, PHP, etc. This release is what is required to run a Subversion server and the ViewVC web front-end only. It even includes stripped down python support. I could not get this version to work with Apache authentication Perl modules or with Trac.
  • Use the "Summersoft" RPMs for RHEL 4 or 5: Subversion RPMs. Great for the latest releases of Subversion which will work with the releases of Apache, Python, etc which come bundled with the OS. Problems arise when trying to put the latest release of Subversion with dependencies on very current versions of framework applications onto an older version of the OS (i.e. installing SVN 1.6.9 on RHEL4). Great for use SVN 1.6.9 with OS RHEL5)
  • Download source and compile. Requires downloads of source and compilation of dependencies as well.
Download for leading versions of Linux, Unix and other OS support: Subversion.Apache.org Subversion downloads page [source]

This tutorial focuses on the version of Subversion which is released with the OS (RHEL4/5 and CentOS 4/5) or, compatible RepoForge or Summersoft RPM upgrades.


Red Hat Enterprise 6 with SVN 1.7.5: (RepoForge Subversion RPM upgrade. Default is SVN 1.6)

Red Hat Enterprise 5 with SVN 1.6.9: (Summersoft RPM upgrade. Default is SVN 1.4)
Download: (32 bit i386. 64 bit also available)

  • mod_dav_svn-1.6.9-1.i386.rpm
  • neon-0.28.4-1.i386.rpm (neon-devel-0.28.4-1.i386.rpm)
  • sqlite-3.5.9-2.i386.rpm (sqlite-devel-3.5.9-2.i386.rpm)
  • subversion-1.6.9-1.i386.rpm (subversion-devel-1.6.9-1.i386.rpm)
  • subversion-perl-1.6.9-1.i386.rpm
  • subversion-python-1.6.9-1.i386.rpm
  • subversion-tools-1.6.9-1.i386.rpm
    [Potential Pitfall]: You may get the following error:
       error: Failed dependencies:
            perl(File::Path) >= 1.0404 is needed by subversion-tools-1.6.9-1.i386
              
    RHEL 5 Perl includes File::Path version 1.08 but subversion-tools checks for 1.0404. The broken math test: is 8 > 404?
    Solution: Ignore the dependency: rpm -ivh --force --nodeps subversion-tools-1.6.9-1.i386.rpm
Installation:
  • rpm -Uvh sqlite-3.5.9-2.i386.rpm sqlite-devel-3.5.9-2.i386.rpm
  • rpm -ivh neon-0.28.4-1.i386.rpm neon-devel-0.28.4-1.i386.rpm
  • rpm -ivh subversion-1.6.9-1.i386.rpm subversion-devel-1.6.9-1.i386.rpm subversion-python-1.6.9-1.i386.rpm subversion-perl-1.6.9-1.i386.rpm mod_dav_svn-1.6.9-1.i386.rpm
Note:
  • The "devel" RPMs provide C language include files and libraries for open source development and are not required unless you plan to build an application which requires the "devel" RPMs.
  • May be required to remove existing SNV installation to avoid conflicts: rpm -e subversion subversion-devel

Red Hat Enterprise 4 with SVN 1.1.4: (RHEL4 default)
Install from RPM (RHEL4): rpm -ivh subversion-1.1.4-2.ent.i386.rpm

Red Hat Enterprise 4 with SVN 1.4.2: (Dag Wieers upgrade RPMs)
http://pkgs.repoforge.org/subversion/
Upgrade: rpm -Uvh subversion-tools-1.4.2-1.i386.rpm subversion-python-1.4.2-1.i386.rpm subversion-perl-1.4.2-1.i386.rpm subversion-1.4.2-1.i386.rpm mod_dav_svn-1.4.2-1.i386.rpm apr-0.9.12-1.i386.rpm apr-devel-0.9.12-1.i386.rpm apr-util-0.9.12-1.i386.rpm

Installation of Subversion 1.4.6 using RPMs from RepoForge on Red Hat Enterprise Linux 5 (or CentOS 5) is almost exactly the same.

Ubuntu: apt-get install subversion enscript libapache2-mod-python python-docutils db4.3-util libapache2-svn subversion-tools


Subversion Repository Creation:

There are two database options available for the Subversion repository creation.

  • FSFS:
  • Berkeley DB:
Discussion of differences and merits of FSFS vs Berkeley DB.

Create a Subversion repository using the FSFS database format: (as root)

  • mkdir /srv/svn/repos
  • svnadmin create --fs-type fsfs /srv/svn/repos
  • chown apache:apache -R /srv/svn/repos
    (The Apache web server running as user "apache" is the process owner which will be interfacing with the Subversion repository.)
  • SELinux security attribute assignment: (Red Hat EL4+, Fedora 3+)
    restorecon -R /srv/svn/repos
    or
    chcon -R -h -t httpd_sys_content_t /srv/svn/repos"
    Options:
    • -h: affect symbolic links instead of any referenced file
    • -t: set type TYPE in the target security context
    • -R: change files and directories recursively

    (Required for SELinux systems so that apache can write to this area or turn off SELinux. For more info see the YoLinux SysAdmin/SELinux tutorial)
This will create the default database files, configuration files and directory structure required to support Subversion. The choice of repository type is stored in /srv/svn/repository-name/db/fstype. In this case if you "cat" the file it will show "fsfs".


Apache Web Server Configuration for Subversion:

Subversion can be configured to use a local file system (NOT a network filesystem!!!), it's own server (svnserve) or use Apache and the webdav interface. This configuration shows the Subversion installation configured with Apache on Red Hat Enterprise 4 (RHEL4).

Subversion logo

+

Apache logo

Apache configuration file: /etc/httpd/conf.d/subversion.conf

  • This example performs no authentication:
    # Required for Apache interface
    LoadModule dav_svn_module     modules/mod_dav_svn.so
    
    # Required for "per-directory" access control
    LoadModule authz_svn_module   modules/mod_authz_svn.so
    
    # URL path in web browser after "http://yourdomain.com/": /svn
    <Location /svn>
       DAV svn
       # Local path on server filesystem: /srv/svn/repos
       SVNPath /srv/svn/repos
    </Location>
                    

  • This example authenticates to a local Apache user password file: User logins and passwords are specifically for the Apache server and have no connection to the system OS user accounts.
    LoadModule dav_svn_module     modules/mod_dav_svn.so
    LoadModule authz_svn_module   modules/mod_authz_svn.so
    <Location /svn>
       DAV svn
       SVNPath /srv/svn/repos
       AuthType Basic
       AuthName "Subversion Repository"
       AuthUserFile /etc/httpd/conf/userpw
       require valid-user                
    </Location>
                    
    Remove the line "require valid-user" to allow read-only access for unauthenticated users.

    For more on Apache user file authentication see:

  • This example authenticates logins with the NIS server. This requires the installation of perl modules Apache-AuthenNIS. See the YoLinux Apache NIS authentication tutorial (See this tutorial if running Apache httpd 2.2)
    LoadModule dav_svn_module     modules/mod_dav_svn.so
    LoadModule authz_svn_module   modules/mod_authz_svn.so
    <Location /svn>
       DAV svn
       SVNPath /srv/svn/repos
       AuthType Basic
       AuthName "Subversion Repository"
       PerlAuthenHandler Apache::AuthenNIS
       PerlSerVar AllowAlternateAuth no
       require valid-user
    </Location>
                    
    This example is for RHEL4 with Apache httpd 2.0.
See Subversion manual: authentication options for more information.

YoLinux.com Apache authentication tutorial - password file, NIS, LDAP, ...

Allow the web server to control content: chown -R apache:apache /srv/svn

Restart Apache: service httpd restart


Importing Directory of Files Into Subversion:

Subversion Repository on Server File system:

  • /srv/svn/repos

Import directory of files into Subversion:

  • Local directory to import into Subversion:
    • projectX/trunk/...source code goes here...
    • projectX/branches
    • projectX/tags
  • svn import -m "Initial Import" local-directory-projectX http://server-name/svn/projectX
    The import will create the new subdirectory branch "projectX" in the repository.

Alternate directory creation method: (repository exists but the directories need to be generated)

  • svn mkdir -m"Initial creation of trunk directory" http://svn-server/svn/projectX/trunk
  • svn mkdir -m"Initial creation of branches directory" http://svn-server/svn/projectX/branches
  • svn mkdir -m"Initial creation of tags directory" http://svn-server/svn/projectX/tags

Browser view of a typical repository directory schema:

  • http://svn-server/svn/projectX/trunk: For the "HEAD"
  • http://svn-server/svn/projectX/branches: For branches or "forks" in the code.
  • http://svn-server/svn/projectX/tags: For tags identifying snapshots of milestones or significant releases.


Explanation of Subversion directories:

  • /trunk : Contains the current development branch. New projects should be started here.
  • /branches : A branch is just a special copy of the source tree within Subversion that started with a specific revision of the code. A branch is created by using "svn copy" of the trunk to a branch i.e. /branch/name_of_branch_1.0.
  • /branches/personal : Personal branches are for doing some work which you don't want to have interfere with the main trunk until it is working or better defined.
  • /tags : This is a ethod of bookmarking or taking a "snapshot" of some work in progress.
  • /releases : This is similar to "tags" except that this version of the code makes it to production. Names used here should match product release names. i.e. version_1.1


Avoiding false diffs due to "^M" in a cross platform environment:

The Microsoft development tools love to add a "^M" at the end of the line of every file they edit. This breaks UNIX shell script and causes many file difference tools to show a difference in a line of code. This can be avoided in a cross platform environment by telling Subversion that certain files (or all files) that no "^M"'s should be appended at the end of a line. The trigger in fact removes the "^M" when the file is checked in. It can also be removed using the command dos2unix.

Import files to support no "^M" carriage returns at the end of lines:
(This sets file properties and creates a check-in trigger.)

  • Remove "^M" from files: find local-directory -name "*.cpp" -exec dos2unix {} \;
  • Upload directory of files into Subversion:
    svn import -m "Initial Import" local-directory http://server-name/svn/projectX
  • Checkout files from repository: svn co http://server-name/svn/projectX/trunk
    This creates your local working directory under Subversion control.
  • Set file properties such that "^M" are removed during check-in if added:
    find ./ -name "*.cpp" -exec svn propset svn:eol-style LF {} \;
  • Apply property changes to repository: svn ci -m "Apply LF properties" local-directory

Note that the "propset" command must be used for new files added to the Subversion repository if they are to have these properties.

Users can also set this option in the file: $HOME/.subversion/config

..
...

[auto-props]
README = svn:eol-style=native
INSTALL = svn:eol-style=native
*.c = svn:eol-style=LF
*.cpp = svn:eol-style=LF
*.h = svn:eol-style=LF
*.dsp = svn:eol-style=CRLF
*.dsw = svn:eol-style=CRLF
*.sh = svn:eol-style=native;svn:executable
*.txt = svn:eol-style=LF
*.png = svn:mime-type=image/png
*.jpg = svn:mime-type=image/jpeg
Makefile = svn:eol-style=LF
*.html = svn:eol-style=LF
*.css = svn:eol-style=LF
*.java = svn:eol-style=LF
*.xml = svn:eol-style=LF
*.m4 = svn:eol-style=LF
*.pdf = svn:mime-type=application/pdf

...
..


Subversion Repository Transfer:

Data repository dump:

  • Dump first entry to current:
    svnadmin dump /srv/svn/repos --revision 0:HEAD > repos.dump
  • Dump revision 625 to current:
    svnadmin dump /srv/svn/repos --revision 625:HEAD --incremental > repos-625.dump

Data repository load:

  • First load: svnadmin load /srv/svn/repos < repos.dump
  • Incremental load: svnadmin load /srv/svn/repos < repos-625.dump

For more complex transfers with path translation, see the YoLinux Subversion repository data transfer tutorials.


Subversion Repository Backups:

The following is a cron job to dump the repository to an ascii file as a backup:
File: /etc/cron.daily/CmSvnDump.sh
#!/bin/bash
#
umask 002
# Our backups go to a remote file server with a local mount point
cd /mnt/backup/CM

# ASCII dump of SVN repository:
/etc/init.d/httpd stop
/usr/bin/svnadmin dump /srv/svn/projectX --revision 0:HEAD > CmSvnDump-`date +%m%d%y`.dump
/etc/init.d/httpd start

# HotCopy SVN and Trac backups:
svnadmin hotcopy /srv/svn/projectX /tmp/bkup/svnprojectX
trac-admin /srv/trac/projectX hotcopy /tmp/bkup/tracprojectX

tar -cvzf /mnt/backup/CM/CmSvn-`date +%m%d%y`.tar.gz -C /tmp/bkup svnprojectX
tar -cvzf /mnt/backup/CM/CmTrac-`date +%m%d%y`.tar.gz -C /tmp/bkup tracprojectX

# Cleanup:
rm -Rf /tmp/bkup/svnprojectX /tmp/bkup/tracprojectX
SELinux requirement: chcon -u system_u -t bin_t CmSvnDump.sh
Also see the YoLinux.com cron sysadmin tutorial


Subversion XSLT:

The best presentation interface is "Insurrection" detailed below. For a quick and easy improvement to the Subversion web interface, use the XSLT/CSS files svnindex.xsl and svnindex.css, which comes with the "subversion-tools RPM".

Create path links:

  • ln -s /usr/lib/subversion/tools/xslt/svnindex.xsl /var/www/html/
  • ln -s /usr/lib/subversion/tools/xslt/svnindex.css /var/www/html/
or for the 64 bit Summersoft RPM releases:
  • ln -s /usr/lib64/subversion/tools/xslt/svnindex.xsl /var/www/html/
  • ln -s /usr/lib64/subversion/tools/xslt/svnindex.css /var/www/html/

Add the "SVNIndexXSLT" directive to the file /etc/httpd/conf.d/subversion.conf

LoadModule dav_svn_module     modules/mod_dav_svn.so
<Location /svn>  
   DAV svn
   SVNPath /srv/svn/repos  

   SVNIndexXSLT "/svnindex.xsl"
</Location>
                
The XSLT reference can also be a full URL: SVNIndexXSLT "http://yourdomain/path/svnindex.xsl"
Additional XSLT and CSS themes for Subversion are available from http://reposstyle.com/

[Potential Pitfall]: Some browsers, do not process XSLT. This will prohibit them from traversing directories which are rendered with XSLT.


Subversion Pitfalls:

Access Forbidden:
Subversion 1.6.x message:
[user1@server1]$ svn http://hostname/svn/projectX/demo1/
svn: Server sent unexpected return value (403 Forbidden) in response to OPTIONS request for 'http://hostname/svn/projectX/demo1/'
Subversion 1.7.4 message:
[user1@server1]$ svn http://hostname/svn/projectX/demo1/
svn: E175013: Unable to connect to a repository at URL 'http://hostname/svn/projectX/demo1/'
svn: E175013: Access to 'http://hostname/svn/projectX/demo1/' forbidden
This is a permissions problem caused by any number of issues.
Potential Causes:
  • If experiencing the problem on one system but not on another, then SVN us probably using cached credentials which are incorrect.
  • Make sure the user is authenticated and authorized. Is the ID in the list? SVN will use as a default your account login. Is that what was intended?
  • Try explicit user name / password:
    svn co --username svnuser --password supersec http://hostname/svn/projectX/demo1/
  • Try updating your client to be as new or newer than the version of Subversion used on your server.


Subversion Links:


Web Interface Front-ends to Subversion:

While Subversion has a native web interface it does not allow one to view anything but the "HEAD" or latest versions of the files stored. The following web front-ends to Subversion will allow one to view previous file revisions and even perform file comparisons between revisions. Insurrection seems to have a more elegant interface and structure but is more difficult to install and configure.


ViewVC:
ViewVC logo

ViewVC is a Python based web interface to Subversion available in an installable RPM package or can be installed from source.

Install RPM: rpm -ivh viewvc-1.0.5-1.el4.rf.noarch.rpm

Install from source:
  • Download from http://www.viewvc.org/download.html
  • tar xzf viewvc-1.1.2.tar.gz
  • cd viewvc-1.1.2/
  • ./viewvc-install
    Installation path [/usr/local/viewvc-1.1.2]: /opt/viewvc
  • cp /opt/viewvc/bin/cgi/viewvc.cgi /var/www/cgi-bin
  • cp /opt/viewvc/bin/cgi/query.cgi /var/www/cgi-bin
  • Edit /opt/viewvc/viewvc.conf
    (See example below)

Apache web server configuration file: /etc/httpd/conf.d/viewvc.conf

ScriptAlias /viewvc /var/www/cgi-bin/viewvc.cgi
ScriptAlias /query /var/www/cgi-bin/query.cgi
Alias /viewvc-static /var/www/viewvc
#
<Directory /var/www/viewvc>
        Allow from all
</Directory>

<Location /viewvc>
      AuthType Basic
      AuthName "Authorization Realm"
      PerlAuthenHandler Apache::AuthenNIS
      PerlSetVar AllowAlternateAuth no
      Require valid-user
</Location>

<Location /query>
      AuthType Basic
      AuthName "Authorization Realm"
      PerlAuthenHandler Apache::AuthenNIS
      PerlSetVar AllowAlternateAuth no
      Require valid-user
</Location>
File:
  • RPM install: /etc/viewvc/viewvc.conf
  • Installed from source: /opt/viewvc/viewvc.conf
[general]
svn_roots = projectX: /srv/svn/projectX,projectY: /srv/svn/projectY
default_root = projectX
Try it out: http://localhost/viewvc/


ViewVC, multiple SVN repositories and independent authentication:

Apache configuration file: /etc/httpd/conf.d/viewvc.conf

ScriptAlias /viewvc/ProjectX /var/www/cgi-bin/viewvc.cgi/ProjectX
ScriptAlias /viewvc/ProjectY /var/www/cgi-bin/viewvc.cgi/ProjectY
Alias /viewvc/docroot /opt/viewvc/templates/docroot

<Directory /opt/viewvc>
    Order allow,deny
    Allow from all
</Directory>

<Location /viewvc/ProjectX>
   --- authenticate  and authorize here ---
</Location>

<Location /viewvc/ProjectY>
   --- authenticate  and authorize here ---
</Location>
Also see the YoLinux Apache Authentication tutorial
ViewVC configuration file: /opt/viewcv/viewvc.conf
[general]
svn_roots = projectX: /srv/svn/projectX,projectY: /srv/svn/projectY

[options]
# If ViewVC is configured with multiple repositories, this results in 
# more natural looking ViewVC URLs.
root_as_url_component = 1

docroot = /viewvc/docroot

...
...
Partial listing of configuration file.

Links:


Insurrection Installation and Configuration:
Insurrection logo

Insurrection is a HTML, CSS and XSLT (and some perl) web presentation layer for Subversion. It creates a more functional and feature rich web interface to Subversion. It does not support Opera or browsers without XSLT support. Supports IE/Mozilla and Firefox.

Installation:

  • Download using Subversion: svn export http://svn.code-host.net/svn/Insurrection/trunk/
    This will download Insurrection to a local directory called "trunk".
    OR
  • insurrection-100906.tar.gz

Installation:

  • Move to web directory: mv trunk /var/www/Insurrection
  • Edit files:
    • insurrection.conf: Place this file in /etc/httpd/conf.d/
      This Apache configuration files needs to be edited to suit your installation. This example is set to replace your /etc/httpd/conf.d/subversion.conf file. Do not duplicate functionality in both.
    • insurrection.js: Edit SVN_URL per your Subversion repository.
    • insurrection.pl:
      Edit and set variables:
      • SVN_REPOSITORIES_URL
      • SVN_AUTH
      • SVN_BASE
  • Add a logo image file to your insurrection directory: /var/www/Insurrection/cm.megacorp.com.gif
    Note: This is required as the logic checks for the existence of this file to function properly. If using a port other than web port 80, (i.e. port 222) then specify the port: /var/www/Insurrection/cm.megacorp.com:222.gif
  • Edit the file /var/www/Insurrection/.htaccess for the gif logo path. May have to edit the SVN_URL location in insurrection.js. Comment out lines referencing ls.cgi in RewriteCond and RewriteRule.

Note that Insurrection's default configuration is set to use a virtual host or a dedicated server for Subversion. This is due to "DocumentRoot" being set to "/". If using a different Apache "DocumentRoot" configuration, edit the directory prefixes in insurrection.xsl.

Links:


StatSVN: Subversion repository statistics and analytics
StatSVN logo

StatSVN is a metrics-analysis tool which will provide web reporting and charting of lines of code (LOC), developer activity, file count, file size and project statistics based on Subversion repository activity.

Note that StatSVN requires Java. See the YoLinux.com Java installation tutorial.

Note that StatSVN version 0.4.1 is the last version which does not require an X-Window frame bufffer (thus easy to use with a cron or batch script).

Note: If using Jenkins for continuous build/integration, a better SLOC tool is SLOCCount integrated with the Jenkins SLOCCount plug-in. See the YoLinux.com Jenkins tutorial for more information.

Install and Configure:

  • Download the compressed compiled Java file statsvn-0.4.1.zip from sourceforge.
    wget http://prdownloads.sourceforge.net/statsvn/statsvn-0.4.1.zip
  • Decompress and extract contents of zip file: unzip statsvn-0.4.1.zip
  • Install Java program: mv statsvn-0.4.1/statsvn.jar /opt/bin/statsvn.jar

Configuring StatSVN as a cron job:

Create the following cron job script: /etc/cron.daily/StatSVN.sh
#!/bin/bash
#
# Generate the StatSVN web pages
#
if [ -d /usr/java/latest ]
then
   export PATH=/usr/java/latest/bin:$PATH
   export JAVA_HOME=/usr/java/latest
   export CLASSPATH=/usr/java/latest/lib/tools.jar:./
else
   exit
fi

# Update local Subversion repository
# Uncomment this line if this script is to update the local working Subversion repository.
# svn update /opt/Cabie/BUILDS/buildserver1/trunk

# Generate Subversion log file
svn log -v --xml /opt/Cabie/BUILDS/buildserver1/trunk >  \
                 /opt/Cabie/BUILDS/buildserver1/StatSVN/logfile.log

# Create web content here:
cd /opt/Cabie/BUILDS/buildserver1/StatSVN

# Generate web content
java -jar /opt/bin/statsvn.jar -viewvc http://cmserver.yourdomain.com/viewvc/ProjectX/trunk/application1/   \ 
                               -output-dir /opt/Cabie/BUILDS/buildserver1/StatSVN/html  \
                               /opt/Cabie/BUILDS/buildserver1/StatSVN/logfile.log  \
                               /opt/Cabie/BUILDS/buildserver1/ProjectX/trunk/application1/
                              
Specify the correct directory paths for your configuration:
  • Subversion local checkout directory: /opt/Cabie/BUILDS/buildserver1/trunk
    (Our is located on our Cabie build server. See the YoLinux Cabie tutorial.)
  • Path for Subversion metrics-analysis web pages created by StatSVN which is also accessible to the Apache web server: /opt/Cabie/BUILDS/buildserver1/StatSVN
  • Temporary log file: /opt/Cabie/BUILDS/buildserver1/StatSVN/logfile.log
    (Can also use /etc/logfile.log)
  • If using SELinux, you will be required to change the security context of this script file so that cron can execute it. This method copies an existing cron script context of an existing cron script:
    chcon --reference=/etc/cron.daily/makewhatis.cron /etc/cron.daily/StatSVN.sh

Note in this installation, our Cabie build server updates the local repository after every check-in. If your repositry is not updated automatically, uncomment the line in the script to do so.

[Potential Pitfall]: Cron jobs execute as root. You may have to specify an alternative login and password which has access to the Subversion repository. e.g.
svn log -v --xml --username userX --password supersecret /opt/Cabie/BUILDS/...

Create a local specific non-system account Subversion login for the cron job.
See Concurrent file and LDAP Apache authentication.
Avoid interactive dialog during the cron job by setting the following Subversion configuration parameter setting in /root/.subversion/servers (Cron jobs run as user root)
[global]
store-plaintext-passwords = no
This will avoid the following interactive message: Store password unencrypted (yes/no)?

Command Line Options:

statsvn.jar command line options: (Usage: java -jar statsvn.jar [options] <logfile> <svn-directory>)
OptionDescription
-versionprint the version information and exit
-output-dir <dir>directory where HTML suite will be saved
-include <pattern>include only files matching pattern, e.g. **/*.c;**/*.h
-exclude <pattern>exclude matching files, e.g. tests/**;docs/**
-tags <regexp>show matching tags in lines of code chart, e.g. version-.*
-title <title>Project title to be used in reports
-viewvc <url>Integrate with ViewVC installation at <url>
This option causes StatSVN to generate hyperlinks to ViewVC for source code file names listed by StatSVN.
-trac <url>integrate with Trac at <url>
-bugzilla <url>integrate with Bugzilla installation at <url>
-username <svnusername>username to pass to svn
-password <svnpassword>password to pass to svn
-verboseprint extra progress information
-xdocoptional switch output to xdoc
-xmloptional switch output to xml
-threads <int>how many threads for svn diff (default: 25)
-concurrency-threshold <millisec>switch to concurrent svn diff if 1st call > threshold (default: 4000)
-dumpdump the Repository content on console
-charset <charset>specify the charset to use for html/xdoc
-tags-dir <directory>optional, specifies the director for tags (default '/tags/')

Apache configuration so that StatSVN reports are viewable:

File: /etc/httpd/conf.d/statsvn.conf
Alias /StatSVN /opt/Builds/buildserver1/StatSVN/html
<Directory "/opt/Builds/buildserver1/StatSVN/html">
    Options Indexes FollowSymLinks
    AuthType Basic
    ...
</Directory>
View with browser: http://cmserver.yourdomain.com/StatSVN/

In this example the web content will be in /opt/Cabie/BUILDS/buildserver1/StatSVN/html. Apache must be configured to view this directory. See the YoLinux Apache Web server configuration tutorials.

StatSVN version 5.0 and above require X-Windows to support Java Swing classes used by statsvn.jar. If running via a cron or batch job, one will have to set up a virtual frame buffer. I never got this to work successfully so I just used StatSVN 0.4.1 instead.
Virtual frame buffer configuration:
  • Install Xvfb:
    • yum update xorg-x11-server-Xorg
    • yum install xorg-x11-server-Xvfb
  • /usr/bin/Xvfb :2 -nolisten tcp -shmem &
  • export DISPLAY=:2.0
  • Run statsvn.jar here
  • killall Xvfb
Note that it would be preferable to start Xvfb with an init script so that it starts and stops when the system boots and shuts down. See the YoLinux.com init process tutorial.

Links:


Subversion SVD List Generation:

As part of the software process it is often required that one release a complete list of files which make up a software build. This would be part of a Software Version Description document or SVD. This can be generated automatically using the following bash shell CGI: /var/www/cgi-bin/SubversionSVD.cgi to perform this task via the web. Edit the SVN URLs to fit your needs.

This CGI script calls the following awk script svd_report.awk

Helpful Links:
  • For more information on bash CGI scripts, see Bash CGI - YoLinux Tutorial
  • For more information on AWK scripts, see the awk man page
  • For more information on web server configuration, see Web site configuration - YoLinux Tutorial


Trac Server Installation and Configuration:
Trac logo

Red Hat EL6: install Trac 1.0 from source

Note:
  • RHEL6 package prerequisites:
    • python-2.6.6-29 (python 2.5, 2.6, 2.7 are ok)
    • setuptool-1.19.9-3 (setuptools &ft;= 0.6 required)
    • python-genshi06-0.6-1.el6.noarch (Genshi >= 0.6 required) (For RPMs see EPEL)
    • mod_wsgi-3.2-1 (for use with Apache - fastCGI)
    • httpd
Installation:
  • Download: Trac-1.0.tar.gz http://trac.edgewall.org/wiki/TracDownload
  • tar xzf Trac-1.0.tar.gz
  • cd Trac-1.0
  • sudo python ./setup.py install
    This downloads http://download.edgewall.org/trac/Trac-1.0.zip and installs it: easy_install --upgrade Trac==1.0
    Installs to: /usr/lib/python2.6/site-packages/Trac-1.0-py2.6.egg
  • Httpd config file: /etc/httpd/conf.d/trac.conf
    Set ScriptAlias:
    ScriptAlias /trac /usr/lib/python2.6/site-packages/Trac-1.0-py2.6.egg/trac/web/wsgi.py

[Potential Pitfall]: Subversion sync fails:
trac-admin /srv/trac/projectx/ repository sync projectx
Returns error:
TracError: Unsupported version control system "svn": Can't find an appropriate component, maybe the corresponding plugin was not enabled?
      
Fix/solution: Trac 1.0 requires explicit SVN activation
File: /srv/trac/projectx/conf/trac.ini
[components]
tracopt.versioncontrol.svn.* = enabled
      

Red Hat EL6: install from EPEL RPM (Red Hat Enterprise Linux 6 [Python 2.6, sqlite], Trac 0.12.2 example)

Note:
  • RHEL6 package prerequisites: python, python-setuptools, httpd
Installation:
  • Download: EPEL website - trac-0.12.2-1.el6.noarch.rpm
  • Installs the following:
    /etc/httpd/conf.d/trac.conf
    /etc/trac/plugins.d/...
    /etc/trac/trac.ini
    /usr/bin/trac-admin
    /usr/lib/python2.6/site-packages/Trac-0.12.2-py2.6.egg-info/...
    /usr/lib/python2.6/site-packages/trac/...
    /usr/share/doc/trac-0.12.2/...
    /usr/sbin/tracd
    /var/www/cgi-bin/trac.cgi
    /var/www/cgi-bin/trac.fcgi
                
  • Create new project repository:
       # trac-admin /srv/trac/projectX initenv
       Project Name [My Project]> projectX
       Database connection string [sqlite:db/trac.db]>
       Path to repository [/path/to/repos]> /srv/svn/projectX
                

Red Hat EL5: manual installation from source (Red Hat Enterprise Linux 5 [Python 2.4, sqlite], Trac 0.11.5 example)

Note:
  • Clearsilver web templates depricated, now uses Genshi. Trac 0.11.5 required to support Subversion 1.6.X.
  • If upgrading, remove old version. See: /usr/lib/python2.3/site-packages/trac/, /usr/share/trac/, /srv/trac/ProjectX/egg_cache/, /usr/bin/trac-admin and tracd
  • RHEL5 package prerequisites: python, python-setuptools, httpd
Installation:
  • Download: http://trac.edgewall.org/wiki/TracDownload
  • tar xzf Trac-0.11.5.tar.gz
  • cd Trac-0.11.5/
  • List commands: python ./setup.py --help
  • Install: python ./setup.py install
    • This installs the Python template package Genshi
    • Installs Trac to /usr/lib/python2.4/site-packages/Trac-0.11.5-py2.4.egg/
    • Installs commands (trac-admin, tracd): /usr/bin
    [Potential Pitfall]: If the Trac install fails to download and install Genshi, one can manually install it: Then attempt to install Trac again: python ./setup.py install
  • Install CGI: cp cgi-bin/trac.cgi cgi-bin/trac.fcgi /var/www/cgi-bin
    Note:
    • Set environment variable (Trac 0.11+) in /etc/httpd/conf.d/trac.conf:
      SetEnv PYTHON_EGG_CACHE /srv/trac/projectX/egg_cache
    • Create the directory /srv/trac/projectX/egg_cache as it must be present even if not used.
  • Create new project repository:
       # trac-admin /srv/trac/projectX initenv
       Project Name [My Project]> projectX
       Database connection string [sqlite:db/trac.db]>
       Path to repository [/path/to/repos]> /srv/svn/projectX
                

Red Hat EL4: RPM installation (Red Hat Enterprise Linux 4 [Python 2.3], Trac 0.9.6 example)

  • http://pkgs.repoforge.org/:
    (Select: Home made + RPM repository + RPMforge)
    • trac-0.9.6-1.el4.rf.noarch.rpm
    • clearsilver-0.10.1-1.2.el4.rf.i386.rpm
    • clearsilver-devel-0.10.1-1.2.el4.rf.i386.rpm
    • python-clearsilver-0.10.1-1.2.el4.rf.i386.rpm
    • python-imaging-1.1.5-5.el4.i386.rpm
    • python-sqlite-1.0.1-1.2.el4.rf.i386.rpm
    • sqlite-2.8.16-1.2.el4.rf.i386.rpm
    • sqlite-devel-2.8.16-1.2.el4.rf.i386.rpm
  • http://rpm.pbone.net:
    • python-docutils-0.4-2.el4.noarch.rpm
or configure YUM and import from the DAG YUM repository. See the YoLinux SysAdmin Tutorial: YUM

yum install -y trac


Ubuntu: apt-get install trac


Trac Upgrades:

All Trac upgrades will require Trac to be "re-synced" to the Subversion repository with the following command:
trac-admin /srv/trac/projectX  resync


Allow Trac CGI to be executed (Two methods. Pick one.):

  1. Copy the CGI to the default CGI bin directory: cp /usr/share/trac/cgi-bin/trac.cgi /var/www/cgi-bin
    OR
  2. Enable Apache to execute the CGI:
    ..
    ScriptAlias /trac /usr/share/trac/cgi-bin/trac.cgi
    ..
                        
Note:The CGI trac.fcgi is for use with Apache Python module mod_fastcgi to improve performance.

As root: [root]# trac-admin /srv/trac/projectX initenv

Project Name [My Project]> projectX
Database connection string [sqlite:db/trac.db]>
Path to repository [/var/svn/test]> /srv/svn/projectX
Templates directory [/usr/share/trac/templates]>
          
Note:
  • The directory /srv/trac MUST exist.
  • The directory /srv/trac/projectX MUST not exist before execution of command.
Trac repository directories:
  • SuSE: /srv/trac/
  • Red Hat: /usr/share/trac/proj_trac/
This command will initialize the Trac data repository and create a directory structure and default configuration files.

Allow paths and files to be accessible by Apache: [root]# chown -R apache:apache /srv/trac/projectX

SELinux:

  • chcon -R -t httpd_sys_content_t /usr/share/trac/
  • chcon -R -t httpd_sys_content_t /srv/trac/

Component Home pages:


Trac Configuration:

File: /srv/trac/projectX/conf/trac.ini
(Created using the "trac-admin" command above and not provided by the RPM package.)

Specify project URL:
..
...

[trac]
...
repository_dir = /srv/svn/projectX       - This ties Trac to Subversion

...
...

[notification]
Set email and SMTP information here

...
...

[project]
url = http://projectX.com
                
For more trac.ini configuration information see Trac: trac.ini configuration

[Potential Pitfall]: Once Trac is configured and used (i.e. it has tickets, etc), it can not be pointed to a different Subversion repository. If you point "repository_dir" to a new Subversion repository, you will not have a Trac database which is in sync with Subversion and Trac will fail. The name of the directory path and the "repository_dir" can be renamed with matching names, but the actual Subversion repository must remain the same.


Apache Web Server configuration file for Trac integration:

Trac can be run using the stand-alone Trac daemon "tracd". This configuration shows the use of Apache with Trac.

Trac logo

+

Apache logo

File: /etc/httpd/conf.d/trac.conf

  • This example performs no authentication:
    Alias /trac/ "/usr/share/trac/htdocs/"
    <Location "/cgi-bin/trac.cgi">
       SetEnv TRAC_ENV "/srv/trac/projectX"
    </Location>
    
    or Red Hat Dag.Wieers.com rpm installation example:
    ScriptAlias /trac /usr/share/trac/cgi-bin/trac.cgi
    <Location "/trac">
       SetEnv TRAC_ENV "/srv/trac/projectX"
    </Location>
    

  • This example authenticates logins internally using Apache. User logins and passwords have no connection to user accounts.
    Alias /trac/ "/usr/share/trac/htdocs/"
    <Location "/cgi-bin/trac.cgi">
       SetEnv TRAC_ENV "/srv/trac/projectX"
    </Location>
    
    # The following enables the "login" link in Trac. 
    # (Top right hand corner)
    
    <Location "/cgi-bin/trac.cgi/login">   
       AuthType Basic
       AuthName "Project X Trac"
       AuthUserFile /etc/httpd/conf/userpw
       require valid-user
    </Location>
    
    For more on Apache user file authentication see:

  • This example authenticates logins internally using Trac and Digest authentication. User logins and passwords have no connection to user accounts.
    Alias /trac/ "/usr/share/trac/htdocs/"
    <Location "/cgi-bin/trac.cgi">
       SetEnv TRAC_ENV "/srv/trac/projectX"
    </Location>
    
    # The following enables the "login" link in Trac. 
    # (Top right hand corner)
    
    <Location "/cgi-bin/trac.cgi/login">   
       AuthType Digest
       AuthName "Project X Trac"
       AuthDigestDomain /trac
       AuthDigestFile /etc/httpd/conf/digestpw
       require valid-user
    </Location>
    
    For more on digest authentication see:

  • This example authenticates user account logins with the NIS server. This requires the installation of perl modules Apache-AuthenNIS. See the YoLinux Apache NIS authentication tutorial (See this tutorial if running Apache httpd 2.2)
    Alias /trac/ "/usr/share/trac/htdocs/"
    <Location "/cgi-bin/trac.cgi">
       SetEnv TRAC_ENV "/srv/trac/projectX"
       AuthType Basic
       AuthName "Project X Trac"
       PerlAuthenHandler Apache::AuthenNIS
       PerlSerVar AllowAlternateAuth no
       require valid-user
    </Location>
    
    # The following enables the "login" link in Trac. 
    # (Top right hand corner)
    
    <Location "/cgi-bin/trac.cgi/login">   
       AuthType Basic
       AuthName "Project X Trac"
       PerlAuthenHandler Apache::AuthenNIS
       PerlSerVar AllowAlternateAuth no
       require valid-user
    </Location>
                    
    Auth configuration prohibits anonymous use of Trac

    This example is for RHEL4 with Apache httpd 2.0.

Restart Apache: service httpd restart

Also see YoLinux Apache authentication tutorial: LDAP, NIS, File.


Trac Administration:

Issue Trac commands as root:

  • Command line: trac-admin --help
    OR
  • Enter into Trac Admin shell: trac-admin /srv/trac/projectX
    Then type "help" to see list of commands.
    Use the command "quit" to exit the shell.

Set Permissions:

  • Grant administration privileges to a user:
    trac-admin /srv/trac/projectX permission add userid TRAC_ADMIN

    These permissions are required if using web interface to manage "roadmaps".
  • Show permissions:
    trac-admin /srv/trac/projectX permission list user-id
  • Remove write for anonymous users:
    trac-admin /srv/trac/projectX permission remove anonymous TICKET_CREATE TICKET_MODIFY WIKI_CREATE WIKI_MODIFY
  • Set default for authenticated users:
    trac-admin /srv/trac/projectX permission add authenticated TICKET_CREATE TICKET_MODIFY TICKET_VIEW WIKI_CREATE WIKI_MODIFY

Add components to be managed by Trac:

  • Roadmap/Product Milestones:
    • trac-admin /srv/trac/projectX milestone add name-of-milestone YYYY-MM-DD
    • trac-admin /srv/trac/projectX milestone completed name-of-milestone YYYY-MM-DD
    (Where "YYYY-MM-DD" is the due date or completion date. i.e. 2006-11-17)
    The milestones can be created using the web interface.
  • Software Components: trac-admin /srv/trac/projectX component add name-of-component owner-id

Defaults for "New Ticket":

  • Type: defect, enhancement, task
    View using the command: trac-admin /srv/trac/projectX ticket_type list
    Use "add" or "delete" to change the default.
  • Priority: blocker, critical, major, minor, trivial
    View using the command: trac-admin /srv/trac/projectX priority list
    Use "add" or "delete" to change the default.
  • Severity: highest, high, normal, low, lowest
    View using the command: trac-admin /srv/trac/projectX severity list
    Use "add" or "delete" to change the default.

Trac-Admin commands: trac-admin /path/to/projenv [command [subcommand] [option ...]]

Command Description
about Shows information about trac-admin
help Show documentation
initenv Create and initialize a new environment interactively
initenv <projectname> <db> <repospath> <templatepath> Create and initialize a new environment from arguments
hotcopy <backupdir> Make a hot backup copy of an environment
resync Re-synchronize trac with the repository
upgrade Upgrade database to current version
wiki list List wiki pages
wiki remove <name> Remove wiki page
wiki export <page> [file] Export wiki page to file or stdout
wiki import <page> [file] Import wiki page from file or stdin
wiki dump <directory> Export all wiki pages to files named by title
wiki load <directory> Import all wiki pages from directory
wiki upgrade Upgrade default wiki pages to current version
permission list [user] List permission rules
permission add <user> <action> [action] [...] Add a new permission rule
permission remove <user> <action> [action] [...] Remove permission rule
component list Show available components
component add <name> <owner> Add a new component
component rename <name> <newname> Rename a component
component remove <name> Remove/uninstall component
component chown <name> <owner> Change component ownership
ticket remove 4 Remove ticket number 4 and all associated data. (Trac 0.12+)
ticket_type list Show possible ticket types
ticket_type add <value> Add a ticket type
ticket_type change <value> <newvalue> Change a ticket type
ticket_type remove <value> Remove a ticket type
ticket_type order <value> up|down Move a ticket type up or down in the list
priority list Show possible ticket priorities
priority add <value> Add a priority value option
priority change <value> <newvalue> Change a priority value
priority remove <value> Remove priority value
priority order <value> up|down Move a priority value up or down in the list
severity list Show possible ticket severities
severity add <value> Add a severity value option
severity change <value> <newvalue> Change a severity value
severity remove <value> Remove severity value
severity order <value> up|down Move a severity value up or down in the list
version list Show versions
version add <name> [time] Add version
version rename <name> <newname> Rename version
version time <name> <time> Set version date (Format: "YYYY-MM-DD" or "now")
version remove <name> Remove version
milestone list Show milestones
milestone add <name> [due] Add milestone
milestone rename <name> <newname> Rename milestone
milestone due <name> <due> Set milestone due date (Format: "YYYY-MM-DD" or "now")
milestone completed <name> <completed> Set milestone completed date (Format: "YYYY-MM-DD" or "now")
milestone remove <name> Remove milestone
Invoking trac-admin without command starts interactive mode.

Use the command trac-admin /srv/trac/projectX wiki list to view Wiki entries.


Trac Page Formatting:

Display Trac/Wiki Format Code HTML Code Equivalent
A forced line
break.
A forced line[[br]]break. A forced line<br>break.
Bold text '''Bold text''' <b> </b>
Italic text ''Italic text'' <i> </i>
Bold italic text '''''Bold italic text''''' <b><i> </i></b>
Underline __Underline__ <u> </u>
Monospace text {{{Monospace text}}}
or
`Monospace text`
<tt> </tt>
strike-through ~~strike-through~~ <del> </del>
Textsuperscript ^superscript^ <sup> </sup>
Textsubscript ,,subscript,, <sub> </sub>
''' !'''
The "!" escapes the Trac Wiki parser.

Heading

= Heading = Same as HTML "h1"

Subheading

== Subheading == Same as HTML "h2"

Smaller subheading

===Smaller subheading=== Same as HTML "h3"
Text line 1
Text line 2
Text line 1[[BR]]Text line 2 HTML line break <br>
  • List item one
  • List item two
    • Nested item
 * List item one
* List item two
* Nested item

Note: A blank space must be present before the "*".

HTML unordered list:
<ul>
<li>List item one</li>
<li>List item two
<ul>
<li>Nested item</li>
</ul></li>
</ul>
  1. List item one
    1. Nested item
  2. List item two
    1. Nested item
 1. List item one
i. Nested item
2. List item two
a Nested item

Note: A blank space must be present before the list item: "1"

HTML ordered list:
<ol>
<li>List item one
<ol type="lower-roman">
<li>Nested item</li>
</li>
<li>List item two
<ol type="lower-alpha">
<li>Nested item</li>
</ol></li>
</ol>
Cell 1 Cell 2 Cell 3
Cell 4 Cell 5 Cell 6
||Cell 1||Cell 2||Cell 3||
||Cell 4||Cell 5||Cell 6||
<table border>
<tr><td>Cell 1</td><td></td>Cell 2</td><td></td>Cell 3</td></tr>
<tr><td>Cell 4</td><td></td>Cell 5</td><td></td>Cell 6</td></tr>
</table>
[[Image(http://URL-goes-here/images/image-file.gif)]]

(URLs ending in .png, .gif or .jpg are interpreted as image links. See "Creating Wiki links" below)

<img src="http://URL-goes-here/images/image-file.gif">
For more information on Trac Wiki formatting, see WikiFormatting

Embed an image included as an "attachment" in the body of a wiki page:

  • At the bottom of the wiki page select "Attach file"
  • Add a GIF, PNG or JPG image file
  • The attachement will be listed at the bottom of the page under the heading "Attachments"
  • Select the hyper-link to the image attachment to view the URL. it will be similar to:
    http://URL-goes-here/trac/ProjectX/attachment/wiki/NameOfWikiPage/image-file.gif
  • In the body of the wiki page specify the wiki format:
    [[Image(http://URL-goes-here/trac/ProjectX/raw-attachment/wiki/NameOfWikiPage/image-file.gif)]]
    or relative path:
    [[Image(/raw-attachment/wiki/NameOfWikiPage/image-file.gif)]]

Note the URL path difference between "attachment/" and "raw-attachment/"

Creating Wiki links:

  • Web URL: [http://URL-goes-here Link text goes here]
    (Traditional HTML link)
  • Create a link to a Trac Milestone:
    • milestone:1.2
    • milestone:"Release maui"
  • Create link to Subversion for given revision changeset:
    • [subversion-revision-number-goes-here]
    • r207, r209
    • changeset:207
    Prefix the Subversion revision number with the letter "r" to have Wiki formatting create a link to the Subversion revision logs.
  • Trac multi-repository configuration - link to Subversion changeset:
    • r207/projectx, r3809/projecty
    Add the Subversion repository name to the revision specified.
  • Create link to Subversion revision logs:
    • r3:5
    • [3:5]
    • log:branches/version6.2-beta#3:5
      Where "version6.2-beta" is the name of the branch for which logs are to be reported.
  • Create link to Trac ticket:
    • #ticket-number-goes-here
    • #45
      Note: To escape the "#" without making it a link, prefix with a "!". i.e. !#45 will not generate a link.
    • ticket:45
  • Create link to a specific file:
    • source:trunk/dira/dirb/file.cpp
    • source:"trunk/dira/dirb/file with spaces.cpp"
      (Files with spaces in the name should be encapsulated in quotes.)
  • Create link to a specific revision of a file: source:trunk/dira/dirb/file.cpp#207
  • Create link to a report:
    • {report-number-goes-here}
    • report:report-number-goes-here
  • Create link to Wiki page: CamelCaseStringGoesHere
    This becomes a link to an HTML page of the same name.
  • Link to a Trac Wiki attachment: attachment:presentation.ppt
Use the command trac-admin /srv/trac/projectX wiki list to view Wiki entries.


The Trac SQL Database:

One can access the Trac SQLite database directly:

Sample session: (response not included)
[prompt]$ cd /srv/trac/projectX/db
[prompt]$ sqlite trac.db
sqlite> .help
sqlite> .tables
sqlite> .schema ticket
sqlite> SELECT * FROM ticket;
sqlite> .exit

Backup and restore:

Dump database:
[prompt]$ cd /srv/trac/projectX/db
[prompt]$ sqlite trac.db
sqlite> .outfile /tmp/trac.sql
sqlite> .dump
sqlite> .exit

Load database:

[prompt]$ cd /srv/trac/projectX/db
[prompt]$ rm trac.db
[prompt]$ sqlite trac.db
sqlite> .read /tmp/trac.sql
sqlite> .exit
[prompt]$ trac-admin trac resync

Trac database schema


Database migration: (from /usr/share/trac/proj_trac/projectX/db)
  • Upgrade: sqlite trac.db .dump | sqlite3 tracV3.db
    Typically this would have to be accompanied with a Trac database and environment upgrade:
    trac-admin /usr/share/trac/proj_trac/projectX upgrade

    and a Trac wiki manual upgrade:
    trac-admin /usr/share/trac/proj_trac/projectX wiki upgrade

  • Downgrade: sqlite3 trac.db .dump | sqlite tracV2.db
    Typically this would have to be accompanied with a Trac database table downgrade:
    sqlite3 trac.db "update system set value=20 where name='2'"
Rename database to "trac.db" to be usable.


Trac User Registration:

Trac can assign new tickets (bugs/enhancements) to developers registered in the system. It can also communicate via email. To register, a user must login to Trac and:

  • Select the "Settings" link at the top right hand side of the web page.
  • Enter your name and email address.


Trac Upgrades:

After an upgrade to Trac, the configuration and data files you employ must also be upgraded. The RPM upgrades miss this so perform manually:

trac-admin /srv/trac/projectX upgrade


Upgrading OS from RHEL4 to RHEL5:

This OS upgrade will upgrade the version of the embedded database package sqlite. The following must be performed for any OS upgrade which will also upgrade the Trac database environment.
  • Prior to the OS upgrade, dump the database to a text file:
    • cd /srv/trac/projectX/db
    • sqlite trac.db .dump > trac.dump_sqlite
  • Upgrade the OS
  • Import the database using the newer version of sqlite
    • cd /srv/trac/projectX/db
    • cat trac.dump_sqlite | sqlite3 trac.db
      Note that Trac requires the database name trac.db
  • Upgrade the trac repository: trac-admin /srv/trac/projectX upgrade
  • Upgrade wiki: trac-admin /srv/trac/projectX wiki upgrade
  • Synchronize Trac with Subversion: trac-admin /srv/trac/projectX resync
    This step is required when Subversion is upgraded (i.e. 1.4.2 to 1.6.9)


Trac Links:

Also see /usr/share/doc/trac-... for local documentation.


Hosting Multiple Subversion and Trac repositories:

Apache logo

SVN Hosting and Multiple Subversion Repositories with Apache:

One can have multiple Subversion repositories on one server. It is encouraged for separate projects. Subversion increments the revision number for each check-in in the repository and it makes the most logical sense to track revisions for a logically grouped set of applications or even a single application. If you want, you can even have a separate repository which links other projects in separate repositories and servers to look logically as one. (See Subversion property svn:externals)

Create repository locations:

  • svnadmin create --fs-type fsfs /srv/svn/reposX
  • svnadmin create --fs-type fsfs /srv/svn/reposY
  • svnadmin create --fs-type fsfs /srv/svn/reposZ
  • ...
Each repository would have a separate "Location" defined in the Apache configuration:
LoadModule dav_svn_module     modules/mod_dav_svn.so
LoadModule authz_svn_module   modules/mod_authz_svn.so

<Location /reposX>
   DAV svn
   SVNPath /srv/svn/reposX
   ...
   ..
</Location>
<Location /reposY>
   DAV svn
   SVNPath /srv/svn/reposY
   ...
   ..
</Location>
<Location /reposZ>
   DAV svn
   SVNPath /srv/svn/reposZ
   ...
   ..
</Location>
All the following URLs would be available:
  • http://yourdomain/reposX/
  • http://yourdomain/reposY/
  • http://yourdomain/reposZ/

or specify the "SVNParentPath":

LoadModule dav_svn_module     modules/mod_dav_svn.so
LoadModule authz_svn_module   modules/mod_authz_svn.so

<Location /svn>
   DAV svn
   SVNParentPath /srv/svn
   ...
   ..
</Location>
All the following URLs would be available:
  • http://yourdomain/svn/reposX/
  • http://yourdomain/svn/reposY/
  • http://yourdomain/svn/reposZ/

Multiple Trac repositories:

Define a Trac parent directory under which you may locate multiple instances of Trac:
ScriptAlias /trac /usr/share/trac/cgi-bin/trac.cgi

<Location "/trac">
    SetEnv TRAC_ENV_PARENT_DIR "/srv/trac/trac_projects"
    AuthType Basic
    AuthName "Trac"
    AuthUserFile /srv/passwd/trac.htpasswd
    Require valid-user
</Location>

<LocationMatch "/trac/[^/]+/login">
    AuthType Basic
    AuthName "Trac"
    AuthUserFile /srv/passwd/trac.htpasswd
    Require valid-user
</LocationMatch>

Note:

  • All trac repositories reside under /srv/trac/trac_projects
    i.e. /srv/trac/trac_projects/projectX, /srv/trac/trac_projects/projectY, etc
    Web URL: http://server-name/trac/projectX
  • This example uses file authentication as defined in /etc/httpd/conf.d/subversion.conf
    AccessFileName /srv/passwd/trac.htpasswd
    
    <Directory /srv/passwd>
        Options -Indexes -FollowSymLinks
        AllowOverride None
    </Directory>
        

Trac and multiple Subversion repositories and Multiple Trac instances:

If using Trac with Subversion, you may create separate Trac instances. Trac can use InterTrac Links to refer to resources of other Trac instances or servers, from within the Wiki markup. Trac can also have a global "trac.ini" file used for multiple instances of Trac.

Trac (Version 0.12 and later) can support multiple Subversion or Git repositories.
Set the configuration in the Trac config file: /srv/trac/projectx/conf/trac.ini

...
...

[components]
tracopt.versioncontrol.svn.* = enabled

[repositories]
projectx.description = Project X
projectx.dir = /srv/svn/projectx
projectx.type = svn
projectx.url = http://localhost/svn/projectx
projecty.description = Project Y
projecty.dir = /srv/svn/projecty
projecty.type = svn
projecty.url = http://localhost/svn/projecty

...
...
Re-sync Trac with the Subversion repositories:
  • trac-admin /srv/trac/project/ repository resync projectx
  • trac-admin /srv/trac/project/ repository resync projecty
This has one Trac instance named "project", configured to work with two Subversion repositories "projectx" and "projecty". When referencing the check-in for a given repository, state the revision (as is typical with Trac eg. r435 generates a hyperlink to the check-in 435 revision) followed by the repository name (eg. r435/projectx or r2984/projecty).

Also see:


Subversion Read-Only Access:

Repositories and directory branches can be configured as read-only.

Apache configuration to use granular Subversion rules: /etc/httpd/conf.d/subversion.conf
<Location /svn>
        DAV svn
        SVNParentPath /srv/svn
        AuthzSVNAccessFile /srv/config/svn_granular_rules
...
...
</Location>
The inclusion of the "AuthzSVNAccessFile" Apache module directive, directs granular access control to the file "/srv/config/svn_granular_rules".
Granular directory level access rules: /srv/config/svn_granular_rules
[projectX:/tags]
* = r
userx = rw
[projectX:/]
* = rw
[projectY:/]
* = rw
Once granular access control has been assigned to this control file, all projects must have access assignments or none will be granted by default.
This rule set enforces read-only access to the "tags" branch except for "userx" who has read and write access to the "tags" branch. All other repositories under the "SVNParentPath" must be listed. The "*" refers to all users.


SE-Linux configuration:

Of course it is easiest to turn off Security Enhanced Linux features by:

  • editing the file /etc/selinux/config, setting "SELINUX=disabled" and reboot
    OR
  • use the command "setenforce 0".

If using SELinux, you must set the context of the content accessed by the server:

chcon -R -h -u system_u -r object_r -t httpd_sys_content_t /srv/svn /srv/trac
For more on SELinux see the YoLinux SysAdmin Tutorial


Reducing Apache configuration redundancy with Include files:

You will find that user authorization and authorization configurations will repeat themselves for Subversion, ViewVC and Trac. This duplication and replication of authorization and authorization configuration can be mitigated by the use of the Apache web server "Include" statement.

Subversion configuration file: /etc/httpd/conf.d/subversion.conf
LoadModule dav_svn_module     modules/mod_dav_svn.so
LoadModule authz_svn_module   modules/mod_authz_svn.so
<Location /repoX>
        DAV svn
        SVNPath /srv/svn/repoX
        Include userauth.txt
</Location>
Where the include file used is /etc/httpd/userauth.txt

Trac configuration file: /etc/httpd/conf.d/trac.conf
Alias /trac/ "/usr/share/trac/htdocs/"
<Location "/cgi-bin/trac.cgi">
        SetEnv TRAC_ENV "/srv/trac/projectX"
        Include userauth.txt
</Location>
Utilize the same "Include" file for ViewVC as well.

Where /etc/httpd/userauth.txt contains the user authentication which is identical for all three:
Example LDAP authentication:
   AuthType Basic
   AuthName "Stooges Web Site: Login with email address"
   AuthLDAPURL ldap://ldap.yolinux.com:389/o=stooges?mail
   require valid-user


Repository Home Page:

The final touch is to create a homepage for your repositories so that they are easy to find, especially if you are hosting multiple reporitories. The default homepage for most major Linux distributions (Red Hat, Fedora, CentOS, Ubuntu, Debian) is /var/www/html/index.html Create a home page here or create a redirect to the Trac Wiki home page and post links there.

Redirect to the Trac Wiki
   
<META HTTP-EQUIV="Refresh" Content="0; URL=/trac/">
Sample home page:
   
<html>
<head>
<title>Welcome to Project X</title>
</head>
<body>
<h1>Welcome to Project X</h1>
<ul>
<li> <a href="/trac/">Trac Wiki</a> </li>
<li> <a href="/viewvc/">ViewVC</a> </li>
<li> <a href="/svn">svn</a> </li>
<li> <a href="/statSVN">statSVN</a> </li>
</ul>
</body>
</html>
Now add Continuous Build and Integration:


Books:

Version Control with Subversion
by C. Michael Pilato
ISBN #0596004486, O'Reilly Press

Amazon.com
Practical Subversion (Expert's Voice in Open Source)
Garrett Rooney
ISBN #1590592905, Apress

Amazon.com
Subversion Version Control: Using the Subversion Version Control System in Development Projects
William Nagel
ISBN #0131855182, Prentice Hall PTR

Amazon.com
Defect Tracking Tools Product Comparison Guide: Large Enterprise Edition
TiPS-IT Ziff Davis Media
Digital PDF Download

Amazon.com
Defect Tracking Tools Product Comparison Guide: Small / Mid Enterprise Edition
TiPS-IT Ziff Davis Media
Digital PDF Download

Amazon.com
   

    Bookmark and Share


Advertisements




Copyright © 2006 - 2013 YoLinux.com