Skip to content

Commit de949a2

Browse files
erickzhaogitbook-bot
authored andcommitted
GITBOOK-201: Add Flathub installation instructions
1 parent fdbaab2 commit de949a2

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

config/makers/flatpak.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,25 @@ description: Create a Flatpak app for your Electron app using Electron Forge.
44

55
# Flatpak
66

7-
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.
7+
[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.
88

99
## Requirements
1010

11-
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.
11+
You can only build the Flatpak target if you have the following installed on your system:
12+
13+
* [`flatpak`](https://docs.flatpak.org/en/latest/flatpak-command-reference.html#flatpak)
14+
* [`flatpak-builder`](https://docs.flatpak.org/en/latest/flatpak-builder-command-reference.html#flatpak-builder)
15+
* `eu-strip` _(usually part of the_ [_`elfutils`_](https://sourceware.org/elfutils/) _package)_
16+
17+
You will also need to add the Flathub remote repository to `flatpak` to access runtimes necessary to build your application:
18+
19+
```sh
20+
flatpak remote-add --if-not-exists --user flathub https://dl.flathub.org/repo/flathub.flatpakrepo
21+
```
22+
23+
{% hint style="info" %}
24+
Flathub provides separate [installation instructions](https://flathub.org/setup) for each supported Linux distribution. Please refer to their documentation for additional information.
25+
{% endhint %}
1226

1327
## Installation
1428

@@ -36,7 +50,7 @@ module.exports = {
3650
};
3751
```
3852

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

4155
## Debugging
4256

0 commit comments

Comments
 (0)