Configuring the biowikifarm subversion repository

From Biowikifarm Metawiki
Revision as of 10:41, 2 April 2013 by Gregor Hagedorn (Talk | contribs) (→‎SVN-Repository and post-commit-hook)

Jump to: navigation, search

This topic is about creating and configuring the repository on the server itself. For help with using or managing subversion, see Help: Subversion.

Configuration

Configuring a subversion repository, with svn already installed through apt-get, on Debian 5. The procedure was contributed by an anonymous helper. First: in /etc/apache2/mods-enabled/dav_svn.conf enable several lines: 

<Location /svn>
DAV svn
SVNPath /var/lib/svn
AuthType Basic
AuthName "Subversion Repository"
AuthUserFile /etc/apache2/dav_svn.passwd
Require valid-user
AuthzSVNAccessFile /etc/apache2/dav_svn.authz
</Location>

Password file and users 

 sudo htpasswd -c /etc/apache2/dav_svn_git.passwd user ## only for first user
 sudo htpasswd /etc/apache2/dav_svn_git.passwd username1
 sudo htpasswd /etc/apache2/dav_svn_git.passwd username2 ## etc.

(Password will be requested by htpasswd)

Create access control file and reload: 

 sudo nano /etc/apache2/dav_svn.authz

 # Read/write permission for all SVN users:
 [/]
 * = rw

 sudo /etc/init.d/apache2 reload

SVN Web Access

Creating SVN-Repository, access only to Webserver: 

 sudo mkdir /var/lib/svn
 sudo svnadmin create /var/lib/svn/
 sudo chown -R www-data.www-data /var/lib/svn/

Now one can check versions directly inside the browser using https://biowikifarm.net/svn/ or check locally out using a svn client: 

 svn co https://biowikifarm.net/svn/


SVN post-commit-hook

