Updated Docs and GitHub Actions Install Package & Test workflow

.github/workflows/install-package-and-test.yml

@@ -65,7 +65,7 @@ jobs:
           URI=/tiles/renderd-example-webp
           XML=/usr/share/renderd/example-map/mapnik.xml
           ' | tee -a /etc/renderd.conf
-          mkdir -p /var/run/renderd
+          mkdir -p /run/renderd
           renderd
           a2enmod tile
           a2ensite renderd-example-map

README.rst

@@ -128,11 +128,11 @@ Add map configurations for example-map to ``/etc/renderd.conf``:
     XML=/usr/share/renderd/example-map/mapnik.xml
     ' | sudo tee -a /etc/renderd.conf
 
-Ensure the ``/var/run/renderd`` directory exists:
+Ensure the ``/run/renderd`` directory exists:
 
 ::
 
-    $ sudo mkdir -p /var/run/renderd
+    $ sudo mkdir -p /run/renderd
 
 Start the rendering daemon:
 

docs/build/building_on_centos.md

@@ -52,10 +52,14 @@ git clone --depth 1 https://github.com/openstreetmap/mod_tile.git .
 cd /tmp/mod_tile_build
 cmake3 -B . -S /tmp/mod_tile_src \
   -DCMAKE_BUILD_TYPE:STRING=Release \
+  -DCMAKE_INSTALL_LOCALSTATEDIR=/var \
+  -DCMAKE_INSTALL_PREFIX=/usr \
+  -DCMAKE_INSTALL_RUNSTATEDIR=/run \
+  -DCMAKE_INSTALL_SYSCONFDIR=/etc \
   -DENABLE_TESTS:BOOL=ON
 cmake3 --build .
 ctest3
-sudo cmake --install . --prefix /usr --strip
+sudo cmake --install . --strip
 
 # Create /usr/share/renderd directory
 sudo mkdir --parents /usr/share/renderd

docs/build/building_on_centos_stream.md

@@ -74,10 +74,14 @@ git clone --depth 1 https://github.com/openstreetmap/mod_tile.git .
 cd /tmp/mod_tile_build
 cmake -B . -S /tmp/mod_tile_src \
   -DCMAKE_BUILD_TYPE:STRING=Release \
+  -DCMAKE_INSTALL_LOCALSTATEDIR=/var \
+  -DCMAKE_INSTALL_PREFIX=/usr \
+  -DCMAKE_INSTALL_RUNSTATEDIR=/run \
+  -DCMAKE_INSTALL_SYSCONFDIR=/etc \
   -DENABLE_TESTS:BOOL=ON
 cmake --build .
 ctest
-sudo cmake --install . --prefix /usr --strip
+sudo cmake --install . --strip
 
 # Create /usr/share/renderd directory
 sudo mkdir --parents /usr/share/renderd

docs/build/building_on_debian.md

@@ -42,10 +42,14 @@ git clone --depth 1 https://github.com/openstreetmap/mod_tile.git .
 cd /tmp/mod_tile_build
 cmake -B . -S /tmp/mod_tile_src \
   -DCMAKE_BUILD_TYPE:STRING=Release \
+  -DCMAKE_INSTALL_LOCALSTATEDIR=/var \
+  -DCMAKE_INSTALL_PREFIX=/usr \
+  -DCMAKE_INSTALL_RUNSTATEDIR=/run \
+  -DCMAKE_INSTALL_SYSCONFDIR=/etc \
   -DENABLE_TESTS:BOOL=ON
 cmake --build .
 ctest
-sudo cmake --install . --prefix /usr --strip
+sudo cmake --install . --strip
 
 # Create /usr/share/renderd directory
 sudo mkdir --parents /usr/share/renderd

docs/build/building_on_fedora.md

@@ -39,10 +39,14 @@ git clone --depth 1 https://github.com/openstreetmap/mod_tile.git .
 cd /tmp/mod_tile_build
 cmake -B . -S /tmp/mod_tile_src \
   -DCMAKE_BUILD_TYPE:STRING=Release \
+  -DCMAKE_INSTALL_LOCALSTATEDIR=/var \
+  -DCMAKE_INSTALL_PREFIX=/usr \
+  -DCMAKE_INSTALL_RUNSTATEDIR=/run \
+  -DCMAKE_INSTALL_SYSCONFDIR=/etc \
   -DENABLE_TESTS:BOOL=ON
 cmake --build .
 ctest
-sudo cmake --install . --prefix /usr --strip
+sudo cmake --install . --strip
 
 # Create /usr/share/renderd directory
 sudo mkdir --parents /usr/share/renderd

docs/build/building_on_freebsd.md

@@ -42,10 +42,14 @@ git clone --depth 1 https://github.com/openstreetmap/mod_tile.git .
 cd /tmp/mod_tile_build
 cmake -B . -S /tmp/mod_tile_src \
   -DCMAKE_BUILD_TYPE:STRING=Release \
