Installing¶
TrickWork comes in two forms built from one engine, so the desktop app and the container always produce the same art from the same image.
Requirements¶
- Container: any amd64 or arm64 Docker host. No database and no volumes.
- Desktop: Windows 10 or 11 (x64 or ARM), macOS, or Linux with
libwebkit2gtk-4.1-0. The Flatpak and the AppImage bring their own.
Desktop app¶
Download the build for your system from the latest release:
| System | File |
|---|---|
| Windows 10/11, installer | trickwork-windows-amd64-installer.exe |
| Windows 10/11, portable | trickwork-windows-amd64-portable.exe |
| Windows 11 on ARM | trickwork-windows-arm64-installer.exe or -portable.exe |
| macOS | trickwork-macos-universal.dmg |
| Linux, installer | trickwork-linux-amd64-installer, on ARM trickwork-linux-arm64-installer |
| Linux | trickwork-linux-amd64, on ARM trickwork-linux-arm64 (both need libwebkit2gtk-4.1-0) |
| Linux, AppImage | trickwork-linux-amd64.AppImage, on ARM trickwork-linux-arm64.AppImage |
| Linux, Flatpak | trickwork-linux-amd64.flatpak, on ARM trickwork-linux-arm64.flatpak |
The portable Windows file and the Linux binary run without installing
anything; on Linux, make the file executable first with chmod +x.
The Windows installer puts TrickWork under C:\Program Files\TrickWork for
everyone on the computer, or into another folder you pick, and asks for an
administrator once, while it installs; later updates ask nobody (see
Updates). Two switches decide on a Start menu entry and a desktop
shortcut, both on at first, and both go to every user on the computer. The
next install, silent or not, starts from your answer and removes a shortcut
you left out.
The installer's first page also asks which language TrickWork should start in. The app opens in that language until you pick another one under Settings, and then keeps yours.
The installer also cleans up after older versions. An installation from 1.3.0
or earlier under C:\Program Files\TrickWork\TrickWork goes, and so does a
copy installed for you alone under AppData\Local\Programs, with its
shortcuts and its entry under Apps. It never touches your settings in
%AppData%\TrickWork or what the window keeps in %AppData%\TrickWork.exe.
On Linux the installer is for you alone and asks for no password. It puts
TrickWork in ~/.local/share/com.junkerderprovinz.trickwork and adds it to
the application menu, with a desktop icon if you want one. Right-clicking the
menu entry offers to uninstall it. That copy updates itself like the bare
binary. Make the downloaded file executable first
(chmod +x trickwork-linux-amd64-installer). The installer needs
libwebkit2gtk-4.1-0 just like the app.
As an AppImage¶
Each release also carries trickwork-linux-amd64.AppImage and
trickwork-linux-arm64.AppImage. An AppImage packs the program together with
GTK and WebKitGTK into one file, so it does not depend on the WebKitGTK your
distribution ships. It starts on Ubuntu 22.04 and on newer distributions. Make
it executable and start it:
chmod +x trickwork-linux-amd64.AppImage
./trickwork-linux-amd64.AppImage
It runs from wherever you keep it and updates itself like the bare binary: the
new version takes the AppImage's place in its folder and starts next time.
Settings live in ~/.config/TrickWork, the same as the bare binary's, so you
can move between the two.
As a Flatpak¶
Each release also carries trickwork-linux-amd64.flatpak and
trickwork-linux-arm64.flatpak. Open the file with your software centre, or
install it in a terminal:
flatpak install --user trickwork-linux-amd64.flatpak
The Flatpak brings its own WebKitGTK and pulls the GNOME runtime from Flathub,
so you don't need to install anything else. It never replaces itself, so
Update automatically stays off there and says so. To update, install the
next release's file the same way. Its settings live in
~/.var/app/io.github.junkerderprovinz.trickwork.
TrickWork opens pictures and saves exports through your desktop's own file dialogs. It can reach any folder you pick there, and the Flatpak gets no access to your files beyond that.
Updates¶
The desktop app updates itself from GitHub. It asks for the newest release,
downloads the file for your system in the background and checks it against
the release's checksums.txt. The new version starts the next time you open
TrickWork, so nothing changes while it runs, and a note in the corner of the
window says when it is ready. Pre-releases are never installed.
Update automatically in the General tab of Settings turns this off; it
is on from the start. The Flatpak is the one exception and leaves its updates
to Flatpak (see As a Flatpak).
The installed copy on Windows cannot replace itself, since no user may
write to its folder. A scheduled task named TrickWork Update does it
instead, once a day and five minutes after the computer starts, whether
TrickWork is open or not. It replaces TrickWork.exe, sets the version shown
under Apps and writes what it did, or why it did not, to
%ProgramData%\TrickWork\update.log. There is one installation, so the switch
applies to everyone on the computer: it lives in
%ProgramData%\TrickWork\settings.json, which every user may change, and the
task skips its run while it is off. The same file holds the language the
installer asked for. An open window notices within a few minutes when the task
has put a new version in place and shows the note. The replaced program waits
beside the new one as TrickWork.exe.old until a later run removes it.
A portable copy, such as trickwork-windows-amd64-portable.exe, updates
itself while it runs: a minute after it starts and once a day after that, in
its own folder, and it stays portable. The app on macOS and Linux does the
same, and an AppImage replaces its own file. A folder it cannot write to, or a macOS app your account cannot change,
stays as it is. The reason is in update.log next to the setting:
%AppData%\TrickWork on Windows, ~/Library/Application Support/TrickWork on
macOS and ~/.config/TrickWork on Linux.
Why the task runs as SYSTEM¶
Program Files belongs to the administrators. A program that replaces itself
there without asking anyone needs an account that may write there, and a
scheduled task under the system account is how Windows provides one; Firefox's
maintenance service and Chrome's updater task work the same way. The task
writes to three places and nowhere else: the installation folder, usually
C:\Program Files\TrickWork; the entry under Apps, in
HKLM\Software\Microsoft\Windows\CurrentVersion\Uninstall\TrickWork; and
%ProgramData%\TrickWork, for its log. It reads nothing from any user's
profile and never opens a window. The folder under ProgramData belongs to the
administrators, and only settings.json in it is open to other users. The
installer gives the installation folder the same rights as Program Files.
That leaves no file a user could swap for one the system account would run or
write to.
You can install into another folder too. Many second drives let everyone
rename what sits at their top, and whoever can rename a folder above the
installation can swap it. On such a drive the task runs as the person who
installed TrickWork, without administrator rights, and that person may change
the installation folder. Updates arrive the same way; only the version under
Apps stays at the one first installed. The task downloads only from GitHub
over HTTPS and installs a file only when it matches checksums.txt.
Uninstalling¶
Apps, TrickWork, Uninstall asks for an administrator and removes the program
with its shortcuts, its entry under Apps and the remembered shortcut choice.
The scheduled task goes too, and so does %ProgramData%\TrickWork with the
switch and the log. In the installation folder it deletes only the files the
installer and the updates put there. Every user's settings in %AppData%\TrickWork and
%AppData%\TrickWork.exe stay, so a later install picks them up.
Windows SmartScreen
Windows may show "Windows protected your PC" the first time you run a freshly downloaded, unsigned program. Click More info, then Run anyway.
Docker¶
docker run -d \
--name trickwork \
--restart unless-stopped \
-p 3210:3210 \
ghcr.io/junkerderprovinz/trickwork:latest
Then open http://localhost:3210/. The image runs on amd64 and arm64 and needs
no environment variables and no volumes. It is also on Docker Hub as
junkerderprovinz/trickwork.
Unraid¶
TrickWork is in Unraid's Community Applications: open Apps, search for TrickWork and install it (its page in the catalogue).
To add the template by hand instead, run this in the Unraid console:
mkdir -p /boot/config/plugins/dockerMan/templates-user && \
curl -fsSL -o /boot/config/plugins/dockerMan/templates-user/my-trickwork.xml \
https://raw.githubusercontent.com/junkerderprovinz/unraid-apps/main/trickwork/trickwork.xml
Then pick Docker, Add Container, trickwork under User templates, choose a
port and press Apply. The file name keeps its my- prefix, which is what
makes Unraid treat it as a user template.
From source¶
The source code of every release is on its release page, and How it works and building it explains how to build it.