joplin/readme/install.md

sidebar_position
0.5

Installation

Three types of applications are available: for desktop (Windows, macOS and Linux), for mobile (Android and iOS) and for terminal (Windows, macOS, Linux and FreeBSD). All the applications have similar user interfaces and can synchronise with each other.

Desktop applications

Operating System	Download
Windows (32 and 64-bit)
macOS
macOS M1 (Apple Silicon)
Linux

On Windows, you may also use the Portable version. The portable application allows installing the software on a portable device such as a USB key. Simply copy the file JoplinPortable.exe in any directory on that USB key ; the application will then create a directory called "JoplinProfile" next to the executable file.

On Linux, the recommended way is to use the following installation script as it will handle the desktop icon too:

wget -O - https://raw.githubusercontent.com/laurent22/joplin/dev/Joplin_install_and_update.sh | bash

The install and update script supports the following flags (around line 50 at the time of this writing).

Mobile applications

Operating System	Download	Alt. Download
Android		or download the APK file
iOS		-

Terminal application

Operating system	Method
macOS, Linux, or Windows (via WSL)	Important: First, install Node 12+. NPM_CONFIG_PREFIX=~/.joplin-bin npm install -g joplin sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin By default, the application binary will be installed under ~/.joplin-bin. You may change this directory if needed. Alternatively, if your npm permissions are setup as described here (Option 2) then simply running npm -g install joplin would work.

To start it, type joplin.

For usage information, please refer to the full Joplin Terminal Application Documentation.

Web Clipper

The Web Clipper is a browser extension that allows you to save web pages and screenshots from your browser. For more information on how to install and use it, see the Web Clipper Help Page.

Unofficial Alternative Distributions

There are a number of unofficial alternative Joplin distributions. If you do not want to or cannot use appimages or any of the other officially supported releases then you may wish to consider these.

However these come with a caveat in that they are not officially supported so certain issues may not be supportable by the main project. Rather support requests, bug reports and general advice would need to go to the maintainers of these distributions.

A community maintained list of these distributions can be found here: Unofficial Joplin distributions