Skip to content

added linux installation guide #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

added linux installation guide #43

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ However, would it not be even better if it were to behave like a native app on y
- [**Mac**](#mac)
- [**Linux**](#linux)
- [**Windows**](#windows)
- [Installation on Linux](#installation-on-linux)
- [How it works](#how-it-works)
- [Troubleshooting](#troubleshooting)
- [Institutional login](#institutional-login)
Expand Down Expand Up @@ -88,6 +89,26 @@ For now, the following binaries have been precompiled and can be downloaded dire

If your platform / architecture is missing, let me know via the [discussions page](https://github.com/fjwillemsen/NativeOverleaf/discussions), or compile it yourself using the instructions below.

## Installation on Linux

After downloading the zip-file you should extract it and move the directory to `sudo mv /path/to/Overleaf-linux-x64 /opt/`. </br>
Then you can create a Desktop Entry in `/usr/share/applications` </br>
```
$ cd /usr/share/applications
$ sudo nano overleaf.desktop
$ sudo vim overleaf.desktop

[Desktop Entry]
Name=Overleaf
Type=Application
Terminal=false
Icon=/opt/Overleaf-linux-x64/resources/app/icon.png
Exec=/opt/Overleaf-linux-x64/Overleaf
Categories=Science
```

After ca. 30 seconds you should see Overleaf as a Desktop entry. This is tested for **Debian 12**.

## How it works
Using [nativefier](https://github.com/nativefier/nativefier), the Overleaf website is wrapped as an Electron app and injected with JavaScript. While this is not optimally efficient and we may switch to a more efficient framework in the future, it does allow combining the webapp with native features for a large number of supported platforms.
<!-- may switch to [Multi](https://github.com/kofigumbs/multi), but macOS only -->
Expand Down