feat: Initial clean release of CHM

readme/apps/sync/_category_.yml

@@ -0,0 +1,4 @@
+position: 2
+label: 'Synchronisation'
+collapsible: true
+collapsed: true

readme/apps/sync/dropbox.md

@@ -0,0 +1,7 @@
+# Dropbox synchronisation
+
+When syncing with Dropbox, Joplin creates a sub-directory in Dropbox, in `/Apps/Joplin` and reads/writes the notes and notebooks in it. The application does not have access to anything outside this directory.
+
+In the **desktop application** or **mobile application**, select "Dropbox" as the synchronisation target in the [Configuration screen](https://github.com/laurent22/joplin/blob/dev/readme/apps/config_screen.md) (it is selected by default). Then, to initiate the synchronisation process, click on the "Synchronise" button in the sidebar and follow the instructions.
+
+In the **terminal application**, to initiate the synchronisation process, type `:sync`. You will be asked to follow a link to authorise the application.

readme/apps/sync/e2ee.md

@@ -0,0 +1,32 @@
+# End-To-End Encryption (E2EE)
+
+Joplin supports end-to-end encryption (E2EE) on all the applications. 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.
+
+The system is designed to defeat any attempts at surveillance or tampering because no third party can decipher the data being communicated or stored.
+
+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.
+
+## Enabling E2EE
+
+Due to the decentralised nature of Joplin, E2EE needs to be manually enabled on a single device first (this will create a Master Key for encryption secured by your password) and then it must be synced with all other remaining devices. It is recommended to start with the desktop or terminal application since they generally run on more powerful devices (unlike the mobile application), and so they can encrypt the initial data faster.
+
+To enable it, please follow these steps:
+
+1. On your first device (eg. on the desktop application), go to the Encryption  [Configuration screen](https://github.com/laurent22/joplin/blob/dev/readme/apps/config_screen.md) and click "Enable encryption"
+2. Input your password. This is the Master Key password which will be used to encrypt all your notes. Make sure you do not forget it since, for security reason, it cannot be recovered.
+3. Now you need to synchronise all your notes so that they are sent encrypted to the sync target (eg. to OneDrive, Nextcloud, etc.). Wait for any synchronisation that might be in progress and click on "Synchronise".
+4. Wait for this synchronisation operation to complete. Since all the data needs to be re-sent (encrypted) to the sync target, it may take a long time, especially if you have many notes and resources. Note that even if synchronisation seems stuck, most likely it is still running - do not cancel it and simply let it run over night if needed.
+5. Once this first synchronisation operation is done, open the next device you are synchronising with. Click "Synchronise" and wait for the sync operation to complete. The device will receive the master key, and you will need to provide the password for it. At this point E2EE will be automatically enabled on this device. Once done, click Synchronise again and wait for it to complete.
+6. Repeat step 5 for each device.
+
+Do not manually enable encryption on multiple devices in parallel, but rather wait for the other ones to sync with the first already encrypted device. Otherwise, you may end up with multiple encryption keys (which is supported by Joplin but most probably not what you want).
+
+Once all the devices are in sync with E2EE enabled, the encryption/decryption should be mostly transparent. Occasionally you may see encrypted items but they will get decrypted in the background eventually.
+
+## Disabling E2EE
+
+Follow the same procedure as above but instead disable E2EE on each device one by one. Again it might be simpler to do it one device at a time and to wait every time for the synchronisation to complete.
+
+## Technical specification
+
+For a more technical description, mostly relevant for development or to review the method being used, please see the [Encryption specification](https://github.com/laurent22/joplin/blob/dev/readme/dev/spec/e2ee/index.md).

readme/apps/sync/index.md

@@ -0,0 +1,9 @@
+# Synchronisation
+
+One of the goals of Joplin is to avoid being tied to any particular company or service, whether it is Evernote, Google or Microsoft. As such the synchronisation is designed without any hard dependency to any particular service. Most of the synchronisation process is done at an abstract level and access to external services, such as Nextcloud or Dropbox, is done via lightweight drivers. It is easy to support new services by creating simple drivers that provide a filesystem-like interface, i.e. the ability to read, write, delete and list items. It is also simple to switch from one service to another.
+
+Currently, synchronisation is possible with Joplin Cloud, Nextcloud, S3, WebDAV, Dropbox, OneDrive or the local filesystem. To enable synchronisation please follow the instructions below. After that, the application will synchronise in the background whenever it is running, or you can click on "Synchronise" to start a synchronisation manually. Joplin will background sync automatically after any content change is made on the local application.
+
+If the **terminal client** has been installed, it is possible to also synchronise outside of the user interface by typing `joplin sync` from the terminal. This can be used to setup a cron script to synchronise at a regular interval. For example, this would do it every 30 minutes:
+
+` */30 * * * * /path/to/joplin sync`

readme/apps/sync/joplin_cloud.md

@@ -0,0 +1,17 @@
+# Joplin Cloud synchronisation
+
+[Joplin Cloud](https://joplinapp.org/plans/) is a web service specifically designed for Joplin. Besides synchronising your data, it also allows you to publish a note to the internet, or share a notebook with your friends, family or colleagues. Joplin Cloud, compared to other services, also features a number of performance improvements allowing for faster synchronisation.
+
+To use it, go to the [Configuration screen](https://github.com/laurent22/joplin/blob/dev/readme/apps/config_screen.md), then to the Synchronisation section. In the list of sync targets, select "Joplin Cloud". Enter your email and password, and you're ready to use Joplin Cloud.
+
+## Joplin Server Business
+
+For organisations that prefer to host and manage their own data, Joplin Server Business provides a self-hosted alternative to Joplin Cloud. It includes additional features for organisations and a commercial licence for Joplin Server.
+
+[You can try Joplin Server Business free for 14 days or purchase a licence directly](https://joplinapp.org/plans/?hosting=self).
+
+## Video tutorial
+
+Watch this short video to learn how to setup Joplin Cloud synchronisation:
+
+[![Watch the video](https://img.youtube.com/vi/AxKKxTBO8go/hqdefault.jpg)](https://www.youtube.com/watch?v=AxKKxTBO8go)

readme/apps/sync/nextcloud.md

@@ -0,0 +1,16 @@
+# Nextcloud synchronisation
+
+<img src="https://raw.githubusercontent.com/laurent22/joplin/dev/Assets/WebsiteAssets/images/nextcloud-logo-background.png" width="100" align="left"> <a href="https://nextcloud.com/">Nextcloud</a> is a self-hosted, private cloud solution. It can store documents, images and videos but also calendars, passwords and countless other things and can sync them to your laptop or phone. As you can host your own Nextcloud server, you own both the data on your device and infrastructure used for synchronisation. As such it is a good fit for Joplin. The platform is also well supported and with a strong community, so it is likely to be around for a while - since it's open source anyway, it is not a service that can be closed, it can exist on a server for as long as one chooses.
+
+In the **desktop application** or **mobile application**, go to the [Configuration screen](https://github.com/laurent22/joplin/blob/dev/readme/apps/config_screen.md) and select Nextcloud as the synchronisation target. Then input the WebDAV URL (to get it, click on Settings in the bottom left corner of the files view page in Nextcloud), this is normally `https://example.com/nextcloud/remote.php/webdav/Joplin` or `https://example.com/nextcloud/remote.php/dav/files/<nextcloud-username>/Joplin` (**make sure to create the "Joplin" directory in Nextcloud**), and set the username and password. If it does not work, please [see this explanation](https://github.com/laurent22/joplin/issues/61#issuecomment-373282608) for more details.    
+
+In the **terminal application**, you will need to set the `sync.target` config variable and all the `sync.5.path`, `sync.5.username` and `sync.5.password` config variables to, respectively the Nextcloud WebDAV URL, your username and your password. This can be done from the command line mode using:
+
+	:config sync.5.path https://example.com/nextcloud/remote.php/webdav/Joplin
+	:config sync.5.username YOUR_USERNAME
+	:config sync.5.password YOUR_PASSWORD
+	:config sync.target 5
+
+If synchronisation does not work, please consult the logs in the app profile directory - it is often due to a misconfigured URL or password. The log should indicate what the exact issue is.
+
+After completing the setup, open the Nextcloud desktop client and disable syncing for the Joplin data directory, since synchronisation should be handled exclusively by Joplin.

readme/apps/sync/onedrive.md

@@ -0,0 +1,7 @@
+# OneDrive synchronisation
+
+When syncing with OneDrive, Joplin creates a sub-directory in OneDrive, in /Apps/Joplin and reads/writes the notes and notebooks in it. The application does not have access to anything outside this directory.
+
+In the **desktop application** or **mobile application**, select "OneDrive" as the synchronisation target in the [Configuration screen](https://github.com/laurent22/joplin/blob/dev/readme/apps/config_screen.md). Then, to initiate the synchronisation process, click on the "Synchronise" button in the sidebar and follow the instructions.
+
+In the **terminal application**, to initiate the synchronisation process, type `:sync`. You will be asked to follow a link to authorise the application (simply input your Microsoft credentials - you do not need to register with OneDrive).

readme/apps/sync/s3.md

@@ -0,0 +1,86 @@
+# S3 synchronisation
+
+As of Joplin 2.x.x, Joplin supports multiple S3 providers. We expose some options that will need to be configured depending on your provider of choice. See below for the providers that have been tested and confirmed to work.
+
+In the **desktop application** or **mobile application**, select "S3 (Beta)" as the synchronisation target in the [Configuration screen](https://github.com/laurent22/joplin/blob/dev/readme/apps/config_screen.md).
+
+- **S3 Bucket:** The name of your Bucket, such as `joplin-bucket`
+- **S3 URL:** Fully qualified URL; For AWS this should be `https://s3.<regionName>.amazonaws.com/`
+- **S3 Access Key & S3 Secret Key:**  The User's programmatic access key.  To create a new key & secret on AWS, visit [IAM Security Credentials](https://console.aws.amazon.com/iam/home#/security_credentials). For other providers follow their documentation.
+- **S3 Region:** Some providers require you to provide the region of your bucket. This is usually in the form of "eu-west1" or something similar depending on your region. For providers that do not require a region, you can leave it blank.
+- **Force Path Style**: This setting enables Joplin to talk to S3 providers using an older style S3 Path. Depending on your provider you may need to try with this on and off.
+
+
+While creating a new Bucket for Joplin, disable **Bucket Versioning**, enable **Block all public access** and enable **Default encryption** with `Amazon S3 key (SSE-S3)`. Some providers do not expose these options, and it could create a syncing problem. Do attempt and report back so we can update the documentation appropriately.
+
+To add a **Bucket Policy** from the AWS S3 Web Console, navigate to the **Permissions** tab. Temporarily disable **Block all public access**  to edit the Bucket policy, something along the lines of:
+```
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Sid": "VisualEditor0",
+            "Effect": "Allow",
+            "Action": [
+                  "s3:ListBucket",
+                  "s3:GetBucketLocation",
+                  "s3:GetObject",
+                  "s3:DeleteObject",
+                  "s3:DeleteObjectVersion",
+                  "s3:PutObject"
+            ],
+            "Resource": [
+                "arn:aws:s3:::joplin-bucket",
+                "arn:aws:s3:::joplin-bucket/*"
+            ]
+        }
+    ]
+}
+```
+
+## Configuration settings for tested providers
+
+All providers will require a bucket, Access Key, and Secret Key.
+
+If you provide a configuration and you receive "success!" on the "check config" then your S3 sync should work for your provider. If you do not receive success, you may need to adjust your settings, or save them, restart the app, and attempt a sync. This may reveal more clear error messaging that will help you deduce the problem.
+
+## AWS
+- URL: `https://s3.<region>.amazonaws.com/` (fill in your region, a complete list of endpoint addresses can be found [here](https://docs.aws.amazon.com/general/latest/gr/s3.html))
+- Region: required
+- Force Path Style: unchecked
+
+## Backblaze
+- URL: `https://s3.<region>.backblazeb2.com` (This is the endpoint URL provided by Backblaze B2)
+- Region: required (Copied from the provided endpoint URL. Example: `us-east-001`)
+- Force Path Style: unchecked
+
+## Cloudflare R2
+- URL: `https://<ACCOUNT_ID>.r2.cloudflarestorage.com` (clicking on API > "Use R2 with APIs" in Cloudflare Dashboard will show you the correct URL)
+- S3 Access Key & S3 Secret Key: Generate an API Token by going to Manage API tokens > "Create Account API Token". Give the API Token `Object Read & Write` permissions. Use the resulting `Access Key ID` and `Secret Access Key` as the S3 Access Key & S3 Secret Key in Joplin
+- Region: `auto`
+- Force Path Style: unchecked
+
+## DigitalOcean
+- URL: `https://<region>.digitaloceanspaces.com` (region is selected when the bucket is created, available regions listed [here](https://docs.digitalocean.com/products/spaces/details/availability/))
+- Region: required, but no impact on the actual region as it's defined in the URL. Suggest entering `us-east-1`.
+- Force Path Style: unchecked
+
+## Linode
+- URL: `https://<region>.linodeobjects.com` (region is in the URL provided by Linode; this URL is also the same as the URL provided by Linode with the bucket name removed)
+- Region: Anything you want to type, can't be left empty
+- Force Path Style: unchecked
+
+## Scaleway
+- URL: `https://s3.<region>.scw.cloud` (The region is the same as the bucket's region. You could just copy your bucket endpoint in the bucket settings tab, then remove the bucket name from it.)
+- Region: required (example: `fr-par`)
+- Force Path Style: unchecked
+
+## UpCloud
+- URL: `https://<account>.<region>.upcloudobjects.com` (They will provide you with multiple URLs, the one that follows this pattern should work.)
+- Region: required
+- Force Path Style: unchecked
+
+## Tebi
+- URL: `https://s3.tebi.io` (This is the endpoint URL provided by Tebi)
+- Region: required
+- Force Path Style: unchecked

readme/apps/sync/webdav.md

@@ -0,0 +1,21 @@
+# WebDAV synchronisation
+
+Select the "WebDAV" synchronisation target and follow the same instructions as for Nextcloud above (for the **terminal application** you will need to select sync target 6 rather than 5)
+
+WebDAV-compatible services that are known to work with Joplin:
+
+- [Apache WebDAV Module](https://httpd.apache.org/docs/current/mod/mod_dav.html)
+- [DriveHQ](https://www.drivehq.com)
+- [Fastmail](https://www.fastmail.com/)
+- [HiDrive](https://www.strato.fr/stockage-en-ligne/) from Strato. [Setup help](https://github.com/laurent22/joplin/issues/309)
+- [InfiniCLOUD](https://infini-cloud.net/)
+- [Mailbox.org WebDAV](https://kb.mailbox.org/en/private/drive/) [Setup help](https://userforum-en.mailbox.org/topic/2766-unable-to-sync-joplin-notes-with-mailbox-org-via-webdav#comment-10946)
+- [Nginx WebDAV Module](https://nginx.org/en/docs/http/ngx_http_dav_module.html), requires [http_dav_ext_module](https://github.com/arut/nginx-dav-ext-module)
+- [Nextcloud](https://nextcloud.com/)
+- [OwnCloud](https://owncloud.org/)
+- [Seafile](https://www.seafile.com/)
+- [Stack](https://www.transip.nl/stack/)
+- [Synology WebDAV Server](https://www.synology.com/en-us/dsm/packages/WebDAVServer)
+- [WebDAV Nav](https://www.schimera.com/products/webdav-nav-server/), a macOS server.
+- [Zimbra](https://www.zimbra.com/)
+- [Infomaniak kDrive](https://www.infomaniak.com/fr/ksuite/kdrive)