self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2025-11-29 22:48:10 +02:00
Code Issues Releases Activity

All: Add support for application plugins (#3257)

Browse Source
This commit is contained in:
Laurent
2020-10-09 18:35:46 +01:00
committed by GitHub
parent 833fb1264f
commit fe41d37f8f
804 changed files with 95622 additions and 5307 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
docs/faq/index.html
View File

@@ -320,22 +320,33 @@ https://github.com/laurent22/joplin/blob/master/readme/faq.md
<li><a href="https://joplinapp.org/e2ee/">How to enable end-to-end encryption</a></li>
<li><a href="https://joplinapp.org/conflict/">What is a conflict?</a></li>
<li><a href="https://joplinapp.org/debugging/">How to enable debug mode</a></li>
<li><a href="https://joplinapp.org/api/">API documentation</a></li>
<li><a href="https://joplinapp.org/faq/">FAQ</a></li>
</ul>
</li>
<li>
<p>Joplin API</p>
<ul>
<li><a href="https://joplinapp.org/api/overview/">Joplin API Overview</a></li>
<li><a href="https://joplinapp.org/api/get_started/plugins/">Plugin development</a></li>
<li><a href="https://joplinapp.org/api/tutorials/toc_plugin/">Plugin tutorial</a></li>
<li><a href="https://joplinapp.org/plugins/api/classes/joplin.html">Plugin API</a></li>
<li><a href="https://joplinapp.org/api/references/rest_api/">Data API documentation</a></li>
</ul>
</li>
<li>
<p>Development</p>
<ul>
<li><a href="https://github.com/laurent22/joplin/blob/dev/BUILD.md">How to build the apps</a></li>
<li><a href="https://joplinapp.org/spec/">End-to-end encryption spec</a></li>
<li><a href="https://joplinapp.org/spec/history/">Note History spec</a></li>
<li><a href="https://joplinapp.org/spec/sync_lock/">Sync Lock spec</a></li>
<li><a href="https://joplinapp.org/spec/plugins/">Plugin Architecture spec</a></li>
</ul>
</li>
<li>
<p>Google Summer of Code 2020</p>
<ul>
<li><a href="https://joplinapp.org/gsoc2020">Google Summer of Code 2020</a></li>
<li><a href="https://joplinapp.org/gsoc2020/index/">Google Summer of Code 2020</a></li>
<li><a href="https://joplinapp.org/gsoc2020/ideas/">Project Ideas</a></li>
</ul>
</li>
@@ -350,7 +361,8 @@ https://github.com/laurent22/joplin/blob/master/readme/faq.md
</li>
</ul>
</div>
<h1>Installer gets stuck on Windows<a name="installer-gets-stuck-on-windows" href="#installer-gets-stuck-on-windows" class="heading-anchor">🔗</a></h1>
<h1>FAQ<a name="faq" href="#faq" class="heading-anchor">🔗</a></h1>
<h2>Installer gets stuck on Windows<a name="installer-gets-stuck-on-windows" href="#installer-gets-stuck-on-windows" class="heading-anchor">🔗</a></h2>
<p>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:</p>
<ul>
<li>Press Win + R (Windows Key + R)</li>
@@ -361,7 +373,7 @@ https://github.com/laurent22/joplin/blob/master/readme/faq.md
</ul>
<p>Now try to install again and it should work.</p>
<p>More info there: <a href="https://github.com/electron-userland/electron-builder/issues/4057">https://github.com/electron-userland/electron-builder/issues/4057</a></p>
<h1>How can I edit my note in an external text editor?<a name="how-can-i-edit-my-note-in-an-external-text-editor" href="#how-can-i-edit-my-note-in-an-external-text-editor" class="heading-anchor">🔗</a></h1>
<h2>How can I edit my note in an external text editor?<a name="how-can-i-edit-my-note-in-an-external-text-editor" href="#how-can-i-edit-my-note-in-an-external-text-editor" class="heading-anchor">🔗</a></h2>
<p>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 -&gt; Text editor command.</p>
<p>Some example configurations are: (comments after #)</p>
<p>Linux/Mac:</p>
@@ -380,9 +392,9 @@ notepad.exe # Opens Notepad in a new window
notepad++.exe --openSession # Opens Notepad ++ in new window
</code></pre>
<p>Note that the path to directory with your editor executable must exist in your PATH variable (<a href="https://www.computerhope.com/issues/ch000549.htm">Windows</a>, <a href="https://opensource.com/article/17/6/set-path-linux">Linux/Mac</a>) If not, the full path to the executable must be provided.</p>
<h1>When I open a note in vim, the cursor is not visible<a name="when-i-open-a-note-in-vim-the-cursor-is-not-visible" href="#when-i-open-a-note-in-vim-the-cursor-is-not-visible" class="heading-anchor">🔗</a></h1>
<h2>When I open a note in vim, the cursor is not visible<a name="when-i-open-a-note-in-vim-the-cursor-is-not-visible" href="#when-i-open-a-note-in-vim-the-cursor-is-not-visible" class="heading-anchor">🔗</a></h2>
<p>It seems to be due to the setting <code>set term=ansi</code> in .vimrc. Removing it should fix the issue. See <a href="https://github.com/laurent22/joplin/issues/147">https://github.com/laurent22/joplin/issues/147</a> for more information.</p>
<h1>All my notes got deleted after changing the WebDAV URL!<a name="all-my-notes-got-deleted-after-changing-the-webdav-url" href="#all-my-notes-got-deleted-after-changing-the-webdav-url" class="heading-anchor">🔗</a></h1>
<h2>All my notes got deleted after changing the WebDAV URL!<a name="all-my-notes-got-deleted-after-changing-the-webdav-url" href="#all-my-notes-got-deleted-after-changing-the-webdav-url" class="heading-anchor">🔗</a></h2>
<p>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:</p>
<ol>
<li>Make a backup of your Joplin data in case something goes wrong. Export to a JEX archive for example.</li>
@@ -393,19 +405,19 @@ notepad++.exe --openSession # Opens Notepad ++ in new window
<li>Synchronise to verify that everything is working.</li>
<li>Do step 5 and 6 for all the other Joplin clients you need to sync.</li>
</ol>
<h1>How can I easily enter Markdown tags in Android?<a name="how-can-i-easily-enter-markdown-tags-in-android" href="#how-can-i-easily-enter-markdown-tags-in-android" class="heading-anchor">🔗</a></h1>
<h2>How can I easily enter Markdown tags in Android?<a name="how-can-i-easily-enter-markdown-tags-in-android" href="#how-can-i-easily-enter-markdown-tags-in-android" class="heading-anchor">🔗</a></h2>
<p>You may use a special keyboard such as <a href="https://play.google.com/store/apps/details?id=kl.ime.oh&amp;hl=en">Multiling O Keyboard</a>, which has shortcuts to create Markdown tags. <a href="https://discourse.joplinapp.org/t/android-create-new-list-item-with-enter/585/2?u=laurent">More information in this post</a>.</p>
<h1>The initial sync is very slow, how can I speed it up?<a name="the-initial-sync-is-very-slow-how-can-i-speed-it-up" href="#the-initial-sync-is-very-slow-how-can-i-speed-it-up" class="heading-anchor">🔗</a></h1>
<h2>The initial sync is very slow, how can I speed it up?<a name="the-initial-sync-is-very-slow-how-can-i-speed-it-up" href="#the-initial-sync-is-very-slow-how-can-i-speed-it-up" class="heading-anchor">🔗</a></h2>
<p>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 thing up (if you don't want to simply wait for the sync to complete), which are outlined in <a href="https://discourse.joplinapp.org/t/workaround-for-slow-initial-bulk-sync-after-evernote-import/746?u=laurent">this post</a>.</p>
<h1>Is it possible to use real file and folder names in the sync target?<a name="is-it-possible-to-use-real-file-and-folder-names-in-the-sync-target" href="#is-it-possible-to-use-real-file-and-folder-names-in-the-sync-target" class="heading-anchor">🔗</a></h1>
<h2>Is it possible to use real file and folder names in the sync target?<a name="is-it-possible-to-use-real-file-and-folder-names-in-the-sync-target" href="#is-it-possible-to-use-real-file-and-folder-names-in-the-sync-target" class="heading-anchor">🔗</a></h2>
<p>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.</p>
<h1>Could there be a password to restrict access to Joplin?<a name="could-there-be-a-password-to-restrict-access-to-joplin" href="#could-there-be-a-password-to-restrict-access-to-joplin" class="heading-anchor">🔗</a></h1>
<h2>Could there be a password to restrict access to Joplin?<a name="could-there-be-a-password-to-restrict-access-to-joplin" href="#could-there-be-a-password-to-restrict-access-to-joplin" class="heading-anchor">🔗</a></h2>
<p>The end to end encryption that Joplin implements is to protect the data during transmission and on the cloud service so that only you can access it.</p>
<p>On the local device it is assumed that the data is safe due to the OS built-in security features. If additional security is needed it's always possible to put the notes on an encrypted Truecrypt drive for instance.</p>
<p>For these reasons, because the OS or yourself can easily protect the local data, no PIN or password is currently supported to access Joplin.</p>
<p>There is however an issue open about it, so pull requests are welcome: <a href="https://github.com/laurent22/joplin/issues/289">https://github.com/laurent22/joplin/issues/289</a></p>
<h1>WebDAV synchronisation is not working<a name="webdav-synchronisation-is-not-working" href="#webdav-synchronisation-is-not-working" class="heading-anchor">🔗</a></h1>
<h2>&quot;Forbidden&quot; error in Strato<a name="forbidden-error-in-strato" href="#forbidden-error-in-strato" class="heading-anchor">🔗</a></h2>
<h2>WebDAV synchronisation is not working<a name="webdav-synchronisation-is-not-working" href="#webdav-synchronisation-is-not-working" class="heading-anchor">🔗</a></h2>
<h3>&quot;Forbidden&quot; error in Strato<a name="forbidden-error-in-strato" href="#forbidden-error-in-strato" class="heading-anchor">🔗</a></h3>
<p>For example:</p>
<pre><code>MKCOL .sync/: Unknown error 2 (403): &lt;!DOCTYPE HTML PUBLIC &quot;-//IETF//DTD HTML 2.0//EN&quot;&gt;
&lt;html&gt;&lt;head&gt;
@@ -417,22 +429,22 @@ on this server.&lt;/p&gt;
&lt;/body&gt;&lt;/html&gt;
</code></pre>
<p>In this case, <a href="https://github.com/laurent22/joplin/issues/309">make sure you enter the correct WebDAV URL</a>.</p>
<h2>Nextcloud sync is not working<a name="nextcloud-sync-is-not-working" href="#nextcloud-sync-is-not-working" class="heading-anchor">🔗</a></h2>
<h3>Nextcloud sync is not working<a name="nextcloud-sync-is-not-working" href="#nextcloud-sync-is-not-working" class="heading-anchor">🔗</a></h3>
<ul>
<li>Check your username and password. <strong>Type it manually</strong> (without copying and pasting it) and try again.</li>
<li>Check the WebDAV URL - to get the correct URL, go to Nextcloud and, in the left sidebar, click on &quot;Settings&quot; and copy the WebDAV URL from there. <strong>Do not forget to add the folder you've created to that URL</strong>. For example, if the base the WebDAV URL is &quot;<a href="https://example.com/nextcloud/remote.php/webdav/">https://example.com/nextcloud/remote.php/webdav/</a>&quot; and you want the notes to be synced in the &quot;Joplin&quot; directory, you need to give the URL &quot;<a href="https://example.com/nextcloud/remote.php/webdav/Joplin">https://example.com/nextcloud/remote.php/webdav/Joplin</a>&quot; <strong>and you need to create the &quot;Joplin&quot; directory yourself</strong>.</li>
<li>Did you enable <strong>2FA</strong> (Multi-factor authentication) on Nextcloud? In that case, you need to <a href="https://github.com/laurent22/joplin/issues/1453#issuecomment-486640902">create a one-time password for Joplin on the Nextcloud admin interface</a>.</li>
</ul>
<h1>How can I use self-signed SSL certificates on Android?<a name="how-can-i-use-self-signed-ssl-certificates-on-android" href="#how-can-i-use-self-signed-ssl-certificates-on-android" class="heading-anchor">🔗</a></h1>
<h2>How can I use self-signed SSL certificates on Android?<a name="how-can-i-use-self-signed-ssl-certificates-on-android" href="#how-can-i-use-self-signed-ssl-certificates-on-android" class="heading-anchor">🔗</a></h2>
<p>If you want to serve using https but can't or don't want to use SSL certificates signed by trusted certificate authorities (like &quot;Let's Encrypt&quot;), it's possible to generate a custom CA and sign your certificates with it. You can generate the CA and certificates using <a href="https://gist.github.com/fntlnz/cf14feb5a46b2eda428e000157447309">openssl</a>, but I like to use a tool called <a href="https://github.com/FiloSottile/mkcert">mkcert</a> for it's 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 (<a href="https://support.google.com/nexus/answer/2844832?hl=en-GB">link</a>).</p>
<h1>How do I restart Joplin on Windows (so that certain changes take effect)?<a name="how-do-i-restart-joplin-on-windows-so-that-certain-changes-take-effect" href="#how-do-i-restart-joplin-on-windows-so-that-certain-changes-take-effect" class="heading-anchor">🔗</a></h1>
<h2>How do I restart Joplin on Windows (so that certain changes take effect)?<a name="how-do-i-restart-joplin-on-windows-so-that-certain-changes-take-effect" href="#how-do-i-restart-joplin-on-windows-so-that-certain-changes-take-effect" class="heading-anchor">🔗</a></h2>
<p>If <code>Show tray icon</code> 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:</p>
<ul>
<li>click <code>File</code> in the menu and then click <code>Quit</code></li>
<li>right-click on the Joplin tray icon and then click <code>Exit</code></li>
</ul>
<p>Additionally the Windows Task Manager can be used to verify whether Joplin is still around.</p>
<h1>Why is it named Joplin?<a name="why-is-it-named-joplin" href="#why-is-it-named-joplin" class="heading-anchor">🔗</a></h1>
<h2>Why is it named Joplin?<a name="why-is-it-named-joplin" href="#why-is-it-named-joplin" class="heading-anchor">🔗</a></h2>
<p>The name comes from the composer and pianist <a href="https://en.wikipedia.org/wiki/Scott_Joplin">Scott Joplin</a>, which I often listen to. His name is also easy to remember and type so it felt like a good choice. And, to quote a user on Hacker News, &quot;though Scott Joplin's ragtime musical style has a lot in common with some very informal music, his own approach was more educated, sophisticated, and precise. Every note was in its place for a reason, and he was known to prefer his pieces to be performed exactly as written. So you could say that compared to the people who came before him, his notes were more organized&quot;.</p>
<div class="bottom-links">