Difference between revisions of "AppImage"

From FreeCAD Documentation
Jump to navigation Jump to search
m (tweak font size)
Line 35: Line 35:
{| class="wikitable" style="margin-left: auto; margin-right: auto; border: none;"
{| class="wikitable" style="margin-left: auto; margin-right: auto; border: none;"
|+ Available FreeCAD AppImages
|+ style="text-align: center; font-size: 150%; | Available FreeCAD AppImages
! style="text-align: center;" | Stable
! style="text-align: center; font-size: 200%;" | Stable
! style="text-align: center;" | Development
! style="text-align: center; font-size: 200%;" | Development
| style="text-align: center;" | [[Image:AppImage-logo.png|link=https://github.com/FreeCAD/FreeCAD/releases/download/{{:Template:Stable-Major-and-Minor-Version}}/FreeCAD_{{:Template:Stable-Version}}-Linux-Conda_Py3Qt5_glibc2.12-x86_64.AppImage]] [https://github.com/FreeCAD/FreeCAD/releases/download/{{:Template:Stable-Major-and-Minor-Version}}/FreeCAD_{{:Template:Stable-Version}}-Linux-Conda_Py3Qt5_glibc2.12-x86_64.AppImage {{:Template:Stable-Version}}] ([https://github.com/FreeCAD/FreeCAD/releases/download/{{:Template:Stable-Major-and-Minor-Version}}/FreeCAD_{{:Template:Stable-Version}}-Linux-Conda_Py3Qt5_glibc2.12-x86_64.AppImage-SHA256.txt SHA256])
| style="text-align: center;" | [[Image:AppImage-logo.png|link=https://github.com/FreeCAD/FreeCAD/releases/download/{{:Template:Stable-Major-and-Minor-Version}}/FreeCAD_{{:Template:Stable-Version}}-Linux-Conda_Py3Qt5_glibc2.12-x86_64.AppImage]] [https://github.com/FreeCAD/FreeCAD/releases/download/{{:Template:Stable-Major-and-Minor-Version}}/FreeCAD_{{:Template:Stable-Version}}-Linux-Conda_Py3Qt5_glibc2.12-x86_64.AppImage {{:Template:Stable-Version}}] ([https://github.com/FreeCAD/FreeCAD/releases/download/{{:Template:Stable-Major-and-Minor-Version}}/FreeCAD_{{:Template:Stable-Version}}-Linux-Conda_Py3Qt5_glibc2.12-x86_64.AppImage-SHA256.txt SHA256])

Revision as of 12:30, 29 March 2020

Other languages:
Deutsch • ‎English • ‎français • ‎italiano • ‎русский
As of 7 July 2019, the FreeCAD community has been observing that downloading AppImages from Github seems to timeout before completion. We aren't sure why this is occurring. If this happens to you please try downloading again. It make take a few tries. A recommended practice is to use the AppImage auto-updating feature, which will restore the download from the place it failed.

What is an AppImage?

AppImage-logo.png Package once and run everywhere. Reach users on all major Linux desktop distributions.

AppImage is a "universal binary package" intended to distribute an application to any Linux distribution. Read more about it on the Appimage homepage and Wikipedia.

To run it, fist make it executable, and then type the relative or full path.

chmod +x FreeCAD_x86_64.AppImage

For other types of installation see Download.

FreeCAD AppImages

If the download links below do not work, please manually download the files from the "Assets" section in the FreeCAD Github Releases

Available FreeCAD AppImages
Stable Development
AppImage-logo.png 0.18-16146 (SHA256) AppImage-logo.png [1] (SHA256)

Important Notes:

  • Development happens daily and rapidly, the link for the most up-to-date AppImage is a moving target.
  • The development link above should be up-to-date because it is updated via a script.
  • Many users on the forum utilize the development version.
  • It can be run on the same system in parallel with another version of FreeCAD.
  • Users use the dev version to take advantage of the latest features and bug fixes (since FreeCAD has a long release cycle). They also use it to help test and find bugs to spur development and improvement of FreeCAD.

Obligatory Word of Caution

For the most part the development version is stable but of course it's important to add the obligatory statement to use it at your own risk. Though most people that utilize backups and 'save often' do quite well.

Automatic updating

AppImage has a smart and economical way of updating. It calculates the difference between the new AppImage and the old one, and will only download the changes between their versions. In theory the user ends up downloading around 15% each time instead of an entirely new AppImage.

Automatic updating is done via several optional methods. Currently there are 4 methods, 2 through the graphical interface (GUI), and 2 through the command-line/terminal interface (CLI).

GUI method 1 (official)

This is the official AppImageUpdate GUI application.

  1. Download AppImageUpdate-x86_64.AppImage.
  2. Make it executable by right clicking on the file, going in to properties and "Run as an executable".
  3. Double click on the AppImage icon, a dialog box will appear and you'll be prompted to specify what AppImage you want to update.
  4. Specify the path to your existing AppImage.
  5. Once the AppImage is updated, press the button Run updated AppImage.

GUI method 2 (unofficial)

This is a sleeker 3rd-party unofficial version of AppImageUpdate named: AppImageUpdater. It is still in development (at the time of this wiki edit) but nevertheless, quite nice to use.

  1. Download AppImageUpdater-*-x86_64.AppImage
  2. Make it executable:
    chmod +x AppImageUpdater*-x86_64.AppImage
  3. Run it:
    source AppImageUpdater*-x86_64.AppImage
  4. Find your current FreeCAD AppImage and drag-drop it on to the AppImageUpdater

Result: Follow the AppImageUpdater prompts

CLI method 1 (official)

Run the following instructions in your terminal

wget https://github.com/AppImage/AppImageUpdate/releases/download/continuous/appimageupdatetool-x86_64.AppImage
chmod +x ./appimageupdatetool-x86_64.AppImage
./appimageupdatetool.AppImage path/to/old/FreeCAD.AppImage
chmod +x path/to/updated/FreeCAD.AppImage


  • The file names will be unique because of the version info is embedded in them. The above instructions are simplified for convenience.
  • Run ./appimageupdatetool-x86_64.AppImage --help to learn about functionality like -r and --self-update.
  • There is also an i386 version; see the AppImageUpdate release page.

Todo: share a script that can be added as an alias or cron job.

CLI method 2 (unofficial)

Similarly to the Graphical methods having an official and unofficial approaches to downloading AppImages, the same applies to the command line. This is a sleeker 3rd-party command line option to download AppImages

  1. Download appimageupdater-*-x86_64.AppImage
  2. Make it executable:
    chmod +x appimageupdater*-x86_64.AppImage
  3. Run it:
    source appimageupdater*-x86_64.AppImage /path/to/old/FreeCAD-AppImage.AppImage

Result: Updates specified AppImage file if update exists

Unpacking AppImages

Note: this section is intended for developers.

A very convenient aspect of FreeCAD is that a majority of it is built in Python, which doesn't need to be manually compiled like C++. Essentially, a Python file can be modified, and upon restarting FreeCAD those changes will be integrated into the application. A developer can quickly work on the latest FreeCAD release using this technique and an AppImage. Moreover, using an AppImage doesn't modify your system's environment in any way, that is, nothing is installed and no environmental variables are modified.

Modifying AppImages

An AppImage embeds a file system in it with everything that is required to run the application. In order to modify it, the file system needs to be extracted.

./FreeCAD_xxx.AppImage --appimage-extract
cd squashfs-root/

Now open the required Python source files in your preferred code editor, modify them, and save them. Then run the application.


Repackaging AppImages

If you've modified the code, and now want to re-package the AppImage with your latest changes, use the appimagetool-x86_64 tool on the extracted file system.

cd ..
wget "https://github.com/AppImage/AppImageKit/releases/download/continuous/appimagetool-x86_64.AppImage"
chmod +x appimagetool-x86_64.AppImage
./appimagetool-x86_64.AppImage squashfs-root