+  -DCMAKE_INSTALL_LOCALSTATEDIR=/var \
+  -DCMAKE_INSTALL_PREFIX=/usr \
+  -DCMAKE_INSTALL_RUNSTATEDIR=/run \
+  -DCMAKE_INSTALL_SYSCONFDIR=/etc \
   -DENABLE_TESTS:BOOL=ON
 cmake --build .
 ctest
-sudo cmake --install . --prefix /usr --strip
+sudo cmake --install . --strip
 
 # Create /usr/share/renderd directory
 sudo mkdir -p /usr/share/renderd

docs/build/building_on_macos.md

@@ -40,10 +40,14 @@ git clone --depth 1 https://github.com/openstreetmap/mod_tile.git .
 cd /tmp/mod_tile_build
 cmake -B . -S /tmp/mod_tile_src \
   -DCMAKE_BUILD_TYPE:STRING=Release \
+  -DCMAKE_INSTALL_LOCALSTATEDIR=/var \
+  -DCMAKE_INSTALL_PREFIX=/usr/local \
+  -DCMAKE_INSTALL_RUNSTATEDIR=/run \
+  -DCMAKE_INSTALL_SYSCONFDIR=/etc \
   -DENABLE_TESTS:BOOL=ON
 cmake --build .
 ctest
-sudo cmake --install . --prefix /usr/local --strip
+sudo cmake --install . --strip
 
 # Create /usr/local/share/renderd directory
 sudo mkdir -p /usr/local/share/renderd

docs/build/building_on_opensuse.md

@@ -58,10 +58,14 @@ git clone --depth 1 https://github.com/openstreetmap/mod_tile.git .
 cd /tmp/mod_tile_build
 cmake -B . -S /tmp/mod_tile_src \
   -DCMAKE_BUILD_TYPE:STRING=Release \
+  -DCMAKE_INSTALL_LOCALSTATEDIR=/var \
+  -DCMAKE_INSTALL_PREFIX=/usr \
+  -DCMAKE_INSTALL_RUNSTATEDIR=/run \
+  -DCMAKE_INSTALL_SYSCONFDIR=/etc \
   -DENABLE_TESTS:BOOL=ON
 cmake --build .
 ctest
-sudo cmake --install . --prefix /usr --strip
+sudo cmake --install . --strip
 
 # Create /usr/share/renderd directory
 sudo mkdir --parents /usr/share/renderd

docs/build/building_on_ubuntu.md

@@ -42,10 +42,14 @@ git clone --depth 1 https://github.com/openstreetmap/mod_tile.git .
 cd /tmp/mod_tile_build
 cmake -B . -S /tmp/mod_tile_src \
   -DCMAKE_BUILD_TYPE:STRING=Release \
+  -DCMAKE_INSTALL_LOCALSTATEDIR=/var \
+  -DCMAKE_INSTALL_PREFIX=/usr \
+  -DCMAKE_INSTALL_RUNSTATEDIR=/run \
+  -DCMAKE_INSTALL_SYSCONFDIR=/etc \
   -DENABLE_TESTS:BOOL=ON
 cmake --build .
 ctest
-sudo cmake --install . --prefix /usr --strip
+sudo cmake --install . --strip
 
 # Create /usr/share/renderd directory
 sudo mkdir --parents /usr/share/renderd

docs/man/convert_meta.1

@@ -1,4 +1,4 @@
-.TH CONVERT_META "1" "2023-12-19" "mod_tile v0.7.0"
+.TH CONVERT_META "1" "2024-03-16" "mod_tile v0.7.1"
 .\" Please adjust this date whenever revising the manpage.
 
 .SH NAME

docs/man/openstreetmap-tiles-update-expire.1

@@ -1,4 +1,4 @@
-.TH TILES-UPDATE-EXPIRE "1" "2023-12-19" "mod_tile v0.7.0"
+.TH TILES-UPDATE-EXPIRE "1" "2024-03-16" "mod_tile v0.7.1"
 .\" Please adjust this date whenever revising the manpage.
 
 .SH NAME

docs/man/render_expired.1

@@ -1,4 +1,4 @@
-.TH RENDER_EXPIRED "1" "2023-12-19" "mod_tile v0.7.0"
+.TH RENDER_EXPIRED "1" "2024-03-16" "mod_tile v0.7.1"
 .\" Please adjust this date whenever revising the manpage.
 
 .SH NAME

docs/man/render_list.1

@@ -1,4 +1,4 @@
-.TH RENDER_LIST "1" "2023-12-19" "mod_tile v0.7.0"
+.TH RENDER_LIST "1" "2024-03-16" "mod_tile v0.7.1"
 .\" Please adjust this date whenever revising the manpage.
 
 .SH NAME
