Documentation

How to set up site search using Solr

Eero af Heurlin — Tue, 23 Feb 2010 13:53:10 +0000

About Solr

Solr is an open source enterprise search server based on the Lucene Java search library, with XML/HTTP and JSON APIs, hit highlighting, faceted search, caching, replication, and a web administration interface. It runs in a Java servlet container such as Tomcat.

That means that to use Solr you will need to run in some Java servlet container.

Using solr-tomcat5.5

On Ubuntu et co we have this package available and dependency of the midgard metapackage, so after installing just do the following:

Make sure the Catalina process uses UTF-8 for URI parsing
Download the MidCOM Solr Schema and copy over /etc/solr/conf/schema.xml

Configure your website to use the indexer Set the following values in code-init-before-midcom:

$GLOBALS['midcom_config_local']['indexer_reindex_allowed_ips'] = array ( '127.0.0.1', 'server.main.ip' );
$GLOBALS['midcom_config_local']['indexer_backend'] = 'solr';
$GLOBALS['midcom_config_local']['indexer_xmltcp_host'] = 'localhost';
$GLOBALS['midcom_config_local']['indexer_xmltcp_port'] = '8180';

If you get java.lang.NoClassDefFoundError in Tomcat logs you may need to disable Tomcat security

Using Jetty

This section is very old, we suggest using Tomcat

Dependencies

On Debian you need the following packages:

apt-get install libmx4j-java libregexp-java libsablevm-classlib1-java libservlet2.4-java libtomcat5.5-java libxerces2-java sun-java5-jdk

Installing Jetty

Solr comes with Jetty in the example directory.

Installing Solr

You must use version 1.1 of Solr

Download Solr from the Solr website http://www.apache.org/dyn/closer.cgi/lucene/solr/
Unpack solr and copy the jetty example install to the jetty home.

unzip apache-solr-1.1*.zip
cp -R apache-solr-1.1*/example /usr/share/jetty
Download the setupfiles for Solr. (Currently just for Debian)

svn co https://svn.midgard-project.org/midgard/trunk/external-tools/indexer-backends/solr
cd solr
bash ./install-solr.sh

This will install setupfiles in the correct places and set the correct permissions.

Start solr

/etc/init.d/jetty start

Now solr is running and listening to requests on port 8983.

Create a topic with the Search component.
In the menu, choose website -> website configuration.
Set the following values:

Indexer: Solr
Hostname of indexer xmltcp service: localhost (or the host solr is running on)
Port of indexer xmltcp service: 8983

Reindex your site. Visit /midcom-exec-midcom/reindex.php. This will take some time.
You should now be able to run searches on your site.

Security

In the addListener definition in jetty.xml, add the following:

<Set name="Host">localhost</Set>

So Jetty doesn't listen to requests from the outside. If you want to still access the admin interface, use firewall scripts to hide the port from most users.

See http://wiki.apache.org/solr/SolrSecurity for more information.

Troubleshooting

"Authorization required"

When you're running midcom-exec-midcom/reindex.php, and you get "Authorization required" errors, you should modify the indexer_reindex_allowed_ips. Either set it in /etc/midgard/midcom.conf or in the host settings.

For the midcom.conf file, you need to add:

$GLOBALS['midcom_config_site']['indexer_reindex_allowed_ips'] = array('127.0.0.1','192.168.126.128','127.0.1.1');

"Indexer failed"

If you get an "indexer failed" error when reindexing the site, ensure that SOLR's data directory exists and is writable:

mkdir /usr/share/jetty/solr/data  
chown jetty /usr/share/jetty/solr/data

External tutorials

Mattias Stahre — Mon, 22 Feb 2010 01:27:06 +0000

IBM DeveloperWorks Tutorial
A nice tutorial on Midgard. Written by David Seager, a software engineer at IBM, the article describes setting up a basic Midgard site. The article also does a good job of setting up a general context for what Midgard is and how it works.
http://www-106.ibm.com/developerworks/library/w-midgard/

New Architect on Midgard
The May 2000 issue of New Architect (then Web Techniques) carried an introductory article and tutorial to Midgard by Brian Jepson.
http://www.webtechniques.com/archives/2000/05/jepson/

Midgard tutorial in German
3rd Evolution's tutorial on Midgard and Nadmin Studio on Mandrake Linux. In German.
http://www.3rd-evolution.de/docs/misc/midgard/

Reference manuals

PHP Manual
The PHP programming language manual and API reference.
http://www.php.net/manual/

MidgardWiki @ Content Control
Wiki collecting Midgard site building information.

PHP midgard object method delete_attachments

Tero Heikkinen — Fri, 19 Feb 2010 14:08:14 +0000

Delete object's attachments.

boolean delete_attachments(array args);

This method takes one argument:

args, associative array

Array's keys must be midgard_attachment properties' names, values should define constraints with properties's values.

Delete all attachments with matching properties' values. It's possible to undelete attachment which have been deleted with this method.

Blobs that are linked to attachment are not deleted because one blob can be linked to many attachments. Blobs are deleted with blob's remove_file function

Returns TRUE on success, FALSE otherwise.

Example

<?php

/* Delete all image attachments */

 try {
     $style = new midgard_style($guid);
 } catch (Exception $e) {
     echo $e->getMessage();  
 }

 $args = array ("mimetype" => "image/jpeg");

 if($style->delete_attachments($args))
     echo "Deleted all image attachments";

 ?>

midgard object attachments

midcom.services.indexer installation

Eero af Heurlin — Mon, 15 Feb 2010 15:10:31 +0000

These are instructions for installing and setting up the MidCOM full-text search system.

This is very old information, see How to set up site search using Solr in stead

General Structure

