bin/console commands

Mapbender provides commands that can be executed via the command line. Some of the commands are provided by the Symfony components, others belong to Mapbender.

Some useful commands are described in the following document.

Make sure you are in the correct directory (above the app directory)

  • mapbender/application (installation via GitHub)

  • mapbender (installation via package)

Help command

The parameter --help displays the help message for every command, for example:

bin/console mapbender:user:create --help

Application Export, Import & Cloning

bin/console mapbender:application:export

You can export an application as JSON- or YAML-file. In the command you have to add the Url title (slug) of the application and define the export file.

For .json files (also available via browser):

bin/console mapbender:application:export mapbender_user_db --format=json > export.json

For .yaml files (only via command line):

bin/console mapbender:application:export mapbender_user_db --format=yaml > export.yaml

bin/console mapbender:application:import

You can import an application from a JSON or YAML-file. Mapbender will automatically choose a new name if the name already excists.

bin/console mapbender:application:import export.json

 Imported 1 applications
 * mapbender_user_db_imp2

bin/console mapbender:application:clone

In the application backend, you can also clone an existing application. This will generate a new application with a suffix added to the application name. For yaml applications, a _db suffix is appended, while for applications from the database, a _imp suffix is added.

bin/console mapbender:application:clone mapbender_user_yml

User administration

bin/console mapbender:user:create

Command to create a new user on the command line. User name, email and password are mandatory. User name and email have to be unique.

bin/console mapbender:user:create --help
bin/console mapbender:user:create --password <password> --email <email> <name>
bin/console mapbender:user:create --password mypassword123 --email max.mustermann@mapbender.org 'Max Mustermann'

Update user settings

Information for a user can be updated:

  • email

  • password

The user name cannot be changed.

bin/console mapbender:user:create --update --password <password> --email <email> <name>

bin/console mapbender:user:create --update --password mypassword8910 --email max.mustermann@mapbender.org 'Max Mustermann'

bin/console fom:user:resetroot

Command to create or update the root account. User name, email and password must be assigned for creation.

During the update, the unique assignment is made via the already existing ID, therefore all three parameters mentioned above can be changed.

bin/console fom:user:resetroot

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

bin/console mapbender:user:list

Command to list all existing users with their ID and user name and the time of creation.

bin/console mapbender:user:list

User #3 name: max_mustermann since 2019-10-14 12:10:44

Database

bin/console mapbender:database:upgrade

Command to update the Mapbender database.

bin/console mapbender:database:upgrade

Updating map element configs
Found 28 map elements
28/28 [============================] 100%
Updated 28 Map elements
Exiting now

bin/console doctrine:database:create

The command is used only once during installation and creates the administration database for Mapbender. The database connection can be found in the parameters.yaml file.

bin/console doctrine:database:create

bin/console doctrine:schema:create

The command is used only once during installation and creates the database schema, which means that the tables required by Mapbender are created.

bin/console doctrine:schema:create

bin/console doctrine:schema:update

The command is needed on Mapbender update. It generates the SQL needed to synchronize the database schema to the new Mapbender version.

bin/console doctrine:schema:update --complete --dump-sql
bin/console doctrine:schema:update --complete --force
  • --dump-sql

    Shows changes in the database schema.

  • --force

    Executes the changes in the database schema.

bin/console doctrine:schema:validate

Validate whether that the database is up-to-date.

bin/console doctrine:schema:validate
[Mapping]  OK - The mapping files are correct.

Print

bin/console mapbender:print:queue:next

The queued print is disabled by default because it requires some external integration setup. To run print jobs via the command line, the following parameter must be added to the parameters.yaml file and set to TRUE to enable queued printing.

mapbender.print.queueable: true

Read more about the general characteristics of queued print at Queued Print. Also here

The print assistant is then updated in the Backend of Mapbender and two new lines appear: mode and queue. Mode is set to “queue” and queue is set to “global”, if the print jobs are expected to be accessible to all colleagues. The new tab “Recent jobs” (which shows your scheduled print jobs) appears in the print client pop-up window.