@@ -36,7 +36,7 @@ Render tiles in this map (defaults to 'default').
 Sleep if load is this high (defaults to 16).
 .TP
 \fB\-s\fR|\-\-socket=SOCKET|HOSTNAME:PORT
-Unix domain socket name or hostname and port for contacting renderd.
+Unix domain socket name or hostname and port for contacting renderd (default is '/run/renderd/renderd.sock').
 .TP
 \fB\-n\fR|\-\-num-threads=N
 The number of parallel request threads (default 1).

docs/man/render_old.1

@@ -1,4 +1,4 @@
-.TH RENDER_OLD "1" "2023-12-19" "mod_tile v0.7.0"
+.TH RENDER_OLD "1" "2024-03-16" "mod_tile v0.7.1"
 .\" Please adjust this date whenever revising the manpage.
 
 .SH NAME

docs/man/render_speedtest.1

@@ -1,4 +1,4 @@
-.TH RENDER_SPEEDTEST "1" "2023-12-19" "mod_tile v0.7.0"
+.TH RENDER_SPEEDTEST "1" "2024-03-16" "mod_tile v0.7.1"
 .\" Please adjust this date whenever revising the manpage.
 
 .SH NAME

docs/man/renderd.1

@@ -1,4 +1,4 @@
-.TH RENDERD "1" "2023-12-19" "mod_tile v0.7.0"
+.TH RENDERD "1" "2024-03-16" "mod_tile v0.7.1"
 .\" Please adjust this date whenever revising the manpage.
 
 .SH NAME

docs/man/renderd.conf.5

@@ -1,4 +1,4 @@
-.TH RENDERD.CONF 5 "2023-12-19" "mod_tile v0.7.0"
+.TH RENDERD.CONF 5 "2024-03-16" "mod_tile v0.7.1"
 .\" Please adjust this date whenever revising the manpage.
 
 .SH NAME
@@ -47,13 +47,13 @@ The default value is \fB'4'\fR (macro definition \fB'NUM_THREADS'\fR).
 .B pid_file
 Specify the file path into which the PID will be written by \fBrenderd\fR.
 It is only written to when \fBrenderd\fR is not running in \fBforeground\fR mode (e.g. without \fB'--foreground'\fR / \fB'-f')\fR.
-The default value is \fB'/var/run/renderd/renderd.pid'\fR (macro definition \fB'RENDERD_PIDFILE'\fR).
+The default value is \fB'/run/renderd/renderd.pid'\fR (macro definition \fB'RENDERD_PIDFILE'\fR).
 
 .TP
 .B socketname
 Specify the file path to be used as a unix domain socket for communication with \fBrenderd\fR.
 This option and \fBiphostname\fR / \fBipport\fR are mutually exclusive.
-The default value is \fB'/var/run/renderd/renderd.sock'\fR (macro definition \fB'RENDERD_SOCKET'\fR).
+The default value is \fB'/run/renderd/renderd.sock'\fR (macro definition \fB'RENDERD_SOCKET'\fR).
 
 .TP
 .B stats_file
@@ -205,4 +205,4 @@ Only used by \fBrenderd\fR.
 .SH AUTHOR
 renderd was written by Jon Burgess, and other OpenStreetMap project members.
 .PP
-This manual page was written by OpenStreetMap authors.
+This manual page was written by OpenStreetMap authors.

etc/apache2/renderd-example-map.conf

@@ -59,7 +59,7 @@ Listen 8081
     ModTileMaxLoadMissing 5
 
     # Socket where we connect to the rendering daemon
-    ModTileRenderdSocketName /var/run/renderd/renderd.sock
+    ModTileRenderdSocketName /run/renderd/renderd.sock
 
     # Options controlling the cache proxy expiry headers. All values are in seconds.
     #

utils/openstreetmap-tiles-update-rerender

@@ -192,7 +192,7 @@ else
   #
   # Note no --touch-from=$EXPIRY_TOUCHFROM
   #------------------------------------------------------------------------------
-  if ! render_expired --map=ajt --min-zoom=$EXPIRY_MINZOOM --delete-from=$EXPIRY_DELETEFROM --max-zoom=$EXPIRY_MAXZOOM -s /var/run/renderd/renderd.sock <"$EXPIRY_FILE.$$" 2>&1 | tail -8 >>"$EXPIRYLOG"; then
+  if ! render_expired --map=ajt --min-zoom=$EXPIRY_MINZOOM --delete-from=$EXPIRY_DELETEFROM --max-zoom=$EXPIRY_MAXZOOM -s /run/renderd/renderd.sock <"$EXPIRY_FILE.$$" 2>&1 | tail -8 >>"$EXPIRYLOG"; then
     m_info "Expiry failed"
   fi