Flatpak documentation
Skip to content
Flatpak documentation
Introduction to Flatpak
Getting Started
Building
Debugging
Publishing
Desktop Integration
Flatpak as a developer platform
Tips and Tricks
Reference Documentation
Flatpak Command Reference
Flatpak Builder Command Reference
Available Runtimes
Under the Hood
libflatpak API Reference
Portal API Reference
View this page
Edit this page
Welcome to Flatpak’s documentation!
These docs cover everything you need to know to build and distribute
applications using Flatpak. They begin with a basic introduction to Flatpak,
background information on basic concepts, and a guide to the Flatpak command
line interface. Later sections provide detailed information on building and
distributing applications.
The docs are primarily intended for application developers and
distributors. Their content is also relevant to those who have a general
interest in Flatpak.
If you are looking for information about how to use Flatpak to install and
run applications, please refer to
the Flatpak website
Contents
Introduction to Flatpak
Terminology
Target audience
Issues with the current packaging model
Reasons to use Flatpak
Getting Started
Basic concepts
Using Flatpak
Building your first Flatpak
Building
Building Introduction
Requirements & Conventions
Dependencies
Flatpak Builder
Manifests
Module Sources
Sandbox Permissions
Guides
Debugging
Debug packages
Debug shell
Using GDB in the sandbox
Getting stacktraces from a crash
Using other debugging tools
Multiple Debug shells in one sandbox
Creating a Debug extension
Overriding sandbox permissions
Inspecting portal permissions
Interacting with running sandboxes
Audit session or system bus traffic
Publishing
Repositories
Hosting a repository
Single-file bundles
USB Drives
Desktop Integration
Locale detection
Portals
Notifications
Status icons
System search
Window controls
Window decorations
Global menus
Theming
Icons
Fonts
Flatpak as a developer platform
CI Integration
Running tests
Parallel nightly and stable applications
Additional tools
Tips and Tricks
Testing an app with a different runtime
Downgrading
Masking
Bisecting regressions in application builds
Adding a custom installation
Configuring resource limits for apps
Reference Documentation
Flatpak Command Reference
Flatpak Builder Command Reference
Available Runtimes
Under the Hood
libflatpak API Reference
Portal API Reference
On this page
Welcome to Flatpak’s documentation!
Contents