The Indexer is not directly indetrated into PHP. On one hand, the performance in a persistently running indexer daemon is (on average) better, than a fully integrated solution. On the other hand, there is just no really usable PHP-level On-Demand Indexer out there anyway (not that I would trust PHP far enough in this respect.

The structure of the index is further described in the mRFC 9. See there how Documents and Fields interact.

This document will focus on setting up and using the Indexer.

Setting up the Lucene Daemon

All required files of the current CVS state are available for Download on the required indexer files page, but if you want an up-to-date build of the system, follow these instructions:

Building and Installing the Daemon

Go to the Lucene Website and download the latest Lucene binary tarball. In it you will find a file named lucene-$version.jar. Rename it to a plain lucene.jar. (Use version 1.4.3 found here http://apache.fi/lucene/java/archive/)
Go to the external-tools/indexer-backends/lucene directory of the current MidCOM CVS. Copy the lucene.jar file into this directory and run make there, it will build a file named indexer.jar.
Create a directory and copy the files lucene.jar, indexer.jar, xml-communication-request.dtd and xml-communication-response.dtd into it.

Running the Daemon

Go to the newly created directory, with an user account that has write permissions to this directory. Run:

/usr/bin/java -jar indexer.jar (or wherever you have java)

You should be fine from that point, the daemon will listen to 127.0.0.1:2222, which is the default setting from the MidCOM side too.

The Daemon will run in foreground by default, unless you launch it with some nohup wrapper. For the init-script (for debian), see "To make indexer run as a init.d script" section at the bottom of this page.

Changing Configuration

The daemon will take a filename during startup as first command line argument. A full configuration file looks like this:

logfile = 
loglevel = WARNING
bind = 127.0.0.1
port = 2222

What I wrote here are the defaults, log warning level messages to stderr (no log file) and bind to 127.0.0.1:2222. Check java.util.logging.Level for valid logging levels.

You should be fine using the defaults though.

Configuring MidCOM to use the Indexer

This is relativly easy, and consists of three tasks:

Activate the indexing feature in the MidCOM configuration

As usual, you will find all detailed information in the MidCOM API docs, section midcom_config.php. As long as you stick to the default configuration, it is enough to activate the XMLTCP indexing backend during MidCOM startup:

$GLOBALS['midcom_local_config']['indexer_backend'] = 'xmltcp';

Two more configuration options, indexer_xmltcp_host and indexer_xmltcp_port, allowing you to explicitly specify the host/port combination where the indexer runs.

Index your entire site

Unless you are building a site from scratch, you obviously have to reindex your entire website. This is done by accessing this URL with full admin privileges:

http://your.site.com/midcom-exec-midcom/reindex.php

Two important notes about this: First it will take quite some time, as the MidCOM side of the interface does not yet support batch indexing. Second, and far more important, Reindexing will take a huge amount of RAM. For example, a site with around 250 documents on it requires about 60 MB of total RAM.

Create the Indexer Frontend

Create a new topic using the component midcom.helper.search.

To make indexer run as a init.d script (on debian).

To make indexer run as a init.d script so you can use normal start & stop do the following steps. This is for Debian system. Tested in Sarge. You must perform these steps as root.

Create /usr/share/midgard/indexer/indexer in which you put the following code:

#! /bin/sh
#
# indexer

set -e

PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
DESC="MidCOM indexer"
NAME=java-indexer
DAEMON=/usr/share/midgard/indexer/$NAME
PIDFILE=/var/run/$NAME.pid
SCRIPTNAME=/etc/init.d/$NAME
ARGS="-jar indexer.jar"
APPDIR=/usr/share/midgard/indexer

# Gracefully exit if the package has been removed.
test -x $DAEMON || exit 0

# Read config file if it is present.
#if <span class="wiki_missing_nouser" title="Login to create this missing page"> -r /etc/default/$NAME </span>
#then
#   . /etc/default/$NAME
#fi

#
#   Function that starts the daemon/service.
#
d_start() {
    start-stop-daemon --start --make-pidfile --pidfile $PIDFILE \
        --chdir $APPDIR --background --quiet \
        --exec $DAEMON -- $ARGS
}

#
#   Function that stops the daemon/service.
#
d_stop() {
    start-stop-daemon --stop --quiet --pidfile $PIDFILE
}

#
#   Function that sends a SIGHUP to the daemon/service.
#
d_reload() {
    start-stop-daemon --stop --quiet --pidfile $PIDFILE --signal 1
}

case "$1" in
  start)
    echo -n "Starting $DESC: $NAME"
    d_start
    echo "."
    ;;
  stop)
    echo -n "Stopping $DESC: $NAME"
    d_stop
    echo "."
    ;;
  #reload)
    #
    #   If the daemon can reload its configuration without
    #   restarting (for example, when it is sent a SIGHUP),
    #   then implement that here.
    #
    #   If the daemon responds to changes in its config file
    #   directly anyway, make this an "exit 0".
    #
    # echo -n "Reloading $DESC configuration..."
    # d_reload
    # echo "done."
  #;;
  restart|force-reload)
    #
    #   If the "reload" option is implemented, move the "force-reload"
    #   option to the "reload" entry above. If not, "force-reload" is
    #   just the same as "restart".
    #
    echo -n "Restarting $DESC: $NAME"
    d_stop
    sleep 1
    d_start
    echo "."
    ;;
  *)
    # echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
    echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2
    exit 1
    ;;
esac

exit 0

If you do not already have PEAR XML_Parser, you need to also get that:

pear install xml_parser

Copy indexer.jar, xml-communication-request.dtd, xml-communication-response.dtd, lucene.jar in /usr/share/midgard/indexer/

Make sure you have Java runtime installed. Create symlink so that /usr/share/midgard/indexer/java-indexer points to java.

ln -s /opt/j2re/bin/java /usr/share/midgard/indexer/java-indexer

The process we will be running will then be called java-indexer so this wont mess up with other java processes.

Create symlink:

ln -s /usr/share/midgard/indexer/indexer /etc/init.d/indexer

To make it automatically start and stop on startup/shutdown:

update-rc.d indexer defaults

Have fun indexing!

Debian

