Installation

Please note that you can skip most of beneath steps by using the culturefeed_kickstart repo!

This installation guide is aimed towards Drupal site builders. Fundamental knowledge about how to install and configure a Drupal website is necessary. Additionally, you need to have a basic understanding of how to use Composer.

Although not required, we recommend to also get acquainted with:

• Drush, a command-line shell and scripting interface for Drupal
• Git, a distributed revision control system

When considered useful, the documentation refers to the relevant section of the Drupal.org community documentation or other sources.

• Getting the files
• Setting up
• Configuration

#### Getting the files

First get your copy of the module suite from GitHub. You can either download it as a zip file, or clone it with Git.

zip file

Download a zip file containing the module suite, with the "Download ZIP" button in the right sidebar on the project home page.

git clone

If you are familiar with Git, you might want to Git clone the project instead of downloading the zip file. The clone URL is also mentioned in the right sidebar on the project homepage.

The screenshot below shows the project homepage at GitHub. In the right sidebar, you can find both the clone URL as well as the Download ZIP button.

####Setting up

The next step is setting up your drupal site. Drupal 7.x is required; we recommend the latest version. You can download the latest version from the drupal site. Now you can copy the culturefeed suite into the sites/all/modules directory (depending on your setup).

version control

If you have your drupal site under version control such as git you could opt to reference the Culturefeed module suite as a Git submodule or use subtree merging. This allows you to keep the suite under separate version control.

Composer

The next step is to set up your composer file. Copy the composer.json file form the root of the culturefeed directory to the root of you drupal site. It should look like this:

{
    "name": "cultuurnet/culturefeed",
    "type": "drupal-module",
    "description": "CultuurNet culturefeed Drupal module",
    "license": "Apache-2.0",
    "require": {
      "cultuurnet/search": "~1.0",
      "cultuurnet/cdb": "~2.0",
      "cultuurnet/culturefeed-php": "~1.1"
    },
    "minimum-stability": "stable"
}

And run composer install to download the required packages.

After running composer install a vendor directory is created which contains an autoload.php file. You should include this file from your settings.php file:

require 'vendor/autoload.php'

Note that the settings.php file will only be there after installing your drupal.

####Configuration

Your drupal is set up, the culturefeed modules are available and with composer you have a vendor dir with required libraries and an autoload file included from your settings.php.

The next step is configuring the culturefeed modules. To start off, enable culturefeed_agenda if you want a search page or culturefeed_ui if you want to enable access to UiTID user settings.

Please note that UiTID takes over some of the Drupal user functionality! Because UiTID is a central account and profile service the emailadres, password etc of the user is not stored in the Drupal database anymore, only the nick. Therefore you can assign roles to users on /admin/people but not on the user /user/{id}/edit page anymore.

Culturefeed_agenda depends on the culturefeed_search module and culturefeed_ui depends on the culturefeed module. First thing to do is to set up your application keys. You have to apply for these keys, but for testing purposes use the demo key and secret from this page

The basic setup is now finished. You can continue with configuring your search by setting different pages and blocks through the use of the different modules.

---

◂ Previous: Home | Next: Module overview ▸