Debian Codegraph @

project/bundles/appimage/README

raw
1 RESUME
2 ------
3 These scripts build a binary digiKam AppImage bundle for Linux using Ubuntu 64 bits.
4
5
6 AUTHORS
7 -------
8
9 (c) 2015-2026 by Gilles Caulier <caulier dot gilles at gmail dot com>
10
11
12 DESCRIPTION
13 -----------
14 These files and scripts are used to make binary AppImage bundle of the digiKam
15 Software Collection for Linux.
16
17 For more information about AppImage, see at this url:
18 http://appimage.org/
19
20 In addition to this README, there are comments in the scripts that provide some
21 additional explanation for how they work.
22
23
24 BUNDLE CONTENTS
25 ---------------
26
27 Note: the bundle is rellocable.
28
29 .
30 └── usr
31 ├── bin Main executable
32 │   ├── data Marble data
33 │   └── plugins Marble plugins
34 ├── lib All Shared libraries, including 64 bits
35 ├── lib64 -> lib Symbolic link, for compatibility
36 ├── plugins Qt based plugins
37 │   ├── bearer
38 │   ├── designer
39 │   ├── generic
40 │   ├── geoservices
41 │   ├── iconengines
42 │   ├── imageformats
43 │   ├── kauth KDE authentication
44 │   ├── kf5 Generic KDE plugins
45 │   ├── mediaservice
46 │   ├── org.kde.kglobalaccel5.platforms KDE global accelerators
47 │   ├── platforminputcontexts
48 │   ├── platforms
49 │   ├── playlistformats
50 │   ├── position
51 │   ├── sensorgestures
52 │   ├── sensors
53 │   ├── sqldrivers
54 │   ├── webkit
55 │   └── xcbglintegrations
56 ├── share Shared data files
57 │   ├── digikam digiKam
58 │   ├── knotifications5 KDE
59 │   ├── kservices5 KDE
60 │   ├── kservicetypes5 KDE
61 │   ├── kxmlgui5 KDE
62 │   ├── lensfun Lens database for Lensfun
63 │   ├── locale KDE i18n
64 │   ├── metainfo Application metadata
65 │   ├── OpenCV OpenCv shared lib data
66 │   └── solid KDE Solid
67 └── translations Qt i18n
68
69
70 REQUIREMENTS
71 ------------
72
73 - For technical reasons about compatibility with libc, Ubuntu 22.04 is used to be compatible
74 at run-time under other Linux distributions. NOTE: we have tested Centos in the pass but
75 this distribution is really a puzzle to group all required multimedia packages.
76
77 - Create a fresh XUbuntu 22.04 environment in a Virtual Machine:
78 Install the distribution using official ISO from http://ftp.free.fr/mirrors/ftp.xubuntu.com/releases/22.04.3/release/
79 or another mirror.
80 Use a static 80Gb virtual disk with separated partitions as 50Gb for /, 8Gb for swap, and 23Gb for /home.
81 - Using XUbuntu allow to not use Plasma or Gnome desktop. Light XFCE desktop is not Qt5 based desktop.
82 Setup the Internet repositories and install update.
83 - Install the minimum requirement to checkout the code:
84 apt install git openssh-askpass
85 git clone https://invent.kde.org/graphics/digikam.git DK
86 cd DK/project/appimage/
87
88 - Customize the config.sh file:
89 Setup the digiKam git tags to checkout right source code in bundle.
90 Setup the option to host debug symbols or not in bundle.
91
92
93 COMPONENTS
94 ----------
95 There are 4 scripts to be run by the user. 2 first ones installs
96 components on XUbuntu and all dependencies, next one digiKam, and last one makes a
97 binary AppImage bundle for Linux.
98
99
100 SCRIPT DESCRIPTIONS
101 -------------------
102 All scripts should be run from within this directory.
103
104 * 01-build-host.sh:
105
106 This script downloads and configures all packages for XUbuntu to compile digiKam, KDE, Qt,
107 and all other important low level libraries. When the system is ready, this script compile
108 and install low level and Qt libraries.
109
110 * 02-build-extralibs.sh:
111
112 This script configures, compile, and install KDE frameworks.
113
114 * 03-build-digikam.sh:
115
116 This script configures, and compile digiKam.
117
118 * 04-build-installer.sh:
119
120 Once you've successfully built digiKam, this script create the AppImage bundle.
121 This include applications translations.
122 Depending of configuration done in config.sh, this script is able to upload automatically
123 the bundle file on files.kde.org digiKam area through ssh. A valid ssh key configured
124 with remote KDE server need to be set previously with the account. You can load ssh key
125 at startup following these instructions:
126
127 1/ As root, mkdir /root/.ssh
128 2/ Put your ssh keys in /root/.ssh
129 3/ Install openssh-ask-pass package.
130 4/ Edit /root/.bashrc and add these lines at end:
131
132 # --- ssh key rules
133
134 eval `SSH_ASKPASS=/usr/libexec/openssh/x11-ssh-askpass /usr/bin/keychain -q --eval --noask --agents ssh ~/.ssh/id_rsa`
135
136 # ---
137
138 Note: the bundle can be signed with GPG. You must setup your private and public keys before
139 and put your passphare to a text file (~/.gnupg/dkorg-gpg-pwd.txt)
140
141 5/ Re-login as root to setup password.
142
143 Source : https://unix.stackexchange.com/questions/90853/how-can-i-run-ssh-add-automatically-without-password-prompt
144
145 * makeall.sh
146
147 This script permit to build whole Linux bundle from scratch in one time.
148
149 * update.sh
150
151 This script re-build only digiKam and Linux bundle.
152
153
154 AT RUN-TIME ON TARGET COMPUTER
155 ------------------------------
156 - Make AppImage file executable (Ubuntu : chmod +x _bundle_file_).
157 - Add Fuse on on computer (Ubuntu : sudo apt install fuse).
158 - Add user right to use Fuse (Ubuntu : sudo usermod -a -G fuse _user_name_).
159
160
161 LICENSES
162 --------
163 The scripts and other contents of this package are licensed under the BSD-3-Clause License.