To run the jobs the following commands can be used.

bin/console mapbender:print:queue:next

The command mapbender:print:queue:next executes the next print job in the queue. For a potentially infinite process, the following options can be set to 0.

bin/console mapbender:print:queue:next --max-jobs=0 --max-time=0

Optional parameters:

  • --max-jobs

    Sets a limit for the maximum number of processed jobs.

  • --max-time

    Sets a limit for the maximum time for the command to process.

bin/console mapbender:print:queue:rerun

This command reruns a print queue job. The ID for the job must be set.

bin/console mapbender:print:queue:rerun 1

Starting processing of queued job #1
PDF for queued job #1 rendered to /data/mapbender/application/app/../web/prints/mapbender_20191104103745.pdf

bin/console mapbender:print:queue:dumpjob

This command dumps the queued print job from the database to JSON or YAML. The ID of the print job is required. This ID can be determined from the open print queue in the Mapbender application.

    bin/console mapbender:print:queue:dumpjob [options] [--] <id>

bin/console mapbender:print:queue:dumpjob 2 > print_configuration.json

    bin/console mapbender:print:queue:dumpjob 2
{
    "template": "a4portrait",
    "quality": "288",
    "scale_select": "25000",
    "rotation": "-20",
    "extra": {
        "title": "My Title"
    },
    "layers": {
        "0": {
            "type": "wms",
            "sourceId": "8",
            "url": "https:\/\/osm-demo.wheregroup.com\/service?_SIGNATURE=31%3AIHZNT0zPZhFG95dN3QOzsizaDwA&TRANSPARENT=TRUE&FORMAT=image%2Fpng&VERSION=1.3.0&EXCEPTIONS=INIMAGE&SERVICE=WMS&REQUEST=GetMap&STYLES=&LAYERS=osm&_OLSALT=0.3940783483836241&CRS=EPSG%3A25832&BBOX=363375.30907721,5626747.0157598,368124.31589362,5620823.2546257&WIDTH=512&HEIGHT=512",
            "minResolution": null,
            "maxResolution": null,
            "order": 0,
            "opacity": 1,
            "changeAxis": false
        },
        "1": {
            "type": "wms",
            "sourceId": "7",
            "url": "https:\/\/wms.wheregroup.com\/cgi-bin\/mapbender_user.xml?_SIGNATURE=26%3Atq6ae-UqhnZLMjiQlLrj-wCHiOI&TRANSPARENT=TRUE&FORMAT=image%2Fpng&VERSION=1.3.0&EXCEPTIONS=INIMAGE&SERVICE=WMS&REQUEST=GetMap&STYLES=&LAYERS=Mapbender_User&_OLSALT=0.6831931928241708&CRS=EPSG%3A25832&BBOX=363375.30907721,5626747.0157598,368124.31589362,5620823.2546257&WIDTH=2400&HEIGHT=1141",
            "minResolution": null,
            "maxResolution": null,
            "order": 0,
            "opacity": 0.85,
            "changeAxis": false
        },
        "2": {
            "type": "wms",
            "sourceId": "7",
            "url": "https:\/\/wms.wheregroup.com\/cgi-bin\/mapbender_user.xml?_SIGNATURE=26%3Atq6ae-UqhnZLMjiQlLrj-wCHiOI&TRANSPARENT=TRUE&FORMAT=image%2Fpng&VERSION=1.3.0&EXCEPTIONS=INIMAGE&SERVICE=WMS&REQUEST=GetMap&STYLES=&LAYERS=Mapbender_Names&_OLSALT=0.6831931928241708&CRS=EPSG%3A25832&BBOX=363375.30907721,5626747.0157598,368124.31589362,5620823.2546257&WIDTH=2400&HEIGHT=1141",
            "minResolution": null,
            "maxResolution": null,
            "order": 1,
            "opacity": 0.85,
            "changeAxis": false
        }
    },
    "width": 1920,
    "height": 913,
    "center": {
        "x": 365749.81248542,
        "y": 5623785.1351928
    },
    "extent": {
        "width": 4749.006816409994,
        "height": 5923.761134099215
    },
    "overview": {
        "layers": {
            "0": "https:\/\/osm-demo.wheregroup.com\/service?_signature=31%3AIHZNT0zPZhFG95dN3QOzsizaDwA&TRANSPARENT=TRUE&FORMAT=image%2Fpng&VERSION=1.3.0&EXCEPTIONS=INIMAGE&SERVICE=WMS&REQUEST=GetMap&STYLES=&LAYERS=osm&CRS=EPSG%3A25832&BBOX=350757.32820012,5616536.5348653,377637.46662208,5629318.6006879&WIDTH=250&HEIGHT=125"
        },
        "center": {
            "x": 364197.3974111,
            "y": 5622927.5677766
        },
        "height": 78125,
        "changeAxis": false
    },
    "mapDpi": 90.714,
    "extent_feature": {
        "0": {
            "x": 362505.8322437394,
            "y": 5625755.14826519
        },
        "1": {
            "x": 366968.4389051802,
            "y": 5627379.404257199
        },
        "2": {
            "x": 368994.48453732743,
            "y": 5621812.889632087
        },
        "3": {
            "x": 364531.877875887,
            "y": 5620188.63364008
        },
        "4": {
            "x": 362505.8322437394,
            "y": 5625755.14826519
        }
    },
    "userId": null,
    "userName": null,
    "legendpage_image": {
        "type": "resource",
        "path": "images\/legendpage_image.png"
    }
}