Jarkko Ala-Louvesniemi — Thu, 04 Feb 2010 11:19:33 +0000

Debian packages are now built using OpenSuse Build System.

Add OBS repository to /etc/apt/sources.list:

deb http://download.opensuse.org/repositories/home:/midgardproject:/ragnaroek/Debian_5.0/ ./

Or for Debian Etch:

deb http://download.opensuse.org/repositories/home:/midgardproject:/ragnaroek/Debian_Etch/ ./

To get rid of this:

W: GPG error: http://download.opensuse.org ./ Release: The following signatures couldn't be verified because the public key is not available: NO_PUBKEY DFD08130B9E2252E

...Download Release.key and import it, e.g.:

wget http://download.opensuse.org/repositories/home:/midgardproject:/ragnaroek/Debian_5.0/Release.key

cat Release.key | apt-key add -

Download packages and install them manually, if packages can not be installed with apt-get.

Run these commands when repository is added:

apt-get update
apt-get install midgard

Try to install midgard-debian package if midgard is not installable.

If latter fails:

apt-get install midgard-data php5-midgard

Old stable 1.8 generation "Thor":

deb http://download.opensuse.org/repositories/home:/midgardproject:/midgard18/Debian_Etch/ ./

Kerberos single sign-on with Active Directory

Eero af Heurlin — Thu, 21 Jan 2010 12:33:36 +0000

Kerberos authentication is a third party authentication mechanism supported by Midgard. It allows users to log in to Midgard using their LDAP or Active Directory accounts. In Kerberos authentication users may log in to Midgard in the normal way or using single sign-on method.

Basic kerberos configuration on midgard server

Install mod_auth_kerb.

Configure /etc/krb5.conf

[libdefaults]
    default_realm = KERBEROS.REALM

[domain_realm]
    apache.server.fqdn = KERBEROS.REALM

[realms]
    KERBEROS.REALM = {
        kdc = kdc.kerberos.realm
        }

Test configuration

$ kinit username
$ klist

If you get ticket from the kerberos server, you should be fine to continue. Otherwise you might find the troubleshooting section, in the end of this document, useful.

Creating keytab for single sign-on

First you must create a user account on the kerberos domain controller server. The user account must not be disabled and the password must stay the same. Otherwise you might need to recreate the keytab. In this example the user account name is "apache_server" and has password "apache_password".

Windows Server 2003:

C:\Program Files\Support Tools>ktpass -princ HTTP/apache.server.fqdn@KERBEROS.REALM -mapuser apache_server -crypto DES-CBC-MD5 -ptype KRB5_NT_PRINCIPAL -mapop set +desonly -pass apache_password -out name.keytab

Windows Server 2000 (not tested):

C:\Program Files\Support Tools>ktpass -princ HTTP/apache.server.fqdn@KERBEROS.REALM -mapuser dummyuser -crypto DES-CBC-MD5 -pass password -out name.keytab

Install support tools to optain ktpass.exe. After creating the keytab you propably need to reset the password because of the new crypto type. You need to use the same password.

apache.server.fqdn = the site url you are going to use. The url must be resolvable by the kerberos and midgard server to the midgard server ip-address.

Place the keytab file on the midgard server and give apache user read rights to the file.

Test the keytab:

$ kinit -k -t /etc/name.keytab HTTP/apache.server.fqdn
$ klist

If you get ticket from the kerberos server, you should be fine to continue. Otherwise you might find the troubleshooting section, in the end of this document, useful.

Configuring midgard vhost

Below is a configuration for a kerberos SingleSignOn authentication which fallbacks to a kerberos password authentication.

Servername apache.server.fqdn
MidgardAuthType trusted

<Location "/">
    AuthName "Kerberos Authentication"
    AuthType Kerberos
    KrbAuthRealms KERBEROS.REALM
    Krb5Keytab /etc/name.keytab
    KrbMethodNegotiate on
    KrbMethodK5Passwd on
    Order Allow,Deny
    # Allow cron scripts etc from local machine
    Allow from localhost
    Allow from apache.server.fqdn
    # Require kerberos for others
    Require valid-user
    Satisfy any
</Location>

Browser support for single sign-on

Firefox:

Go to about:config edit network.negotiate-auth.trusted-uris and add http(s)://(site)

IE6:

Add the site to trusted sites. Make sure that "Enable Integrated Windows Authentication" is on

Troubleshooting and useful links

In midgard server the site url must be /etc/hosts as a first entry for the ip in question:

172.0.0.1       locahost.localdomain localhost
'ip-address'    apache.server.fqdn apache

The midgard server must be in same time with the kerberos server. You can use ntp or ntpdate for this.

GSS failure "Key version number for principal in key table is incorrect"

If you reset the password after creating the keytab you will need to create a new one, even if kinit does not complain the Kerberos server will refuse to serve authentication requests for the "old" keytab.

Links:

Setting Up a Midgard Database

Jarkko Ala-Louvesniemi — Tue, 05 Jan 2010 21:38:21 +0000

After the Midgard Framework is installed, run the Datagard command. Before doing this, ensure that the Midgard module in enabled in the php.ini file used by PHP CLI.

$ datagard

When you run datagard for the first time, and midgard-data can not connect to MySQL server, you will be asked about the MySQL administrator name and password.

By default datagard tries to connect to database with currently logged in username and with empty password. You should change MySQL's administrator password, if connection has been succesfully established without password . It's highly recommended for production servers

Midgard 8.09 Ragnaroek

By default, datagard installs new database named 'midgard'. To install new database, run datagard without any arguments:

datagard

If you need to create another database with self tuned configuration values, create own Midgard unified configuration and specify this configuration as datagard argument:

datagard -c myconfiguration

You will be asked very few questions, like hostname or host's port. Datagard provides sensible defaults which should be suitable in many cases.

This initial setup will create:

Database
Midgard Domain (Sitegroup)
Apache Virtual Host
Midgard Virtual Host
Initial website with default style

