Details of the configuration of Mapbender

Configuration steps

Following we describe the configuration steps of Mapbender a bit further. Configuring your Mapbender installation is made up of the following six steps:

  • Creating the database
  • Creating the database schema
  • Copying the bundles’ assets to the public web directory
  • Creating the “root” user
  • Inserting srs parameters (EPSG code definition)
  • Loading the applications of the mapbender.yml to your database

All can be done using the console utility provided by Symfony, on which Mapbender framework is built upon. There’s a mayor caveat though you should understand, before continuing:

Note

The console utility will write files in the app/cache and app/logs directories. These operations are made using the user permissions of whatever user you’re logged in with. This is also true for the app/db directory and the SQLite database within. When you open the application from within the browser, the server PHP process will try to access/write all these files with other permissions. So make sure you give the PHP process write access to these files. See last step below.

Note

Notice: The following steps assume that you are in the directory above the app directory (notice that for git installation that means mapbender/application/ else mapbender/).

cd mapbender/
or for git based installation
cd mapbender/application

Adapting the configuration file

Database connection parameters are stored together with some more configuration parameters in the file app/config/parameters.yml.

More Information: YAML Configuration (Configuration and Application files).

Creating the database

Symfony can attempt to create your database, this works of course only if the configured database user is allowed to. Call the console utility like this:

app/console doctrine:database:create

Creating the database schema

Symfony will create the database schema for you:

app/console doctrine:schema:create

Copying the assets bundles

Each bundle has it’s own assets - CSS files, JavaScript files, images and more - but these need to be copied into the public web folder:

app/console assets:install web

Alternatively, as a developer, you might want to use the symlink switch on that command to symlink instead of copy. This will make editing assets inside the bundle directories way easier.

app/console assets:install web --symlink --relative

Creating the administrative user

The first user - which has all privileges - must be created using the command:

app/console fom:user:resetroot

This will interactively ask all information needed and create the user in the database.

Alternatively, there is a silent mode you can use, if you want to use a script to install Mapbender and don’t want to be asked for all parameters:

app/console fom:user:resetroot --username="root" --password="root" --email="root@example.com" --silent

Inserting SRS parameters

Inserting Proj4 SRS parameters into a database can be done using the command:

app/console doctrine:fixtures:load --fixtures=./mapbender/src/Mapbender/CoreBundle/DataFixtures/ORM/Epsg/ --append

Importing applications from application/app/config/applications

See chapter: YAML Configuration (Configuration and Application files).

Configuration files

The basic configuration is done inside the app/config/parameters.yml file.

More Information: YAML Configuration (Configuration and Application files).

Production- and Development environment and Caching: app.php and app_dev.php

Mapbender provides two environments: a production-environment for the general operation and a development-environment in which the application can be testet. This concept follows the “environments” in the Symfony framework.

The production-environment is called with the URL http://localhost/mapbender/app.php, the development-environment with the URL http://localhost/mapbender/app_dev.php. The call with app_dev.php is and should only be available from localhost.

There are differences in the behaviour of app.php and app_dev.php:

  • The cache-mechanism of the development-environment behaves different: Not all files are cached, so that the code-changes are directly visible. Therefore is the usage of the app_dev.php always slower that the production-environment.

    In detail, the development-environment of Mapbender does not cache the CSS, JavaScript and Translation files, among others.

    The production-environment caches all theses files and puts them into the app/cache folder.

  • The development-environment gives out error-messages and stack-traces out to the user-interface. The production-environment logs them into the file app/log/prod.log.

  • The development-environment shows the Symfony Profiler. This tool logs things, that are important for developers but should not be visible for common users.

The directory app/cache contains the cache-files. It contains directories for each environment (prod and dev) but the mechanism of the dev-cache, as described, behaves different.

If changes of the Mapbender interface or the code are made, the cache-directory (app/cache) has to be cleared to see the changes in the application.