bin/console mapbender:print:runJob

Command to run a print job from a saved job definition. The JSON file created with the previously described command (bin/console mapbender:print:dumpjob) will create a pdf print output.

bin/console mapbender:print:runJob print_configuration.json /tmp/print.pdf

bin/console mapbender:print:queue:repair

If a print job in the queue has crashed, e.g. a WMS service is not accessible, printing cannot be performed. The command resets the status of the print jobs so that they can be executed again.

bin/console mapbender:print:queue:repair

bin/console mapbender:print:queue:clean

This command purges old jobs from the print queue (database and files). This includes created PDFs as well as corresponding database entries for the print jobs which are listed in the table called “mb_print_queue”. With the command the expiring age can be set, for example, 20 can be used to delete all jobs older than 20 days.

bin/console mapbender:print:queue:clean 20

Print queue clean process started.
Deleted 0 print queue item(s)

bin/console mapbender:print:queue:gcfiles

gcfiles means “garbage collection files”. This command deletes unreferenced files from print queue storage path. This can happen, for example, if a job is deleted from the database or the file path to the PDFs is no longer up-to-date.

bin/console mapbender:print:queue:gcfiles

No unreferenced local files found

Mailer

bin/console debug:config framework mailer

Command displays the configured mailer(s)

bin/console debug:config framework mailer

Server

symfony server:start –no-tls

As a prerequisite for the Symfony development server, the Symfony CLI must be installed. Following a successful installation, the command launches the development server. In this mode, it is possible to open your local Mapbender. The terminal additionally logs the status of the server while it is active.

You can stop the server again with Control -C.

Note

The Symfony development server may have limitations that reduce the performance of the application in certain cases. It should be used for testing purposes.

symfony server:start --no-tls

[OK] Web server listening
     The Web server is using PHP CLI 8.2.10
     http://127.0.0.1:8000

Hint

It is still possible to define the application environment with a preceding APP_ENV=prod or APP_ENV=dev.

APP_ENV=prod symfony server:start --no-tls

Clear cache

bin/console cache:clear

The command clear the cache directory.

Dev:

bin/console cache:clear --env=dev

Prod:

bin/console cache:clear --env=prod --no-debug

WMS Services

bin/console mapbender:wms:add

Adds a new WMS Source to your Mapbender Service repository.

