readme/faq.md
The installer may get stuck if the app was not uninstalled correctly. To fix the issue you will need to clean up the left-over entry from the Registry. To do so please follow these steps:
HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\UninstallNow try to install again and it should work.
More info there: https://github.com/electron-userland/electron-builder/issues/4057
You can pass arguments to the installation script by using this command.
<pre><code style="word-break: break-all">wget -O - https://raw.githubusercontent.com/laurent22/joplin/dev/Joplin_install_and_update.sh | bash -s -- --argument1 --argument2</code></pre>If you downloaded the AppImage directly and therefore did not install via the recommended script then it may not be currently allowed to execute and needs to have these permissions set manually (see AppImage User Guide).
If execution permissions are correct and it still does not launch then your system may not have the libfuse2 library that AppImages require to run. This library requirement is inherent to the AppImage format and not Joplin specifically. For more info see this forum thread which has further detail on the issue and an Ubuntu specific fix.
The editor command (may include arguments) defines which editor will be used to open a note. If none is provided it will try to auto-detect the default editor. If this does nothing or you want to change it for Joplin, you need to configure it in the Preferences -> Text editor command.
Some example configurations are: (comments after #)
Linux/Mac:
subl -n -w # Opens Sublime (subl) in a new window (-n) and waits for close (-w)
code -n --wait # Opens Visual Studio Code (code) in a new window (-n) and waits for close (--wait)
gedit --new-window # Opens gedit (Gnome Text Editor) in a new window
xterm -e vim # Opens a new terminal and opens vim. Can be replaced with an
# alternative terminal (gnome-terminal, terminator, etc.)
# or terminal text-editor (emacs, nano, etc.)
open -a <application> # Mac only: opens a GUI application
Windows:
subl.exe -n -w # Opens Sublime (subl) in a new window (-n) and waits for close (-w)
code.exe -n --wait # Opens Visual Studio Code in a new window (-n) and waits for close (--wait)
notepad.exe # Opens Notepad in a new window
notepad++.exe --openSession # Opens Notepad ++ in new window
Note that the path to the directory with your editor executable must exist in your PATH variable (Windows, Linux/Mac). If not, the full path to the executable must be provided.
It seems to be due to the setting set term=ansi in .vimrc. Removing it should fix the issue. See https://github.com/laurent22/joplin/issues/147 for more information.
When changing the WebDAV URL, make sure that the new location has the same exact content as the old location (i.e. copy all the Joplin data over to the new location). Otherwise, if there's nothing on the new location, Joplin is going to think that you have deleted all your data and will proceed to delete it locally too. So to change the WebDAV URL, please follow these steps:
.resource directory as it contains your images and other attachments.If you know the NOTE_ID and have note history enabled you can run the command restoreNoteRevision from the command palette e.g. restoreNoteRevision 66457326a6ba4adeb4be8ce05e37af0d. Joplin will then confirm if the restore was successful and place the note in a "Restored Note" notebook.
If you do not know the NOTE_ID then you can find this within the Joplin sqlite database as the item_id within the deleted_items or revisions tables. It will require some manual checking of the title_diff and body_diff fields to check if the ITEM/NOTE_ID you are targeting is the correct one.
You should first take a copy of the database to avoid making any accidental changes in the live one.
For further information go here.
You may use a special keyboard such as Multiling O Keyboard, which has shortcuts to create Markdown tags. More information in this post.
Whenever importing a large number of notes, for example from Evernote, it may take a very long time for the first sync to complete. There are various techniques to speed this up (if you don't want to simply wait for the sync to complete), which are outlined in this post.
Joplin does not have a background sync on mobile devices. When Joplin is closed, sent to the background or the device is put into sleep (display off), the sync is interrupted.
Go to the synchronisation page. You can find it on the desktop application under Help > Synchronisation Status and on the mobile app under Configuration > Tools > SYNC STATUS.
total items = How many items there are in total to sync.
synced items = How many items have already been uploaded or downloaded.
If total items and synced items are equal, all data has been synced. Also all devices should have the same total items.
Unfortunately it is not possible. Joplin synchronises with file systems using an open format however it does not mean the sync files are meant to be user-editable. The format is designed to be performant and reliable, not user friendly (it cannot be both), and that cannot be changed. Joplin sync directory is basically just a database.
On mobile, you may enable the biometric lock to protect the access to the Joplin application. On desktop we do not currently support this. There is however an issue open about it: https://github.com/laurent22/joplin/issues/289
For example:
MKCOL .sync/: Unknown error 2 (403): <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<html><head>
<title>403 Forbidden</title>
</head><body>
<h1>Forbidden</h1>
<p>You don't have permission to access /.sync/
on this server.</p>
</body></html>
In this case, make sure you enter the correct WebDAV URL.
If you want to serve using https but can't or don't want to use SSL certificates signed by trusted certificate authorities (like "Let's Encrypt"), it's possible to generate a custom CA and sign your certificates with it. You can generate the CA and certificates using openssl, but I like to use a tool called mkcert for its simplicity. Finally, you have to add your CA certificate to Android settings so that Android can recognize the certificates you signed with your CA as valid (link).
If Show tray icon is enabled, closing the Joplin window does not quit the application. To restart the application properly, one of the following has to be done to quit Joplin:
File in the menu and then click QuitExitAdditionally the Windows Task Manager can be used to verify whether Joplin is still around.
Notebooks and notes on iOS are not backed up when backing up to your Mac.
The application is named in honour of composer and pianist Scott Joplin, whose music I frequently listen to. His name is also easy to remember and type, making it a fitting choice.