Paperwork installation on GNU/Linux

There are many ways to install Paperwork on GNU/Linux, each with its own pros and cons.

Automatic updates Scanner support Fresh from OpenPaper Reviewed Difficulty
Distribution specific (recommended)
yes
local wired wifi
no
yes
easy
OpenPaper's Flatpak repository
yes
local only
yes
no
medium
Flathub's Flatpak repository
yes
local only
no
no
medium
AppImage
no
local wired wifi
yes
no
medium
From source code
no
local wired wifi
yes
no
hard

Distribution specific

This is the preferred method of installation.

Distribution packages are reviewed and tested by your distribution maintainers. Unfortunately, by the time the packages are pushed in your distribution, they usually are fairly old versions. Currently, the latest version of Paperwork is 2.1.2.

Arch Linux

# Installation
yaourt -S paperwork
paperwork-gtk chkdeps

# Usage
# For the graphical user interface
paperwork-gtk
# For the command line interface
paperwork-cli
paperwork-json

Debian / Ubuntu

# Installation
sudo apt install paperwork-gtk paperwork-gtk-l10n-[your lang]
paperwork-gtk chkdeps

# Usage
# For the graphical user interface
paperwork-gtk
# For the command line interface
paperwork-cli
paperwork-json

Fedora

# Installation
sudo dnf install paperwork
paperwork-gtk chkdeps

# Usage
# For the graphical user interface
paperwork-gtk
# For the command line interface
paperwork-cli
paperwork-json

Gentoo

# Installation
sudo emerge paperwork
paperwork-gtk chkdeps

# Usage
# For the graphical user interface
paperwork-gtk
# For the command line interface
paperwork-cli
paperwork-json

OpenPaper's Flatpak repository

OpenPaper's Flatpak repository provides the latest stable version of Paperwork. It includes some extra bugfixes added later. It comes straigth from Paperwork's developers.

Unfortunately, due to containerization, it cannot be used with network scanners yet. Using it with local scanners may require a bit of tweaking.

# Installation
sudo apt install flatpak gnome-software-plugin-flatpak
flatpak --user install https://builder.openpaper.work/paperwork_master.flatpakref

# Usage
flatpak run work.openpaper.Paperwork

[More information]

Flathub's Flatpak repository

Similar to OpenPaper's Flatpak repository, Paperwork is also available on Flathub.

The version on Flathub is always the latest release, without any changes. It has identical limitations to one in the OpenPaper's Flatpak repository.

# Installation
sudo apt install flatpak gnome-software-plugin-flatpak
flatpak --user install https://dl.flathub.org/repo/appstream/work.openpaper.Paperwork.flatpakref

# Usage
flatpak run work.openpaper.Paperwork

[More information]

AppImage

The AppImage version of Paperwork is a portable version.

It is rebuilt after each new release of Paperwork and after every new bug fix. While it doesn't have the Flatpak versions' limitations, it won't be updated automatically. Paperwork can tell you when a new release is available, but it is up to you to update it.

The graphical interface (paperwork-gtk) and the command line interface (paperwork-cli) are packaged separately.

Graphical User Interface

# Installation
url=https://download.openpaper.work/linux/amd64/paperwork-gtk-master-latest.appimage
curl ${url} -o paperwork-gtk.appimage
chmod +x ./paperwork-gtk.appimage
./paperwork-gtk.appimage chkdeps

# Usage
./paperwork-gtk.appimage

Command Line Interface

# Installation
url=https://download.openpaper.work/linux/amd64/paperwork-cli-master-latest.appimage
curl ${url} -o paperwork-cli.appimage
chmod +x ./paperwork-cli.appimage
./paperwork-cli.appimage chkdeps

url=https://download.openpaper.work/linux/amd64/paperwork-json-master-latest.appimage
curl ${url} -o paperwork-json.appimage
chmod +x ./paperwork-json.appimage
./paperwork-json.appimage chkdeps

# Usage
./paperwork-cli.appimage
./paperwork-json.appimage

From source code

This installation method is meant mainly for people who want to contribute to Paperwork development.

[More information]