To increase comfort we can ensure that committing to the webserver the most recent version is updated also in server’s repositories (i.e. with every commit from a normal subversion user, the webserver-local checkout is updated by a post-commit later on): 

 # set password for www-data, use a random password, it will be stored plain text:
 sudo htpasswd /etc/apache2/dav_svn.passwd www-data 
 <PASSWORD>
 # sudo -s #  -s (shell) 
 # sudo chown -R www-data.www-data /var/www/v-artenquiz
 # Note: www-data needs a folder to store svn-configuration (esp. a plaintext password needs to be set and then stored):
 sudo mkdir /var/www/.subversion
 sudo chown www-data.www-data /var/www/.subversion/

 # Perhaps, if existing, safety first: 
 #  sudo mv /var/www/v-artenquiz /var/www/v-artenquiz-DELETE-ME-LATER
 sudo mkdir /var/www/v-artenquiz; cd /var/www/v-artenquiz
 sudo svn checkout file:///var/lib/svn/artenquiz /var/www/v-artenquiz
 sudo chown -R  www-data.www-data /var/www/v-artenquiz

 sudo mv    /usr/share/mediawiki/ext-LOCAL-svn /usr/share/mediawiki/ext-LOCAL-svn-DELETE-ME-LATER
 sudo mkdir /usr/share/mediawiki/ext-LOCAL-svn; cd /usr/share/mediawiki/ext-LOCAL-svn; 
 sudo svn checkout file:///var/lib/svn/LocalSVNextensions /usr/share/mediawiki/ext-LOCAL-svn
 sudo chown -R  www-data.www-data /usr/share/mediawiki/ext-LOCAL-svn

 sudo mv    /usr/share/mediawikistaging/ext-LOCAL-svn /usr/share/mediawikistaging/ext-LOCAL-svn-DELETE-ME-LATER
 sudo mkdir /usr/share/mediawikistaging/ext-LOCAL-svn; cd /usr/share/mediawikistaging/ext-LOCAL-svn; 
 sudo svn checkout file:///var/lib/svn/LocalSVNextensions /usr/share/mediawikistaging/ext-LOCAL-svn
 sudo chown -R  www-data.www-data /usr/share/mediawikistaging/ext-LOCAL-svn

 # new for the 1.20 git version with new folder arrangement (this may be temporary, check later)
 # first check out into separate folder, then change owner, then move to final extensions folder shared with the git-clone
 cd /usr/share/mediawiki20/phase3/
 sudo mkdir ext-LOCAL-svn; cd ext-LOCAL-svn; 
 sudo svn checkout file:///var/lib/svn/LocalSVNextensions /usr/share/mediawiki20/phase3/ext-LOCAL-svn
 sudo chown -R  www-data.www-data /usr/share/mediawiki20/phase3/ext-LOCAL-svn
 sudo mv /usr/share/mediawiki20/phase3/ext-LOCAL-svn/* /usr/share/mediawiki20/phase3/extensions
 sudo mv /usr/share/mediawiki20/phase3/ext-LOCAL-svn/.svn /usr/share/mediawiki20/phase3/extensions
 sudo rm /usr/share/mediawiki20/phase3/ext-LOCAL-svn -r

Continuing as normal user, edit/create file 

 sudo nano /var/lib/svn/hooks/post-commit

with: 

#!/bin/sh
REPOS="$1"
REV="$2"
HOME=/var/www # define HOME for settings in $HOME/.subversion
cd /var/www/v-artenquiz;                      /usr/bin/svn update
cd /usr/share/mediawiki/ext-LOCAL-svn;        /usr/bin/svn update
cd /usr/share/mediawikistaging/ext-LOCAL-svn; /usr/bin/svn update
cd /usr/share/mediawiki20/phase3/extensions;  /usr/bin/svn update

… and set this file as executable: 

 sudo chmod +x /var/lib/svn/hooks/post-commit

By means of this post-commit-hook, whenever a commit to SVN occurs, www/v-artenquiz is automatically updated as well!

Adding new directories

The easiest way to add new directories or files to the repository is to use a GUI like TortoiseSVN (Windows) or kdesvn (Linux KDE).

  1. Check out the repository
  2. Add or copy the folders you wish to add to the repository and add them to subversion control locally using the local GUI
  3. Commit your changes to the main repository (needs a user account in dav)

An alternative is to use svn import on command line with 

 sudo svn import LocalSVNextensions file:///var/lib/svn/LocalSVNextensions -m 'import of mediawiki LocalSVNextensions'

Adding a log-edit feature

cd /var/lib/svn/hooks/
# use templates provided by subversion
sudo cp  pre-revprop-change.tmpl pre-revprop-change 
# make it executable
sudo chmod +x pre-revprop-change

Now you are able to edit/or set log entries from a specific subversion revision number -r by: 

1 cd /path/to/versioned/directory/
2 # edit log entry with editor
3 sudo svn propedit -r123 --revprop svn:log
4 # set log entry
5 sudo svn propset -r123 --revprop svn:log "new log message"

See also http://subversion.apache.org/faq.html#change-log-msg.

SVN repo on apache behind nginx

Changes made to dav_svn.conf: add right before "<Location /svn>" 

## NECESSARY MODIFICATION FOR APACHE BEHIND NGINX (rev. proxy):
RequestHeader edit Destination ^https http early

Note: Normal commits would work without this, but renames of folders caused "Server sent unexpected return value (502 Bad Gateway) in response to COPY". This requires the headers mod to be enabled: 

a2enmod headers

There was nothing about SVN in our sites-available/default anyways. Setting in nginx /etc/nginx/sites-available/default: 

 # SVN/GIT need ^~ to have priority over regexp with *.php!
 location ^~ /svn {
     proxy_set_header X-Real-IP       $remote_addr;
     proxy_set_header X-Forwarded-For $remote_addr;
     proxy_set_header Host            $host;
     proxy_pass http://127.0.0.1:8880; # = APACHE2 Prefork
 }

Note: with "location /svn" instead of "location ^~ /svn" it would work with most files, but not with *.php files. PHP files would be caught by a regexp location (not shown), which has priority over normal nginx starts-with directives. The error message was: "Commit failed (details follow): File '/home/...i18n.php' is out of date '/svn/!svn/bc/2423/.../i18n.php' path not found. You have to update your working copy first. (Or German: "Übertragen schlug fehl (Details folgen): Datei »/home/.../i18n.php« ist veraltet. »/svn/!svn/bc/2423/.../i18n.php«. Pfad nicht gefunden."). This would occur for commits immediately after successful updates. Using a priority-start-with (which has priority over regexp locations) solved the problem.

Initially there also was a problem with checkouts on the server itself, this could be solved by checking these out again, using file: instead of https: (e.g. svn checkout file:///var/lib/svn/LocalSVNextensions).

Retrieved from "https://biowikifarm.net/metawiki/index.php?title=Configuring_the_biowikifarm_subversion_repository&oldid=4392"