Build ONE single QMapShack executable file based on QMapShack latest development commits by using Docker and AppImage.
- You are using a Linux distribution like Ubuntu, Fedora, openSUSE, Manjaro, ... ?
- And you are not coding by your self?
- So you would like not to set up a complex build environment on your computer?
- But you would like to review and test the latest development commits?
Then, may be you could use a ready to go one-click QMapshack.AppImage executable file.
Be aware:
- You are using software from a development branch. QMapShack is most of time quite stable during development process - but there is no guarantee! to the changes of the new prerequisites.
- When already using a stable QMapShack version it is advice to backup your existing personal QMapShack data (Tracks, Routes, DBs, Maps, etc.) prior for using QMapShack.AppImage. Do not forget to save your setting files also, for example in a Ubuntu and Fedora environment:
cp -r ~/.config/QLandkarte ~/.config/QLandkarte.bak
- Ubuntu 22.04
- GNOME / X11
- GLIBC 2.35
- cmake 3.22.1
- Qt 6.8.3
- PROJ 9.4.1
- GDAL 3.9.0
- QUAZIP 1.5
- Routino 3.4.3
- QMapShack V_1.9.0, development commit d089cf0, [QMS-896] BRouter setup & download counter issues
- Ubuntu 22.04, 24.04, 25.10
- Fedora Workstation 42, 43 / Gnome / Wayland
- openSUSE 15.6 KDE
Download pre-build QMapShack-x86_64.AppImage from here (615 MB)
After download change user rights for execution:
chmod u+x QMapShack-x86_64.AppImage
- Computer with 64-bit architecture (x86_64)
- A Linux distribution - able to run Docker software
- At least ~5 GB free disk space
- 1-2 hour for the initial Docker image build
- 5 minutes for each development update
- Some Linux skills to handle a terminal
Details about Docker and the installation steps for the wide range of Linux distribution can be found here. An external installation guide for openSUSE can be found here, and for Manjaro here.
Verify that Docker Engine is installed correctly by running the hello-world image.
sudo docker run hello-world
Be aware:
The Docker daemon binds to a Unix socket instead of a TCP port. By default that Unix socket is owned by the user root and other users can only access it using sudo. The Docker daemon always runs as the root user. So please be carefull in using with root access rights (sudo). See here for more details.
Create a folder of your choice, example GPS or choose an existing one:
mkdir GPS
cd ~/GPS
Download repository from GitHub:
git clone https://github.com/kkarsten62/QMapShack.AppImage.git
cd QMapShack.AppImage
For building process a manual built Qt environment is needed.
Download pre-build Qt environment from here (487 MB)
Build the image:
sudo docker build -t qms-appimage:0.0.0 --no-cache --file <dockerfile> .
For example:
sudo docker build -t qms-appimage:0.0.0 --no-cache --file Dockerfile_Ubuntu-22.04 .
Note:
- Be patient and take a coffee, build process will take some time - about 1-2 hours
- To save time, the
--no-cacheoption can be omitted during testing, but should be set on final build run - In newer Docker versions you can use option
--progress=plainto obtain classical plain terminal output during build process
Check for latest information in terminal:
=====================================================
QMapShack.AppImage Docker image successfully created
=====================================================
With docker run a Docker container will be created based on the Docker image.
Steps on Docker Run:
- Download (pull) latest development commits from QMapShack development branch
- Build new QMapShack version
- Run AppImage build process to build one executable file
- Copy final QMapShack.AppImage executable file to
outfolder
Start building new QMapShack version with:
cd ~/GPS/qmapshack-AppImage
sudo docker run -it --privileged --rm -v $(pwd)/out:/out -e USER_ID=$(id -u):$(id -g) qms-appimage:0.0.0 /build_AppImage.sh
Check for latest information in terminal:
===================================================
QMapShack.AppImage file successfully created!
Check 'out' folder for new QMapShack.AppImage file
===================================================
Note:
- Run again when new development commits are in the QMapShack development branch, check here
- And think about to backup an existing
QMapShack-x86_64.AppImageinoutfolder prior to the rerun
Additionally you can enter into the Docker container by using a bash shell to inspect the content:
cd ~/GPS/qmapshack-AppImage
sudo docker run -it --privileged --rm -v $(pwd)/out:/out -e USER_ID=$(id -u):$(id -g) qms-appimage:0.0.0
Use exit to step out.
cd ~/GPS/qmapshack-AppImage/out
./QMapShack-x86_64.AppImage [options]
The [options] can be set according to QMapShack commandline options, see here for more details.
See here for detailed information.
cd ~/GPS/qmapshack-AppImage/out
./QMapShack-x86_64.AppImage --appimage-mount
Now, use another terminal or file manager to inspect the content of QMapShack.AppImage in the folder printed by --appimage-mount.
cd ~/GPS/qmapshack-AppImage/out
./QMapShack-x86_64.AppImage --appimage-extract
A new folder called squashfs-root is created, containing the content of QMapShack.AppImage.
Seen from AppImage the pathes /usr/share/routino (ROUTINO_XML_PATH) and /usr/share/doc/HTML are hard-coded pathes in QMapShack binary file.
See here for more information. Current bypass is to copy at start of QMapShack.Appimage the routino profiles and help files to a /tmp folder. The /tmp folder will be removed when QMapShack finished.
In a case of a strange behaviour in handling of QMapShack, it may help to delete the configuration. Be aware: All your personal settings for the GUI will be lost. Finish QMapShack first. Before doing so, however, back up the existing configuration. QMapShack will then start with the default configuration.
cp -r ~/.config/QLandkarte ~/.config/QLandkarte.bak
rm -rf ~/.config/QLandkarte
A good practices could be also to start QMapShack.AppImage with a dedicated configration file using -c option to avoid conflicts with an existing QMapShack installation, like:
./QMapShack.AppImage -c myConfigFile.conf
Many thanks to harenber for the base idea and approach.
https://hub.docker.com/r/harenber/qmapshack-appimage
Thanks to Docker - To make DevOps life easier. https://www.docker.com/
Thanks to AppImage -To bring it to the point. https://appimage.org/
And a big thanks to the QMapShack community for the stable and continuous development. https://github.com/Maproom/qmapshack/wiki