Default Midgard Domain (sitegroup) administrator's username is admin. Password: nowadays randomized so please change it to something you remember or write it down.

If you install Midgard for the first time, and datagard ask you for Midgard root username and password - use recommended, default values.

Midgard 1.8

Select "install" from the datagard menu:

You will be asked about the database name which you would like to create:

Right after that you will be asked about the Midgard database username and password. This data is used to create a MySQL account and to connect websites with the MySQL server.

All midgard packages which are included in midgard-data will be imported to the database. (Depending on your hardware, it may take from a few minutes up to twenty minutes.)

If You need and want to create a virtual host, answer "yes". This is important. If you say "no", midgard-data won't update your database to be ready to use with the Apache server, and you will be forced to update your database manually.

Read Creating a New Virtual Host for instructions on creating the virtual host.

PHP midgard_object_class

Jarkko Ala-Louvesniemi — Mon, 04 Jan 2010 10:33:09 +0000

This is Midgard 1.9/2.0 API

midgard_object_class is semi or pseudo class because it doesn't have any properties registered. Besides it's not even usefull to create its new instances. It's implemented as class with static methods for better readability.

factory - Create new MgdSchema instance
undelete - Undelete MgdSchema object
is_multilang - Returns boolean value whether the MgdSchema object/class has multilingual properties
get_object_by_guid - Creates MgdSchema instance identified by given guid
get_property_up - Get class' up property
get_property_parent - Get class' parent property
connect_default - Connects a callback to event

Ubuntu

harty zeidt — Wed, 18 Nov 2009 13:21:43 +0000

Ubuntu packages are available (among other distribution) on OpenSuse Build System.

There's also repository mirror on Midgard website. Add ubuntu repository to /etc/apt/sources.list:

deb http://download.opensuse.org/repositories/home:/midgardproject:/ragnaroek/xUbuntu_9.04/ ./

Check the version number of your Ubuntu and change URL accordingly

Update packages info and install.

apt-get update

apt-get install midgard

And then just proceed to set up your database and website.

Midgard release names

Piotr Pokora — Tue, 20 Oct 2009 15:37:12 +0000

The Midgard releases have usually been named after some current event in the community. If no fitting events have been around, then names have been taken from Viking mythology.

Midgard 1.0 Land Rover series

The first public release of Midgard was named after the 1962 Land Rover jeep of Eero af Heurlin that Midgard originators Jukka Zitting and Henri Bergius used on several trips, and which always broke and needed to be pushed from places. The Land Rover also had its own theme song.

Midgard 1.1 Iron River series

Iron River was named after the award-winning Rautajoki LARP arranged by Harmaasudet Ry in Finland. Midgard developer Jukka Zitting delayed the 1.1 release substantially by leaving to build the Viking village needed for the game near town of Hollola.

Midgard 1.2 Mad King series

Midgard 1.2.x was a long-running Midgard release series started in summer 1999 and ended in December 2000.

Mad King was the name of a medieval theatre play where Jukka Zitting took part.

Midgard 1.4 Bifrost series

Introduced in December 2000, Midgard 1.4 series introduced features like attachments and site groups, and was the first series where PHP did not need to be patched for Midgard.

Bifrost is the bridge leading from Midgard, the world of men into Asgard, the world of gods. 1.4.0 was thought to be paving the way for the Midgard 2 release.

1.4.3 Rough Landing

The 1.4.3 release was named after Emile Heyns' parachuting accident in April 2002 that left Torben Nehmer as the new release manager. Luckily Emile has returned to the skies since.

1.4.4 Happy Christmas

This major bugfix release was make in Christmas 2002. 1.4.4 was the last release of the 1.4 series.

Midgard 1.5 Biergarten series

The 1.5 series were named after the famous Biergartens of Munich, the city where the summer 2003 Midgard developer meeting was held.

Midgard 1.6 series

1.6.0beta Five Years

The 1.6.0beta release was timed for the Fifth Anniversary Party of the project held on May 2004 in Poznan, Poland.

1.6.0rc1 Black Wolga

Released on September 22th 2004 and apparently named after the Russian Volga cars.

1.6.0rc2 Night Boat

Released on October 19th 2004.

1.6.0 Swedengard

Swedengard was a Midgardization of Sweden, the location of then-upcoming Midgard developer meeting.

1.6.1 Sverix

Sverix is short for Sweden Fix, for release containing bug fixes made during a developer meeting in Linköping, Sweden.

1.6.2 Amerigard

Amerigard was a play on the We all live in Amerika song by Rammstein that was popular and playing constantly during the November 2004 Midgard developer meeting in Sweden.

1.6.3 Threadened by Patents

1.6.3 was the first release supporting PHP built with the Zend threat safety features enabled. At the time the European software patent controversy was also raging.

Midgard 1.7 series

Started in early 2005, Midgard 1.7 series was finally the stage where Midgard 2 features were introduced into Midgard for real.

1.7alpha1 Leoni & Akseli

The release was named after Leonie and Akseli, the newborn children of Midgard developers Daniel Reichenbach and Henri Kaukola.

1.7beta1 FlyHigh

The 1.7beta1 release was named for Private Pilot License training's first solo flight by Henri Bergius, a Midgard developer.

1.7rc Patent Free

This release celebrated the repealing of software patents in the European union.

1.7.0 Vali

Vali was the son of Odin in the Viking mythology, and only one of the old gods to survive the last battle of Ragnarok. Similarly, 1.7 were the last Midgard series to include the classic Midgard API.

1.7.1 Plug and Pray

The 1.7.1 release fixed some severe Memory leaks in 1.7.0 when used together with Apache 2. The name is a play on the Plug and play concept of having hardware work automatically with a computer.

1.7.2 Plugged

Main aim of this release was to find any piece of code which triggers memory leaks. So when were found , Midgard was plugged.

1.7.3 Quoted

Main changes in this release: quota enchancements and new MidCOM release. Quota improvements and new quota written for MgdSchema objects forced Piotras to think about "quoted" release.

