Skip to content

Commit

Permalink
GITBOOK-201: Add Flathub installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
erickzhao authored and gitbook-bot committed Feb 13, 2025
1 parent fdbaab2 commit de949a2
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions config/makers/flatpak.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,25 @@ description: Create a Flatpak app for your Electron app using Electron Forge.

# Flatpak

The Flatpak target builds [`.flatpak` files](http://flatpak.org/), which is a packaging format for Linux distributions that allows for sandboxed installation of applications in isolation from the rest of their system. In contrast, typical [deb.md](deb.md "mention") or [rpm.md](rpm.md "mention") installation methods are not sandboxed.
[Flatpak](https://flatpak.org/) is a packaging format for Linux distributions that allows for sandboxed installation of applications in isolation from the rest of their system. In contrast, typical [deb.md](deb.md "mention") or [rpm.md](rpm.md "mention") installation methods are not sandboxed.

## Requirements

You can only build the Flatpak target if you have [`flatpak`](https://docs.flatpak.org/en/latest/flatpak-command-reference.html#flatpak), [`flatpak-builder`](https://docs.flatpak.org/en/latest/flatpak-builder-command-reference.html#flatpak-builder), and `eu-strip` _(usually part of the_ [_`elfutils`_](https://sourceware.org/elfutils/) _package)_ installed on your system.
You can only build the Flatpak target if you have the following installed on your system:

* [`flatpak`](https://docs.flatpak.org/en/latest/flatpak-command-reference.html#flatpak)
* [`flatpak-builder`](https://docs.flatpak.org/en/latest/flatpak-builder-command-reference.html#flatpak-builder)
* `eu-strip` _(usually part of the_ [_`elfutils`_](https://sourceware.org/elfutils/) _package)_

You will also need to add the Flathub remote repository to `flatpak` to access runtimes necessary to build your application:

```sh
flatpak remote-add --if-not-exists --user flathub https://dl.flathub.org/repo/flathub.flatpakrepo
```

{% hint style="info" %}
Flathub provides separate [installation instructions](https://flathub.org/setup) for each supported Linux distribution. Please refer to their documentation for additional information.
{% endhint %}

## Installation

Expand Down Expand Up @@ -36,7 +50,7 @@ module.exports = {
};
```

Configuration options are documented in [`MakerFlatpakConfig`](https://js.electronforge.io/classes/\_electron\_forge\_maker\_flatpak.MakerFlatpak-1.html#config).
Configuration options are documented in [`MakerFlatpakConfig`](https://js.electronforge.io/classes/_electron_forge_maker_flatpak.MakerFlatpak-1.html#config).

## Debugging

Expand Down

0 comments on commit de949a2

Please sign in to comment.