Skip to content

Commit 278ba67

Browse files
committed
Document additional steps for setting up AppImage installs
1 parent 111b6e1 commit 278ba67

2 files changed

Lines changed: 8 additions & 2 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -237,13 +237,17 @@ flatpak install flathub io.github.pol_rivero.github-desktop-plus
237237

238238
</details>
239239

240-
### AppImage (any distro)
240+
### AppImage (any distro, not recommended)
241241

242242
<details>
243243
<summary>Click to expand</summary>
244244
<br>
245245

246-
**NOTE:** I recommend using your distribution's native package manager (or Flatpak) instead of the AppImage.
246+
**IMPORTANT:** I strongly recommend using your distribution's native package (APT, RPM and AUR packages above) or Flatpak instead of the AppImage, as it requires some manual setup for the sign-in feature to work.
247+
If you need to use the AppImage, follow these steps:
248+
1. (Only if downloaded without "AM"/"AppMan") Manually [create a `.desktop` entry](https://wiki.archlinux.org/title/Desktop_entries). If you used "AM"/"AppMan" to download, this step is not necessary since it creates the .desktop file for you.
249+
2. [Create the `application/x-github-desktop-auth` MIME type](https://wiki.archlinux.org/title/XDG_MIME_Applications#New_MIME_types).
250+
3. [Edit the MIME associations list](https://wiki.archlinux.org/title/XDG_MIME_Applications#mimeapps.list) to link the two.
247251

248252
#### Using ["AM"/"AppMan"](https://github.com/ivan-hc/AM)
249253

docs/known-issues.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,8 @@ If you see an error that says "Not enough resources are available to process thi
245245

246246
Related issue: [#54](https://github.com/pol-rivero/github-desktop-plus/issues/54)
247247

248+
First of all, make sure you are not using the AppImage package, as it requires some manual setup for the sign-in feature to work. Instead, I strongly recommend using your distribution's native package manager (APT, RPM and AUR packages above) or Flatpak.
249+
248250
After following the instructions in your web browser to authorize GitHub Desktop, the callback is not sent to the app and it remains stuck on the "Continue with browser" screen.
249251

250252
The most likely cause is that the URI scheme used by GitHub Desktop Plus for authorization (`x-github-desktop-auth://`) is not linked to the correct program. You can verify if this is the case by fully closing GitHub Desktop Plus (`Ctrl+Q`) and running the following command in your terminal:

0 commit comments

Comments
 (0)