Installing Lizmap Web Client on Linux Debian or Ubuntu
Generic Server Configuration
This documentation provides an example for configuring a server with the Debian or Ubuntu Server distribution. We assume you have base system installed and updated.
Warning
This page does not describe how to secure your Apache server.
Configure Locales
For simplicity, it is interesting to configure the server with UTF-8 default encoding.
# configure locales
locale-gen fr_FR.UTF-8 #replace fr with your language
dpkg-reconfigure locales
# define your timezone [useful for logs]
dpkg-reconfigure tzdata
apt install ntp ntpdate
Note
It is also necessary configure the other software so that they are using this default encoding if this is not the case.
Installing necessary packages
Warning
Lizmap web client is based on Jelix 1.6. You must install at least the 5.4 version of PHP. The dom, simplexml, pcre, session, tokenizer and spl extensions are required (they are generally turned on in a standard PHP 5.4 installation)
Note
At least the current version supports PHP 7, so it should be straight foreward to install it on current debian 9 or ubuntu 16.04.
sudo su # only necessary if you are not logged in as root
apt update # update package lists
# On Ubuntu 14.04 LTS install the following packages
apt-get install xauth htop curl apache2 libapache2-mod-fcgid libapache2-mod-php5 php5-cgi php5-gd php5-sqlite php5-curl php5-xmlrpc python-simplejson python-software-properties
# On Ubuntu 18.04 LTS
apt install xauth htop curl apache2 libapache2-mod-fcgid libapache2-mod-php7.2 php7.2-cgi php7.2-gd php7.2-sqlite php7.2-curl php7.2-xmlrpc php7.2-xml python-simplejson software-properties-common
php7 configuration
In this example, we use Apache mpm-worker. So we must manually configure the activation of php5.
cat > /etc/apache2/conf-available/php.conf << EOF
<Directory /usr/share>
AddHandler fcgid-script .php
FCGIWrapper /usr/lib/cgi-bin/php5 .php
Options ExecCGI FollowSymlinks Indexes
</Directory>
<Files ~ (\.php)>
AddHandler fcgid-script .php
FCGIWrapper /usr/lib/cgi-bin/php5 .php
Options +ExecCGI
allow from all
</Files>
EOF
Note
In older versions of apache, the config for php-cgi is in /etc/apache2/conf.d/php.conf. Copy the text above, then:
a2enconf php
mpm-worker configuration
We modify the Apache configuration file to adapt the options to mpm_worker server configuration.
# configuring worker
nano /etc/apache2/apache2.conf # aller au worker et mettre par exemple
<IfModule mpm_worker_module>
StartServers 4
MinSpareThreads 25
MaxSpareThreads 100
ThreadLimit 64
ThreadsPerChild 25
MaxClients 150
MaxRequestsPerChild 0
</IfModule>
mod_fcgid configuration
QGIS Server runs fcgi mode. We must therefore configure the Apache mod_fcgid to suit to the server capabilities.
# Open the mod_fcgid configuration file
nano /etc/apache2/mods-enabled/fcgid.conf
# Paste the following content and adapt it
<IfModule mod_fcgid.c>
AddHandler fcgid-script .fcgi
FcgidConnectTimeout 300
FcgidIOTimeout 300
FcgidMaxProcessesPerClass 50
FcgidMinProcessesPerClass 20
FcgidMaxRequestsPerProcess 500
IdleTimeout 300
BusyTimeout 300
</IfModule>
Setting the compression
nano /etc/apache2/conf-available/mod_deflate.conf # y ajouter
<Location />
# Insert filter
SetOutputFilter DEFLATE
# Netscape 4.x encounters some problems ...
BrowserMatch ^Mozilla/4 gzip-only-text/html
# Netscape 4.06-4.08 encounter even more problems
BrowserMatch ^Mozilla/4\.0[678] no-gzip
# MSIE pretends it is Netscape, but all is well
BrowserMatch \bMSIE !no-gzip !gzip-only-text/html
# Do not compress images
SetEnvIfNoCase Request_URI \.(?:gif|jpe?g|png)$ no-gzip dont-vary
# Ensure that proxy servers deliver the right content
Header append Vary User-Agent env=!dont-vary
</Location>
Note
In older versions of apache, the config for DEFLATE compression is in /etc/apache2/conf.d/mod_deflate.conf.
Enable geolocation
The automatic geolocation provided by Lizmap relies on Google services. To enable it, your webGIS must be placed under a secure protocol, like HTTPS. See for more details:
Restart Apache
You must restart the Apache server to validate the configuration.
service apache2 restart
Create directories for data
mkdir /home/data
mkdir /home/data/cache/
# optional
mkdir /home/data/ftp
mkdir /home/data/ftp/template/
mkdir /home/data/ftp/template/qgis
Spatial DBMS: PostgreSQL
Note
This section is optional
PostgreSQL and PostGIS can be very useful to manage spatial data centralized manner on the server.
Install
# Install packages
apt-get install postgresql postgresql-contrib postgis pgtune php5-pgsql
# A cluster is created in order to specify the storage directory
mkdir /home/data/postgresql
service postgresql stop
pg_dropcluster --stop 9.5 main
chown postgres:postgres /home/data/postgresql
pg_createcluster 9.5 main -d /home/data/postgresql --locale fr_FR.UTF8 -p 5678 --start
# Creating a "superuser" user
su - postgres
createuser myuser --superuser
# Modifying passwords
psql
ALTER USER postgres WITH ENCRYPTED PASSWORD '************';
ALTER USER myuser WITH ENCRYPTED PASSWORD '************';
\q
exit
Adapting the PostgreSQL configuration
We will use pgtune, an utility program that can automatically generate a PostgreSQL configuration file adapted to the properties of the server (memory, processors, etc.)
# PostgreSQL Tuning with pgtune
pgtune -i /etc/postgresql/9.5/main/postgresql.conf -o /etc/postgresql/9.5/main/postgresql.conf.pgtune --type Web
cp /etc/postgresql/9.5/main/postgresql.conf /etc/postgresql/9.5/main/postgresql.conf.backup
cp /etc/postgresql/9.5/main/postgresql.conf.pgtune /etc/postgresql/9.5/main/postgresql.conf
nano /etc/postgresql/9.5/main/postgresql.conf
# Restart to check any problems
service postgresql restart
# If error messages, increase the linux kernel configuration variables
echo "kernel.shmall = 4294967296" >> /etc/sysctl.conf # to increas shred buffer param in kernel
echo "kernel.shmmax = 4294967296" >> /etc/sysctl.conf
echo 4294967296 > /proc/sys/kernel/shmall
echo 4294967296 > /proc/sys/kernel/shmmax
sysctl -a | sort | grep shm
# Restart PostgreSQL
service postgresql restart
FTP Server: pure-ftpd
Note
This section is optional
Install
apt-get install pure-ftpd pure-ftpd-common
Configure
# Creating an empty shell for users
ln /bin/false /bin/ftponly
# Configuring FTP server
echo "/bin/ftponly" >> /etc/shells
# Each user is locked in his home
echo "yes" > /etc/pure-ftpd/conf/ChrootEveryone
# Allow to use secure FTP over SSL
echo "1" > /etc/pure-ftpd/conf/TLS
# Configure the properties of directories and files created by users
echo "133 022" > /etc/pure-ftpd/conf/Umask
# The port range for passive mode (opening outwards)
echo "5400 5600" > /etc/pure-ftpd/conf/PassivePortRange
# Creating an SSL certificate for FTP
openssl req -x509 -nodes -newkey rsa:1024 -keyout /etc/ssl/private/pure-ftpd.pem -out /etc/ssl/private/pure-ftpd.pem
chmod 400 /etc/ssl/private/pure-ftpd.pem
# Restart FTP server
service pure-ftpd restart
Creating a user account
# Creating a user accountr
MYUSER=demo
useradd -g client -d /home/data/ftp/$MYUSER -s /bin/ftponly -m $MYUSER -k /home/data/ftp/template/
passwd $MYUSER
# Fix the user's FTP root
chmod a-w /home/data/ftp/$MYUSER
# Creating empty directories that will be the future Lizmap Web Client directories
mkdir /home/data/ftp/$MYUSER/qgis/rep1 && chown $MYUSER:client /home/data/ftp/$MYUSER/qgis/rep1
mkdir /home/data/ftp/$MYUSER/qgis/rep2 && chown $MYUSER:client /home/data/ftp/$MYUSER/qgis/rep2
mkdir /home/data/ftp/$MYUSER/qgis/rep3 && chown $MYUSER:client /home/data/ftp/$MYUSER/qgis/rep3
mkdir /home/data/ftp/$MYUSER/qgis/rep4 && chown $MYUSER:client /home/data/ftp/$MYUSER/qgis/rep4
mkdir /home/data/ftp/$MYUSER/qgis/rep5 && chown $MYUSER:client /home/data/ftp/$MYUSER/qgis/rep5
# Create a directory to store the cached server
mkdir /home/data/cache/$MYUSER
chmod 700 /home/data/cache/$MYUSER -R
chown www-data:www-data /home/data/cache/$MYUSER -R
Map server: QGIS Server
Note
Details for the installation may differ for specific versions of the operating system. Please refer to http://qgis.org/en/site/forusers/download.html for up to date documentation.
Install
# Add the repository UbuntuGis
cat /etc/apt/sources.list.d/debian-gis.list
deb http://qgis.org/debian trusty main
deb-src http://qgis.org/debian trusty main
# Add keys
sudo gpg --recv-key CAEB3DC3BDF7FB45
sudo gpg --export --armor CAEB3DC3BDF7FB45 | sudo apt-key add -
# Update package list
sudo apt-get update
# Install QGIS Server
sudo apt-get install qgis-server python-qgis
Note
See https://docs.qgis.org/testing/en/docs/user_manual/working_with_ogc/server/index.html for more information on QGIS Server.
Retrieve and install Lizmap Web Client
cd /var/www/
With ZIP file
Retrieve the latest available stable version from https://github.com/3liz/lizmap-web-client/releases/
cd /var/www/
# Options
VERSION=3.2.3
# Archive recovery with wget
wget https://github.com/3liz/lizmap-web-client/archive/$VERSION.zip
# Unzip archive
unzip $VERSION.zip
# virtual link for http://localhost/lm
ln -s /var/www/lizmap-web-client-$VERSION/lizmap/www/ /var/www/html/lm
# Remove archive
rm $VERSION.zip
Set rights for Apache, so php scripts could write some temporary files or do changes.
cd /var/www/lizmap-web-client-$VERSION/
lizmap/install/set_rights.sh www-data www-data
Create lizmapConfig.ini.php, localconfig.ini.php and profiles.ini.php and edit them to set parameters specific to your installation. You can modify lizmapConfig.ini.php to set the url of qgis map server and other things, and profiles.ini.php to store data in a database other than an sqlite database.
cd lizmap/var/config
cp lizmapConfig.ini.php.dist lizmapConfig.ini.php
cp localconfig.ini.php.dist localconfig.ini.php
cp profiles.ini.php.dist profiles.ini.php
cd ../../..
In case you want to enable the demo repositories, just add to localconfig.ini.php the following:
[modules]
lizmap.installparam=demo
Then you can launch the installer
php lizmap/install/installer.php
For testing launch: http://127.0.0.1/lm in your browser.
In case you get a 500 - internal server error, run again:
cd /var/www/lizmap-web-client-$VERSION/
lizmap/install/set_rights.sh www-data www-data
Development version with git
Warning
The development version is always changing, and bugs can occur. Do not use it in production.
The first time
apt-get install git
cd /var/www/
VERSION=master
# Clone the master branch
git clone https://github.com/3liz/lizmap-web-client.git lizmap-web-client-$VERSION
# Go into the git repository
cd lizmap-web-client-$VERSION
# Create a personal branch for your changes
git checkout -b mybranch
To update your branch from the master repository
cd /var/www/lizmap-web-client-$VERSION
# Check that you are on the branch: mybranch
git checkout mybranch
# If you have any changes, make a commit
git status
git commit -am "Your commit message"
# Save your configuration files!
lizmap/install/backup.sh /tmp
# Update your master branch
git checkout master && git fetch origin && git merge origin/master
# Apply to your branch, marge and manage potential conflicts
git checkout mybranch && git merge master
# Apply rights
chown :www-data temp/ lizmap/var/ lizmap/www lizmap/install/qgis/edition/ -R
chmod 775 temp/ lizmap/var/ lizmap/www lizmap/install/qgis/edition/ -R
Note
It is always good to make a backup before updating.
Give the appropriate rights to directories and files
cd /var/www/lizmap-web-client-$VERSION
chown :www-data temp/ lizmap/var/ lizmap/www lizmap/install/qgis/edition/ -R
chmod 775 temp/ lizmap/var/ lizmap/www lizmap/install/qgis/edition/ -R
First test
Go to the Lizmap Web Client home to see if the installation was performed correctly: http://localhost/lm
Note
Replace localhost with the address or IP number of your server.
Lizmap is accessible, without further configurations, also as WMS and WFS server from a browser:
and from QGIS:
http://localhost/lm/index.php/lizmap/service/?repository=montpellier&project=montpellier&VERSION=1.3.0&
http://localhost/lm/index.php/lizmap/service/?repository=montpellier&project=montpellier&
Note
Access to the WMS and WFS servers can be limited by assigning privileges to specific repositories, see the administration section.
Editing tool: Configure the server with the database support
Note
This section is optional
PostgreSQL
For the editing of PostGIS layers in Web Client Lizmap operate, install PostgreSQL support for PHP.
sudo apt-get install php5-pgsql
sudo service apache2 restart
Note
For editing, we strongly recommend using a PostgreSQL database. This greatly simplifies installation and retrieval of data entered by users.
Spatialite
Enable Spatialite extension
To use editing on layers spatiatlite,you have to add the spatialite extension in PHP. You can follow these instructions to do so: http://www.gaia-gis.it/spatialite-2.4.0-4/splite-php.html
Lizmap Web Client tests whether the spatialite support is enabled in PHP. If it is not, then spatialities layers will not be used in the editing tool. You can always use PostgreSQL data for editing.
Give the appropriate rights to the directory containing Spatialite databases
So that Lizmap Web Client can modify the data contained in databases Spatialite, we must ensure that the Apache user (www-data) has well write access to the directory containing each Spatialite file
For example, if a directory contains a QGIS project, which uses a Spatialite database placed in a db directory at the same level as the QGIS project:
/path/to/a/lizmap_directory
|--- mon_projet.qgs
|--- bdd
|--- my_spatialite_file.sqlite
So you have to give the rights in this way:
chown :www-data /path/to/a/lizmap_directory -R
chmod 775 /path/to/a/lizmap_directory -R
Note
so if you want to install Lizmap to provide access to multiple map publishers, you should tell them to always create a db directory at the same level as the QGIS projects in the Lizmap Web Client directory. This will facilitate the admin work that just have to change the rights of this unique directory.