Skip to content

Commit a0c63b4

Browse files
authored
Add information about zsync in the update page
1 parent 3c5bf88 commit a0c63b4

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

source/packaging-guide/optional/updates.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ Making AppImages updateable via external tools
2020

2121
To make an AppImage updateable, you need to embed information that describes where to check for updates and how into the AppImage. Unlike other Linux distribution methods, the information where to look for updates is not contained in separate repository description files such as :code:`sources.list` that need to be managed by the user, but is directly embedded inside the AppImage by the author of the respective AppImage. This has the advantage that the update information always travels alongside the application, so that the end user does not have to do anything special in order to be able to check for updates.
2222

23+
Currently, there is only one backend available to update AppImages : `ZSync2 <https://travis-ci.org/TheAssassin/zsync2/>`__. The tool you use to package the AppImage will also generate a .zsync file if you gave it enough data to do so
24+
25+
.. warning:: The .zsync file contains the filename of the AppImage. This mean that you **should not**, as a packager, rename the .AppImage file after it's creation. Else the update will fail because zsync will look for the original filename of the AppImage you host
26+
27+
2328

2429
Using appimagetool
2530
^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)