1.7.4 Kick

There were plenty of kicks before this release. Roundhouse kicks, typical kicks, non typical kicks and all those similiar kicks. Besides, this release kicked old releases and midgard-core sources. Few very old bugs were found and resolved.

1.7.5 Szybka

This release includes major stability and critical fix in Style Engine, which fixes performance problems for hosts which use template_midcom package. The key for the fix was sitegroup transparency feature.

in Polish "szybka" means:

something which is fast ( female type , but release is female type in Polish )
small part of transparent glass

1.7.6 "Fotomodelo"

Quotting Arttu Manninen:

Every situation must have a proper slogan. Midgard developer meeting was no exception. When we were going around in the night of Poznan, Poland, I asked Alessio to translate me the slogan for the night:

Non é facile essere un fotomodelo, ma qualcuno deve farlo.

It means: It's not easy to be a top model, but someone has to do it.

Midgard 1.8 series

1.8alpha1 Stylish.

December 2005. Month focused on endless threads about new style engine.

1.8alpha2 Independent

Just a few independency features :

MgdSchema objects functionality is able to replace old API
midgard-apache modules are not compiled against MySQL
midgard-php is not compiled against MySQL and Apache
Database and usable midgard hosts can be created without repligard
May,3rd is "Independency Day" in Poland ( release May,2nd )

1.8alpha3 Hot&Black

Alpha3 has been released shortly after developers meeting in Poznan, Poland. During the meeting, developers could taste something hot and black.

1.8beta1 Danke

Torben Nehmer MidCOM's Lead Developer left project a week before this release. As Torben's native language is German , community thanks him a lot with loud Danke!

1.8beta2 Sonya

Sonya is a song title. It sounds excellent when you have sauna with a good company. It has been sung during mini developer meeting in September, 2006.

1.8.0 Thor

Thor , one of the major Nordic gods. Like Thor will die during Ragnarok, old "god's" Midgard code will be removed since 1.9 Ragnarok release.

1.8.1 "42"

Release name suggested by Alexander, as the answer for all questions.

1.8.2 "Hoitsu"

Name inspired by English word 'nurse' translated to Finnish. The commercial sentence for this could also be : "Silja Line - Where nurses come true"

1.8.3 "Eight"

Eight years. Released just about for midgard's eight birthday.

1.8.4 "kaft"

"kaft" unfortunatelly can not be translated and published. It's addressed for people who doesn't respect other's properties.

1.8.5 "Refix"

Yet another bugfixex release. Some changes made in 1-8 branch has been not included in 1.8.4 release due to cvs/svn server changes and that's why "refix" describes sense of the name.

1.8.6 "The First"

Release with two major fixes. And "The First" in 2008 year.

1.8.7 "Flying pancake"

Bergie watched his favourite movie on wednesday. The one with flying pig. And, obviously there's pancake day on thursday. So I thought: "Pancakes also can fly". And I believe they do :)

1.8.8 "Lingua Grata"

As we implemented very desired Midgard multilingual improvement.

1.8.9 "Samshoblo"

In Georgian 'samshoblo' means homecountry or motherland. Russia vs Georgia war is still on, while we make this release... Taya is from Georgia, and we are glad she and her family are fine.

Midgard 8.09 series

8.09.0 "Ragnaroek"

First stable release made with new releasing policy plans in mind. "Ragnaroek" is a final battle before new world come. This Long Term Supported generation includes legacy and almost the whole Midgard2 API to let developers build better software. Released on October, 7th, 2008. Six months before first stable Midgard2 release and only week later after schedule.

8.09.3 "New Year's diet"

8.09.3 provided many internal improvements and enchancements. Among many changes, we decided to drop internal MidCOM's class inheritance support in favor of using decorator pattern. As we planned to release before Christmas, we wanted to name it "Christmas decorators", but unfortunately we made release at the beginning of 2009. Faster, lighter. Like with good diet. New Year's one :)

8.09.6 "AmsterGard"

This version has been released few days after Maemo Summit which has been held in Amsterdam and many Midgardians participated in this event.

Midgard 9.03 series

2.0alpha1 "Wet Dog"

First initial release's codename was 'at last', but Jerry came to rescue during developer's meeting in Linkoping (which happened two weeks before release). He (as everyone else) has been drinking delicious honey&oak beer and then he tried a regular light lagger beer. Try to do the same and say how latter beer tastes :)

Fedora and EL

Jarkko Ala-Louvesniemi — Fri, 25 Sep 2009 13:06:53 +0000

Fedora and EL (RHEL/CentOS) packages are available (among other distributions) on openSUSE Build Service.

At the openSUSE Build Service download server, go to the directory of your OS version and copy the URL of home:midgardproject:ragnaroek.repo. Then run the following commands:

cd /etc/yum.repos.d/
wget <paste the URL here>
yum install midgard

Note for EL (RHEL/CentOS) users: Please note that the default rpm installation of Midgard requires that you have enabled Fedora EPEL.

After you've installed the rpm packages, proceed by running the Datagard install action which sets up Midgard CMS for you:

datagard -a install

More information about Midgard installation in general is available in the Midgard Installation Manual.

Creating a New Virtual Host

Jarkko Ala-Louvesniemi — Fri, 25 Sep 2009 10:32:54 +0000

Midgard 8.09 Ragnaroek

Please note that the Datagard's install action already created one vhost for you. If you need to create additional vhosts, read on.

To create new virtual host with datagard, define Midgard unified configuration and correct vhost action. If Your configuration is stored as myconfiguration, run this command:

datagard -c myconfiguration -a vhost

If you need to create vhost for default 'midgard' named configuration, define only action.

datagard -a vhost

During setup, datagard will ask you about sitegroup for which you want to create virtual host. If you want to create new sitegroup as well, type new name for sitegroup. In such case, datagard will create new sitegroup and then virtual host. If you need to create host for internal sitegroup, define sitegroup as SG0 explicitly.