bin/console mapbender:wms:add https://osm-demo.wheregroup.com/service?VERSION=1.3.0&Service=WMS&request=getCapabilities

* <empty name> OpenStreetMap (WhereGroup)
* * osm OpenStreetMap
* * osm-grey OpenStreetMap (grey scale)
Saved new source #76

bin/console mapbender:wms:assign

Adds a WMS source instance from the sources repository to a Mapbender application.

bin/console mapbender:wms:assign <application> <source> [<layerset>]

Configuration

  • application: ID or slug of the application,

  • source: ID of the WMS service,

  • layerset (optional): ID or name of the layerset. The default value is main or the first layerset in the application.

bin/console mapbender:wms:parse:url

Command to parse a GetCapabilities document by url. The command can be used to validate a WMS Url.

bin/console mapbender:wms:parse:url --validate https://osm-demo.wheregroup.com/service?VERSION=1.3.0&Service=WMS&request=getCapabilities

bin/console mapbender:wms:reload:file

Command to reload (update) a WMS source from given file.

bin/console mapbender:wms:reload:url 76 /var/www/html/service.xml

The following additional options are possible:

  • --deactivate-new-layers

    If set, newly added layers will be deactivated in existing instances. Deactivated layers are not visible in the frontend.

  • --deselect-new-layers

    If set, newly added layers will be deselected in existing instances. Deselected layers are not visible on the map by default, but appear in the layer tree and can be selected by users.

bin/console mapbender:wms:reload:url

Command to reload (update) a WMS source from given url.

bin/console mapbender:wms:reload:url 76 https://osm-demo.wheregroup.com/service?VERSION=1.3.0&Service=WMS&request=getCapabilities

The following additional options are possible:

  • --user=USER

    Username (basicauth) [default: “”]

  • --password=PASSWORD

    Password (basic auth) [default: “”]

  • --deactivate-new-layers

    If set, newly added layers will be deactivated in existing instances. Deactivated layers are not visible in the frontend.

  • --deselect-new-layers

    If set, newly added layers will be deselected in existing instances. Deselected layers are not visible on the map by default, but appear in the layer tree and can be selected by users.

bin/console mapbender:wms:show

Command to displays layer information of a persisted WMS source. You have to parse the ID of the WMS Source to get the information.

bin/console mapbender:wms:show 76

  Source describes 3 layers:
  * <empty name> OpenStreetMap (WhereGroup)
  * * osm OpenStreetMap
  * * osm-grey OpenStreetMap (grey scale)

Other

bin/console mapbender:source:rewrite:host

Use this command to update the hostname in the source URLs, eliminating the need to reload service capabilities.

bin/console mapbender:source:rewrite:host [options] [--] <from> <to>

As usual, the Help command shows more options.

Example to update the hostname:

bin/console mapbender:source:rewrite:host "http://osm-demo.wheregroup.com" "https://osm-demo.wheregroup.com"

    3 modified urls in WMS source #5 / OpenStreetMap (OSM) Demo WhereGroup
    Summary:
    1 sources changed
    3 urls changed
    4 sources unchanged
    14 urls unchanged

bin/console mapbender:config:check

Command to check the system configuration and mapbender requirements. Useful command to determine whether dependencies are compliant and database access works.

bin/console mapbender:config:check

Hint

Please note that config:check will use the php-cli version. The settings may be different from your webserver PHP settings. Please use php -r ‘phpinfo();’ to show your PHP webserver settings.

The following requirements are checked and displayed:

  • Database connections

  • PHP Version

  • System requirements

  • Asset Folders

  • FastCGI

  • Apache modus (rewrite)

  • PHP ini

  • loaded PHP extensions

  • Directory permissions

bin/console mapbender:version

The command outputs the current version of Mapbender.

bin/console mapbender:version

Mapbender 3.3.4

bin/console debug:config

Command lists all registered bundles (packages) and, if available, their aliases.

bin/console debug:config