self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2025-01-11 18:24:43 +02:00
Code Issues Releases Activity

Update website

Browse Source
This commit is contained in:
Laurent Cozic 2019-05-13 23:41:31 +01:00
parent bc98b65efa
commit 52e5cec585
6 changed files with 40 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Tools/build-website.js
View File

@ -353,6 +353,10 @@ function markdownToHtml(md) {
output = output.toLowerCase();
while (output.length && output[output.length - 1] === '-') {
output = output.substr(0, output.length - 1);
}
let temp = output;
let index = 1;
while (doneNames.indexOf(temp) >= 0) {

2
docs/e2ee/index.html
View File

@ -269,7 +269,7 @@
</li>
</ul>
</div>
<h1><a name="about-end-to-end-encryption-e2ee-" href="#about-end-to-end-encryption-e2ee-" class="heading-anchor">🔗</a>About End-To-End Encryption (E2EE)</h1>
<h1><a name="about-end-to-end-encryption-e2ee" href="#about-end-to-end-encryption-e2ee" class="heading-anchor">🔗</a>About End-To-End Encryption (E2EE)</h1>
<p>End-to-end encryption (E2EE) is a system where only the owner of the data (i.e. notes, notebooks, tags or resources) can read it. It prevents potential eavesdroppers - including telecom providers, internet providers, and even the developers of Joplin from being able to access the data.</p>
<p>The system is designed to defeat any attempts at surveillance or tampering because no third party can decipher the data being communicated or stored.</p>
<p>There is a small overhead to using E2EE since data constantly has to be encrypted and decrypted so consider whether you really need the feature.</p>

25
docs/faq/index.html
View File

@ -269,7 +269,7 @@
</li>
</ul>
</div>
<h1><a name="clicking-edit-in-external-editor-does-nothing-i-want-to-change-the-editor-" href="#clicking-edit-in-external-editor-does-nothing-i-want-to-change-the-editor-" class="heading-anchor">🔗</a>Clicking 'Edit in External Editor' does nothing! / I want to change the editor!</h1>
<h1><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>How can I edit my note in an external text editor?</h1>
<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>
@ -290,7 +290,7 @@ notepad++.exe --openSession # Opens Notepad ++ in new window
<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><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>When I open a note in vim, the cursor is not visible</h1>
<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><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>All my notes got deleted after changing the WebDAV URL!</h1>
<h1><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>All my notes got deleted after changing the WebDAV URL!</h1>
<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>
@ -301,16 +301,17 @@ 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><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>How can I easily enter Markdown tags in Android?</h1>
<h1><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>How can I easily enter Markdown tags in Android?</h1>
<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.joplin.cozic.net/t/android-create-new-list-item-with-enter/585/2?u=laurent">More information in this post</a>.</p>
<h1><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>The initial sync is very slow, how can I speed it up?</h1>
<h1><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>The initial sync is very slow, how can I speed it up?</h1>
<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.joplin.cozic.net/t/workaround-for-slow-initial-bulk-sync-after-evernote-import/746?u=laurent">this post</a>.</p>
<h1><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>Is it possible to use real file and folder names in the sync target?</h1>
<h1><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>Is it possible to use real file and folder names in the sync target?</h1>
<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><a name="could-there-be-a-pin-or-password-to-restrict-access-to-joplin-" href="#could-there-be-a-pin-or-password-to-restrict-access-to-joplin-" class="heading-anchor">🔗</a>Could there be a PIN or password to restrict access to Joplin?</h1>
<p>Short answer: no. 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>
<h1><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>Could there be a password to restrict access to Joplin?</h1>
<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>If someone that you don't trust has access to the computer, they can put a keylogger anyway so any local encryption or PIN access would not be useful.</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><a name="webdav-synchronisation-is-not-working" href="#webdav-synchronisation-is-not-working" class="heading-anchor">🔗</a>WebDAV synchronisation is not working</h1>
<h2><a name="forbidden-error-in-strato" href="#forbidden-error-in-strato" class="heading-anchor">🔗</a>&quot;Forbidden&quot; error in Strato</h2>
<p>For example:</p>
@ -330,12 +331,10 @@ on this server.&lt;/p&gt;
<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><a name="could-you-publish-joplin-on-f-droid-" href="#could-you-publish-joplin-on-f-droid-" class="heading-anchor">🔗</a>Could you publish Joplin on F-droid?</h1>
<p>Joplin relies on Firebase to enable reliable notifications on Android. Since F-Droid <a href="https://gitlab.com/fdroid/rfp/issues/434#note_55239154">do not accept applications that depend on this package</a>, it is not currently possible to have Joplin in that repository. To avoid using Google Play, you have the option to directly download the Joplin APK file.</p>
<h1><a name="why-is-it-named-joplin-" href="#why-is-it-named-joplin-" class="heading-anchor">🔗</a>Why is it named Joplin?</h1>
<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 fell 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>
<h1><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>How can I use self-signed SSL certificates on Android?</h1>
<h1><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>How can I use self-signed SSL certificates on Android?</h1>
<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><a name="why-is-it-named-joplin" href="#why-is-it-named-joplin" class="heading-anchor">🔗</a>Why is it named Joplin?</h1>
<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 fell 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>
<script>
function stickyHeader() {

20
docs/stats/index.html
View File

@ -280,15 +280,15 @@
<tbody>
<tr>
<td>Total Windows downloads</td>
<td>248,399</td>
<td>248,416</td>
</tr>
<tr>
<td>Total macOs downloads</td>
<td>108,378</td>
<td>108,379</td>
</tr>
<tr>
<td>Total Linux downloads</td>
<td>85,971</td>
<td>85,974</td>
</tr>
<tr>
<td>Windows %</td>
@ -319,18 +319,18 @@
<tr>
<td><a href="https://github.com/laurent22/joplin/releases/tag/v1.0.152">v1.0.152</a></td>
<td>2019-05-13T09:08:07Z</td>
<td>1,304</td>
<td>490</td>
<td>223</td>
<td>2,017</td>
<td>1,320</td>
<td>491</td>
<td>225</td>
<td>2,036</td>
</tr>
<tr>
<td><a href="https://github.com/laurent22/joplin/releases/tag/v1.0.151">v1.0.151</a></td>
<td>2019-05-12T15:14:32Z</td>
<td>1,855</td>
<td>1,856</td>
<td>498</td>
<td>942</td>
<td>3,295</td>
<td>943</td>
<td>3,297</td>
</tr>
<tr>
<td><a href="https://github.com/laurent22/joplin/releases/tag/v1.0.150">v1.0.150</a></td>

18
readme/faq.md
View File

@ -1,4 +1,4 @@
# Clicking 'Edit in External Editor' does nothing! / I want to change the editor!
# How can I edit my note in an external text editor?
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.
@ -55,13 +55,15 @@ Whenever importing a large number of notes, for example from Evernote, it may ta
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.
# Could there be a PIN or password to restrict access to Joplin?
# Could there be a password to restrict access to Joplin?
Short answer: no. 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.
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.
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.
If someone that you don't trust has access to the computer, they can put a keylogger anyway so any local encryption or PIN access would not be useful.
For these reasons, because the OS or yourself can easily protect the local data, no PIN or password is currently supported to access Joplin.
There is however an issue open about it, so pull requests are welcome: https://github.com/laurent22/joplin/issues/289
# WebDAV synchronisation is not working
@ -86,14 +88,10 @@ In this case, [make sure you enter the correct WebDAV URL](https://github.com/la
- Check the WebDAV URL - to get the correct URL, go to Nextcloud and, in the left sidebar, click on "Settings" and copy the WebDAV URL from there. **Do not forget to add the folder you've created to that URL**. For example, if the base the WebDAV URL is "https://example.com/nextcloud/remote.php/webdav/" and you want the notes to be synced in the "Joplin" directory, you need to give the URL "https://example.com/nextcloud/remote.php/webdav/Joplin" **and you need to create the "Joplin" directory yourself**.
- Did you enable **2FA** (Multi-factor authentication) on Nextcloud? In that case, you need to [create a one-time password for Joplin on the Nextcloud admin interface](https://github.com/laurent22/joplin/issues/1453#issuecomment-486640902).
# Could you publish Joplin on F-droid?
# How can I use self-signed SSL certificates on Android?
Joplin relies on Firebase to enable reliable notifications on Android. Since F-Droid [do not accept applications that depend on this package](https://gitlab.com/fdroid/rfp/issues/434#note_55239154), it is not currently possible to have Joplin in that repository. To avoid using Google Play, you have the option to directly download the Joplin APK file.
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](https://gist.github.com/fntlnz/cf14feb5a46b2eda428e000157447309), but I like to use a tool called [mkcert](https://github.com/FiloSottile/mkcert) 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 ([link](https://support.google.com/nexus/answer/2844832?hl=en-GB)).
# Why is it named Joplin?
The name comes from the composer and pianist [Scott Joplin](https://en.wikipedia.org/wiki/Scott_Joplin), which I often listen to. His name is also easy to remember and type so it fell like a good choice. And, to quote a user on Hacker News, "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".
# How can I use self-signed SSL certificates on Android?
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](https://gist.github.com/fntlnz/cf14feb5a46b2eda428e000157447309), but I like to use a tool called [mkcert](https://github.com/FiloSottile/mkcert) 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 ([link](https://support.google.com/nexus/answer/2844832?hl=en-GB)).

10
readme/stats.md
View File

@ -2,17 +2,17 @@
Name | Value
--- | ---
Total Windows downloads | 248,399
Total macOs downloads | 108,378
Total Linux downloads | 85,971
Total Windows downloads | 248,416
Total macOs downloads | 108,379
Total Linux downloads | 85,974
Windows % | 56%
macOS % | 24%
Linux % | 19%
Version | Date | Windows | macOS | Linux | Total
--- | --- | --- | --- | --- | ---
[v1.0.152](https://github.com/laurent22/joplin/releases/tag/v1.0.152) | 2019-05-13T09:08:07Z | 1,304 | 490 | 223 | 2,017
[v1.0.151](https://github.com/laurent22/joplin/releases/tag/v1.0.151) | 2019-05-12T15:14:32Z | 1,855 | 498 | 942 | 3,295
[v1.0.152](https://github.com/laurent22/joplin/releases/tag/v1.0.152) | 2019-05-13T09:08:07Z | 1,320 | 491 | 225 | 2,036
[v1.0.151](https://github.com/laurent22/joplin/releases/tag/v1.0.151) | 2019-05-12T15:14:32Z | 1,856 | 498 | 943 | 3,297
[v1.0.150](https://github.com/laurent22/joplin/releases/tag/v1.0.150) | 2019-05-12T11:27:48Z | 375 | 107 | 53 | 535
[v1.0.148](https://github.com/laurent22/joplin/releases/tag/v1.0.148) | 2019-05-08T19:12:24Z | 108 | 33 | 73 | 214
[v1.0.145](https://github.com/laurent22/joplin/releases/tag/v1.0.145) | 2019-05-03T09:16:53Z | 6,823 | 2,817 | 1,422 | 11,062