Midgard 1.8

Type Virtual Host name in dialog box. There is no need (and you should not name your host with http:// or https:// protocol type). You may also define port which will be used for this virtual host. If your site is going to be served at port 80, you don't have to define the port. In any other case you should define the host with the port, like www.midgard-project.org:8001.

Congratulations! Your Midgard database and virtual host are now configured. *
Please, stop and start httpd now and log in to Midgard site.

In some cases the default virtual host configuration generated by Datagard is not correct or sufficient for your situation, for example when you are creating a SSL host or when you don't want the document root to change (datagard sets DocumentRoot under /var/lib/midgard/vhosts/ by default). You can edit the configuration manually in /etc/midgard/apache/vhosts/hostname_port. (Replace "hostname" with your virtual host name and "port" with the port of the virtual host. The port is 80 if you did not specify it.)

Some Midgard PHP applications depend on certain PHP settings. Here's a list of the needed PHP settings which should be set in the virtual host configuration (if not set in php.ini):

# Global virtual host level PHP settings for all Midgard applications  
#  
# Required for uploading attachments  
php_admin_flag file_uploads On  
# Required by majority of the Midgard PHP applications  
php_flag magic_quotes_gpc Off  
# Required by MidCOM <= 1.4 (comment this out with newer releases)  
php_flag short_open_tag On  
# Recommended at least for MidCOM AIS (8M is the minimum requirement)  
# (change and enable if you want to set different value than in php.ini)  
#php_value memory_limit 8M  
# Maximum size of POST data (affects attachment uploads)  
# (change and enable if you want to set different value than in php.ini)  
#php_value post_max_size 8M  
# Maximum size for uploaded files (affects attachment uploads)  
# (change and enable if you want to set different value than in php.ini)  
#php_value upload_max_filesize 2M  

# Location specific PHP settings for certain Midgard applications  
#  
<Location /spider-admin>  
 php_flag register_globals On  
</Location>  
<Location /aegir>  
 php_flag short_open_tag On  
 php_flag register_globals On  
</Location>

Once your VirtualHost is up and running you should be ready to set up the website using the Midgard Site Wizard.

If you need to later edit the configuration see Midgard Apache directives.

Installing MidCOM with PEAR

Jarkko Ala-Louvesniemi — Fri, 25 Sep 2009 08:54:35 +0000

MidCOM releases are shipped as PEAR packages for better version management and control. The packages utilize a MidCOM-specific channel in ragnaroek.pear.midgard-project.org.

Midgard 8.09 "Ragnaroek"

Datagard in Midgard 8.09 performs all required steps to initialize all channels (Ragnaroek, Pearified, etc) and install all initial base packages. If you are only interested in installing PEAR packages, run datagard with desired action type:

datagard -a pear

Keep in mind, that pear action removes old midcom if found, and install new packages from new channel.

Useful informations:

Ragnaroek channel url: ragnaroek.pear.midgard-project.org
Ragnaroek channel alias: ragnaroek

If, for some reason, some package is not installed or it's not included in base packages, install it manually:

For Midgard >= 8.09.6:

datagard -a pear -p package_name

For Midgard < 8.09.6:

pear install ragnaroek/package_name
datagard -a dbupdate

Midgard 1.8

MidCOM installation

Upgrade your PEAR installation. MidCOM installation requires PEAR 1.4 or newer.
```
# pear upgrade PEAR
```

If it complains that you at least some version of PEAR to upgrade to the latest version install the requested version first with `pear upgrade PEAR-`

Add the needed channels for package installation

# pear channel-discover pearified.com
# pear channel-discover pear.midcom-project.org

Install and configure the needed PEAR role files

# pear install pearified/Role_Web
# pear config-set web_dir /usr/share/midgard/midcom/static


# pear install midcom/Role_Mgdschema
# pear install midcom/Role_Midgardelement
# pear install midcom/Role_Midgardsql

Install MidCOM and some required packages
```
# pear install -f midcom/midcom
```

If you get a _Fatal error: Allowed memory size exceeded_ error with any of the packages you have to increase PHP's memory limit. The file to edit is either `/etc/php/php.ini` or `/etc/php/cli/php.ini`. Memory limit is also settable with -d argument for php command ( php -d memory_limit=40M ).

Once you have installed new packages you need to stop and start Apache to get the MgdSchema files supplied with them loaded.

Layout template installation

Packaged layout templates utilize the Role_Midgardelement package for installation. To make installation work, you have to:

Create an unified Midgard configuration file to /etc/midgard/conf.d/midgard
Point the Midgardelement role to the configuration file
```
# pear config-set midgard_config_file midgard
```
Install the style template you want, for example
```
# pear install ragnaroek/template_Kubrick
```

After these steps you should have a fully functional MidCOM installation in the PEAR path.

Installing additional components

Other component packages can be installed using the PEAR command, for example:

# pear install ragnaroek/net_nehmer_blog

The list of available components can be found on the PEAR channel website

Installing Midgard from Distribution Packages

Jarkko Ala-Louvesniemi — Fri, 25 Sep 2009 08:21:57 +0000

Supported distributions and operating systems:

Check new packages at openSUSE Build Service. If your distribution is missing, you will have to follow the source installation instructions.

Our goal is to provide packages for all major distributions. Package maintainers for new distributions are always more than welcome. You don't have to be a specialist. We build packages using openSUSE Build Service, so no dedicated machines are required. What is needed is your will and basic packaging skills (not always even that because sometimes we just need to have a test user for a particular platform). Contact the developers if you want to join our distribution/binary package team.

openSUSE and SLE

Jarkko Ala-Louvesniemi — Fri, 25 Sep 2009 08:09:12 +0000

OpenSUSE and SLES/SLED packages are available (among other distributions) on openSUSE Build Service.

Midgard Documentation

Jarkko Ala-Louvesniemi — Fri, 25 Sep 2009 08:06:28 +0000

Midgard Documentation is a Wiki collecting information about features, usage and development of Midgard, the Open Source Content Management System. See latest Wiki changes.

Installing Midgard

Distribution packages - Midgard installers for distributions like Debian, Fedora/EL, openSUSE/SLE, Ubuntu and Mac OS X
Source installation - Compile Midgard on any Unix platform
Database setup - Creating a new Midgard database with Datagard
Virtual Host creation - Setting Midgard to answer in different domain names
MidCOM installation - Installing the MidCOM component framework with PEAR
Troubleshooting - Common problems and solutions
Upgrading Midgard - How to upgrade an existing Midgard installation
Authentication settings - Setting Midgard to authenticate using third-party sources like LDAP or Active Directory
Performance tuning - High performance setups with Midgard

Getting started

MidCOM content editing - Managing content in Midgard
Groups and People - Managing users in Midgard
Administration interfaces - Applications for managing Midgard

Site building

Style creation - Creating custom layout templates
Dynamic loading - Including content from different site areas into a page
Custom navigation - Using the NAP system to build custom site navigation
Multilingual sites - Making your site support multiple languages
Approvals and scheduling - Adding workflow to your site
Component configuration - Tweaking components of your website
Content schemas - Customizing the fields of your content editors
Error pages - Customizing error pages

Application development

Component development - Developing your own PHP components
Eclipse usage - Using the Eclipse IDE for component development
Coding Standards - Standards for formatting Midgard PHP code
MgdSchema objects - Data handling API
Query Builder - Database object query API
Midgard core in PHP - Midgard core PHP API
Collector - Optimized database query API that doesn't return objects
Datamanager API - Making your content fields customizable
Feed creator - Adding RSS and Atom feeds into your components
Complete API reference
Midgard core C documentation
Midgard in Python - Midgard Python
Midgard in ObjectiveC - Midgard in ObjectiveC and on the Mac
Midgard App Builder - Midgard package for building Fluid applications.

Midgard concepts

MidCOM - Midgard's Component Framework for PHP
URL handling - How Midgard maps URLs to the database
Permissions - How Midgard handles permissions
Templating Engine - How Midgard's page composition works
Sitegroups - Virtual Hosting Databases in Midgard
Quota - Setting disk quotas in hosting environments
Internationalization - Support for multiple languages and character sets
File attachments - Support for binary files
MgdSchema - Database object abstraction
Metadata object - Centralized metadata system
Formatting engine - Registering and using content formatting functions in HTML
Exorcist - Replication and cross-CMS content migration
UnitTesting - Writing unittests for the php API
Midgard Wizards - tool for creating new organizations and websites into Midgard

Midgard tools and configuration

Command line tools - Running midgard from command line, debug, testing and other tools
Unified configuration - Configuration with ini like files and reusing them between applications

Other information

Glossary - Getting hang of Midgard terminology
Localization - How to translate Midgard to your own language
External tutorials - Midgard information elsewhere on the web
Documentation contribution - How to contribute content to this wiki
Authors - Wiki contributors
Folklore - Cultural points about the Midgard project

The Midgard Wiki software makes it easy for community members to add more documentation to this site. The whole documentation is open content available under the Creative Commons Attribution-ShareAlike license.

Mac OS X

Jarkko Ala-Louvesniemi — Fri, 25 Sep 2009 07:49:16 +0000

Midgard for MacPorts

Midgard is being maintained as part of the MacPorts collection. MacPorts is a Mac version of the BSD Ports collection that enables easy installation of preconfigured source packages. More information about MacPorts is available in their wiki.

To install Midgard with MacPorts you need the Apple Xcode Tools. Once you have both MacPorts and Xcode installed, open Terminal and run:

$ sudo port sync
$ sudo port install apache2
$ sudo port install mysql5 +server
$ sudo port install php5 +apache2 +pear +mysql5
$ sudo port install midgard-data

Then you need to initialize and start the MySQL and Apache processes:

$ sudo launchctl load -w /Library/LaunchDaemons/org.darwinports.mysql5.plist
$ sudo launchctl load -w /Library/LaunchDaemons/org.darwinports.apache2.plist

After that you should be able to set up the database and virtual host normally.

As these instructions are not very complete, feel free to ask Jyrki Wahlstedt (jwa (at) macports (dot) org).

Datagard

Jarkko Ala-Louvesniemi — Mon, 21 Sep 2009 16:31:51 +0000

Datagard is the command-line tool for managing Midgard installations.

Basic and easiest setup can be done by just running datagard command. In both Midgard series: 1.8 and 8.09, datagard will ask you questions, and guide you step by step through setup process.

Documentation

Main datagard routines include:

Advanced usage

Midgard 8.09

Command line switches:

-t type of the setup
- quick, datagard tries to determine sensible defaults for all configurations (this is usually a good choise for upgrades as then datagard reads the settings from the configuration file)
- wizard (the default if you don't specify type), datagard asks about every single configuration option
-c specifies user defined configuration file name (the default is midgard if you leave out -c)
-a action type selection. Possible actions are:
- install (the default if you don't specify action - installs the database and the Midgard PEAR packages, and then creates a virtual host)
- upgrade (upgrades the database and the Midgard PEAR packages)
- vhost (creates a new virtual host - this operation requires that the database contains a style template for the vhost - style templates are imported to the db during the install action)
- midcom3vhost (creates a new virtual host for MidCOM3 - not recommended for end users)
- dbinstall (installs a new database and its configuration file - remember to specify the database name using the -c option if you already have a database called "midgard" - keep in mind that this action doesn't import style templates to the db like the install action does)
- dbupdate (updates the database structure)
- pear (installs/upgrades Midgard PEAR package(s) - needs Midgard version to be at least the same as the version of the PEAR packages, because the database structure isn't updated beforehand)
- sitegroup (creates a new domain/sitegroup)
- config-set (sets configuration setting value - datagard's internal action - not recommended for end users because you can edit the configuration manually which is much easier :))
-p package (application/component) name(s) (when installing a new site with application like OpenPSA: datagard -a install -p openpsa) (when installing/updating (a) new component(s) like midcom_helper_search to an existing Midgard CMS installation: datagard -a pear -p midcom_helper_search)
-s setting and its value for the config-set action (datagard's internal option - not recommended for end users)
-v sets verbose level, numeric option (the default value is 0)

Permissions in Midgard

Scerbatiuc Ion — Thu, 20 Aug 2009 13:05:33 +0000

Several websites can be managed independently in Midgard thanks to Sitegroups. As for access to various parts of a site, Midgard's permission system is based on Group ownership, and controls only write access to the database records.

Groups are organized into a tree structure. Persons may belong to any number of Groups thanks to the member records.

The realm field in the Sitegroup table is a string which contains the Sitegroup name, and is used instead of the name field in the authentication window opened by your browser. The name field is an identifier which cannot contain whitespace.

Read Access

When authentication is required, read access to any record within a Sitegroup is granted to all the users in that Sitegroup. More comprehensive read-level access control is available through the MidCOM framework.

In MidCOM 2.4 and earlier releases, read-level access control was implemented using the ViewerGroups feature. In MidCOM 2.5 it uses Access Control Lists.

Write Access

Write access - which includes creation, modification and deletion - is granted to any user who is either a member of the owner Group the record belongs to, or a member of a Group which owns a parent of that record.

In other words, users get write privileges for any sub-tree whose parent node owner is a Group they belong to.

Users, and Articles authors and lockers

Users have full read access for their Sitegroup and Sitegroup 0. Their write privileges depend on the Group(s) they belong to.

In addition to this, being the author of an article grants write access to it.

An article may also be locked. Anyone with write permission to an Article record may lock it, but once it is locked, only the locker and the Sitegroup administrator can unlock it. This is illustrated in the following diagram:

Person has write access to

P1 T1, A1, T3, A3
P2 T2, A2, T4, A5, T5
P3 T3, A3, A5
P4 T3, A3, A4
P5 T4, A5
P6 T4, A5, T1, A1, T3, A3

Preferences

Preferences enable you to personalize the content of a site. They are name and value pairs attached to a person, and they may be grouped by domain. This feature is deprecated, as you can achieve the same thing thanks to the Parameter table and functions.

MidCOM

Michel Gaudry — Mon, 22 Jun 2009 21:46:32 +0000

MidCOM is component framework for PHP running on top of the Midgard framework. MidCOM provides a full content management system based on a series of components. MidCOM users can build their websites by "clicking together" a directory hierarchy, each folder being managed by the appropriate component.

MidCOM components are distributed as PEAR packages that allows easy installation and maintenance of the environment.

Tutorials

Documentation

Services

Component base classes
Database Abstraction Layer (DBA)
Authentication and Access Control
Indexing and full-text search
Internationalization and translation
Output caching system
On-Site toolbars service
Site navigation and structure management
Site-wide content metadata and approval
Revision Control System (RCS)
Site template
Dynamic loading of content
Site creation wizard
Automatic administration interface
Debug logging system
Style templating system

Many of the services in MidCOM are controlled by the global MidCOM configuration settings and are available through the $_MIDCOM superglobal.

Components

MidCOM ships with a collection of premade components. In addition, it is easy to build new specific components using the component base classes.

See the list of components

Libraries

Besides regular PEAR libraries used by several MidCOM components, MidCOM also provides a system for creating pure code components to provide libraries and widgets integrated into the MidCOM services.

See the list of libraries

Documentation

How to set up site search using Solr

About Solr

Using solr-tomcat5.5

Using Jetty

Dependencies

Installing Jetty

Installing Solr

Security

Troubleshooting

"Authorization required"

"Indexer failed"

External tutorials

Reference manuals

PHP midgard object method delete_attachments

Example

midcom.services.indexer installation

Recommended Reading

General Structure

Setting up the Lucene Daemon

Building and Installing the Daemon

Running the Daemon

Changing Configuration

Configuring MidCOM to use the Indexer

Activate the indexing feature in the MidCOM configuration

Index your entire site

Create the Indexer Frontend

To make indexer run as a init.d script (on debian).

Debian

Kerberos single sign-on with Active Directory

Basic kerberos configuration on midgard server

Creating keytab for single sign-on

Configuring midgard vhost

Browser support for single sign-on

Troubleshooting and useful links

GSS failure "Key version number for principal in key table is incorrect"

Setting Up a Midgard Database

Midgard 8.09 Ragnaroek

Midgard 1.8

PHP midgard_object_class

Ubuntu

Midgard release names

Midgard 1.0 Land Rover series

Midgard 1.1 Iron River series

Midgard 1.2 Mad King series

Midgard 1.4 Bifrost series

1.4.3 Rough Landing

1.4.4 Happy Christmas

Midgard 1.5 Biergarten series

Midgard 1.6 series

1.6.0beta Five Years

1.6.0rc1 Black Wolga

1.6.0rc2 Night Boat

1.6.0 Swedengard

1.6.1 Sverix

1.6.2 Amerigard

1.6.3 Threadened by Patents

1.7alpha1 Leoni & Akseli

1.7beta1 FlyHigh

1.7rc Patent Free

1.7.1 Plug and Pray

1.7.2 Plugged

1.7.3 Quoted

1.7.4 Kick

1.7.5 Szybka

1.7.6 "Fotomodelo"

1.8alpha1 Stylish.

1.8alpha2 Independent

1.8alpha3 Hot&Black

1.8beta1 Danke

1.8beta2 Sonya

1.8.2 "Hoitsu"

1.8.3 "Eight"

1.8.4 "kaft"

1.8.5 "Refix"

1.8.6 "The First"

1.8.7 "Flying pancake"

1.8.8 "Lingua Grata"

1.8.9 "Samshoblo"

Midgard 8.09 series