Setup and Installation


Install Dependencies

Clone the repository and install the dependencies with composer:

$ git clone
$ cd rokfor-slim
$ composer install


First, create copies of the database and settings configuration file. Rename or copy the *.local.php to *.php files:

$ cd config
$ cp database.local.php database.php
$ cp settings.local.php settings.php
$ cp redis.local.php redis.php    

The options in the settings.php file don’t need to be changed as long as you keep the directory structure. Talking about directories: Make sure, that the webserver has write access to the udb and cache folders:

public         → Webserver Document Root
| index.php    
| udb          → Storage directory, chmod r/w for the webserver
| assets
private        → Private Storage outside of webroot
| udb          → Storage directory, chmod r/w for the webserver    
config         → Configuration Files
locale         → Localization Files
cache          → Template Cache, chmod r/w for the webserver
src            → Rokfor PHP Runtime Sources
vendor         → Composer Dependencies
templates      → Jade Templates
build          → Css and Javascript Sources

Change the database settings in database.php. You need to know the User, Password, Database and Server for your MySQL Account. If you enable versioning in the configuration file, all changes of contributions are tracked. This is useful in cases you want to keep the editing history. As a downside, it will create a lot of data. If you change the log level to \Monolog\Logger::DEBUG, all sql queries are logged. The path to the log file can be adjusted in the log setting.

// Database settings

return [
  'host'      => 'localhost',                     // Server Address
  'user'      => '',                              // User Name
  'pass'      => '',                              // Password
  'dbname'    => '',                              // Database Name
  'log'       => __DIR__ . '/../logs/propel.log', // Log File for Propel
  'level'     => \Monolog\Logger::ERROR,          // Error Level
  'versioning'=> false,                           // Store Versions of  
                                                  // Contributions and Data
  //'socket'  => '/tmp/mysql.sock',               // Unix Socket, normally
                                                  // not needed
  //'port'    => 3306,                            // Port, if default not needed

About initializing the Database

Normally, the database is initialized when you log in for the first time. If no error occurs, you can skip this chapter and log into rokfor directly with the User root and the password 123.

You need to run the Propel CLI tool to populate the database. Propel needs to know how to access your database. This is done in the configuration file. Edit the connection settings in the propel.yaml file similar to the configuration file above. Change server, database, user and password and save the file:

$ pico vendor/rokfor/db/config/propel.yaml

dsn: mysql:host=SERVER;dbname=DBNAME;unix_socket=/tmp/mysql.sock;
password: PASSWORD

Now you are ready to run the Propel CLI utility with the insert parameter. The command below assumes that you are still in the directory where you checked out rokfor-slim:

$ ./vendor/bin/propel sql:insert \
--config-dir ./vendor/rokfor/db/config \
--sql-dir ./vendor/rokfor/db/config/generated-sql/

Now, the database should be populated with the correct strucuture and a default user is automatically added (Username: root, Password: 123).

Running Rokfor

PHP Server Mode

$ cd rokfor-slim (base directory of the repository)
$ php -S -t public public/index.php

Now you should be able to browse to http://localhost:8080/rf and log in with the default user root and password 123.


There are 3 important things to keep in mind when running Rokfor with Apache: - Make sure that the webserver has read/write access to the cache and public/udb and _private/udb directories. - The server’s document_root needs to point to the public directory. If you can not change this, rename the directory according to your server configuration and reconfigure the settings.php file. - mod_rewrite is also necessary to redirect all traffic over index.php.


Rokfor runs also with Nginx:

server {
    listen 80;
    index index.php;
    error_log /path/to/example.error.log;
    access_log /path/to/example.access.log;
    root /path/to/public;
    location / {
        try_files $uri /index.php$is_args$args;

    location ~ \.php {
        try_files $uri =404;
        fastcgi_split_path_info ^(.+\.php)(/.+)$;
        include fastcgi_params;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        fastcgi_param SCRIPT_NAME $fastcgi_script_name;
        fastcgi_index index.php;

There is a file called nginx_app.conf if you want do deploy Rokfor with dokku. (Still working on the documentation here!).

Contribute and build Rokfor from Source

Rokfor uses grunt to build and bower to install dependencies. Assuming you have installed node and npm:

$ npm install
$ bower install
$ grunt

The grunt task minifies the css files and creates the javascript bundles and copies all files into the public directory. Contributors to the project are very welcome!

Fork me on GitHub