Skip to content

Commit

Permalink
refine the section on GPG signatures
Browse files Browse the repository at this point in the history
The section didn't have a clear structure, and wasn't clear about
recommended practice.
  • Loading branch information
allanday committed Jan 13, 2017
1 parent b19386c commit 83fc083
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/distributing-applications.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ OSTree supports something called static deltas. These are single files in the re
GPG signatures
^^^^^^^^^^^^^^

By default OSTree refuses to pull from a remote repository that is not signed. To disable GPG verification, the ``--no-gpg-verify`` option needs to be used when a remote is added. Alternatively, it can be disabled on an existing remote using ``flatpak remote-modify``.
OSTree uses GPG to verify the identity of repositories. A signature is therefore required for every commit and for repository summary files. These objects are created by the ``build-update-repo`` and ``build-export`` commands, as well as indirectly by ``flatpak-builder``. A GPG key therefore needs to be passed to each of these commands, and optionally the GPG home directory to use. For example::

Note that GPG signatures are required for the user to be able to install trusted remotes that can be updated from without needing to be root.
$ flatpak build-export --gpg-sign=KEYID --gpg-homedir=/some/dir appdir repo

OSTree requires signatures for every commit and on repository summary files. These objects are created by the ``build-update-repo`` and ``build-export`` commands, as well as indirectly by ``flatpak-builder``. A GPG key should therefore be passed to each of these commands, and optionally the GPG home directory to use. For example::
It is recommended that OSTree repositories are verified using GPG whenever they are used. However, if you want to disable GPG verification, the ``--no-gpg-verify`` option can be used when a remote is added. GPG verification can also be disabled on an existing remote using ``flatpak remote-modify``.

$ flatpak build-export --gpg-sign=KEYID --gpg-homedir=/some/dir appdir repo
Note that it is necessary to become root in order to update a remote that does not have GPG verification enabled.

Referring to repositories
^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit 83fc083

Please sign in to comment.