Cleanup the rest

docs/05-storage-providers.md

@@ -1,3 +1,4 @@
+
 A storage provider is a destination or a target for your backup data. This could be a local files or folder, a networked storage device, or a cloud storage provider. Duplicati supports many storage providers, both standard protocols and a wide range of proprietary cloud storage solutions. You can configure how each storage provider is used with its own set of options.
 
 When configuring a backup, the storage URL parameter determines which storage provider will be used.  Each storage provider has a different URL format which can be used along with the documented options below.
@@ -6,7 +7,7 @@ When configuring a backup, the storage URL parameter determines which storage pr
 
 This backend can be used to read and write data to the local file system.
 
-URL Formats:
+URL Format:
 
 `file://hostname/folder%20for%20backup`
 `file://\\server\folder%20for%20backup (UNC path)`
@@ -33,7 +34,7 @@ If this option is set, any existing authentication against the remote share is d
 
 This provider uses FTP servers to store backups.
 
-URL Formats:
+URL Format:
 
 `ftp://hostname/folder`
 
@@ -56,7 +57,7 @@ To protect against network failures, every upload will be attempted verified. Us
 
 This backend can read and write data to an FTP based backend using an alternative FTP client.
 
-URL Formats:
+URL Format:
 
 `aftp://hostname/folder`
 `aftp://username:password@hostname/folder`
@@ -90,11 +91,13 @@ Default value: `Default`
 
 ## OpenStack Object Storage / Swift
 
-This backend can read and write data to Swift (OpenStack Object Storage). Supported format is
+This backend can read and write data to Swift (OpenStack Object Storage).
+
+URL Format:
 
 `openstack://container/folder`
 
-Supported options:
+Options:
 
 * `--auth-username (String)`
 Supplies the username used to connect to the server.
@@ -122,7 +125,9 @@ Consult your provider for a list of valid regions, or leave empty for the defaul
 
 ## S3 Compatible
 
-Duplicati can use S3-compatible servers to store backups. The following target URL format is used:
+Duplicati can use S3-compatible servers to store backups.
+
+URL Format:
 
 `s3://bucketname/prefix`
 
@@ -228,7 +233,9 @@ Extended option UseNagleAlgorithm
 
 ## SFTP (SSH)
 
-Duplicati can use SSH servers to store backups. The following target URL formats can be used:
+Duplicati can use SSH servers to store backups.
+
+URL Format:
 
 `ssh://hostname/folder`
 
@@ -254,11 +261,13 @@ This option can be used to enable the keep-alive interval for the SSH connection
 
 ## WebDAV
 
-Duplicati can use WebDAV servers to store backups. The following target URL formats can be used:
+Duplicati can use WebDAV servers to store backups.
+
+URL Format:
 
 `webdav://hostname/folder`
 
-Supported options:
+Options:
 
 * `--auth-password`
 The password used to connect to the server. This may also be supplied as the environment variable "AUTH_PASSWORD".
@@ -278,11 +287,13 @@ To aid in debugging issues, it is possible to set a path to a file that will be
 
 ## Amazon Cloud Drive
 
-This backend can read and write data to Amazon Cloud Drive. Supported format is
+This backend can read and write data to Amazon Cloud Drive.
+
+URL Format:
 
 `amzcd://folder/subfolder`
 
-Supported options:
+Options:
 
 * `--authid (Password)`
 The authorization code.
@@ -298,34 +309,38 @@ Default value: `15s`
 
 ## Azure blob
 
-This backend can read and write data to Azure blob storage. Allowed format:
+This backend can read and write data to Azure blob storage.  To configure this backend you must create a storage account in the [Azure Portal](https://portal.azure.com) and get an access key by going to `Settings > Access keys` on the storage account details page.  The configuration options can either be provided as part of the URL or as separate parameters.  If both are provided, the URL parameters will take precedence.
 
-`azure://bucketname`
+URL Format:
 
-Supported options:
+`azure://containerName`
+`azure://storageAccountName@containerName`
+`azure://storageAccountName:accessKey@containerName`
+
+Options:
 
 * `--azure_account_name (String)`
 The storage account name.
-The Azure storage account name which can be obtained by clicking the "Manage Access Keys" button on the storage account dashboard.
+The name of the Azure storage account to connect to.  This parameter will be ignored if the name is specified in the URL.
 * `--azure_access_key (Password)`
-The access key.  
+The storage account access key.
-The Azure access key which can be obtained by clicking the "Manage Access Keys" button on the storage account dashboard.
+The access key used to authenticate calls to the Azure storage account.  This parameter will be ignored in the access key is specified in the URL.
-* `--azure_blob_container_name (String)`  
-The name of the storage container.  
-All files will be written to the container specified.
-* `--auth-password (Password)`  
-Supplies the password used to connect to the server.  
-The password used to connect to the server. This may also be supplied as the environment variable `AUTH_PASSWORD`.
 * `--auth-username (String)`
-Supplies the username used to connect to the server.  
+The storage account name.
-The username used to connect to the server. This may also be supplied as the environment variable `AUTH_USERNAME`.
+An alternative parameter for specifying the storage account name. This parameter will be ignored if the name is specified in the URL or the `--azure_account_name` parameter is provided. This may also be supplied as the environment variable `AUTH_USERNAME`.
+* `--auth-password (Password)`
+The storage account access key.
+An alternative parametyr for specifying the storage account access key. This parameter will be ignored if the access key is specified in the URL or the `--azure_access_key` parameter is provided. This may also be supplied as the environment variable `AUTH_PASSWORD`.
 
 ## B2 Cloud Storage
 
-This backend can read and write data to the Backblaze B2 Cloud Storage. Allowed format:
+This backend can read and write data to the Backblaze B2 Cloud Storage.
+
+URL Format:
 
 `b2://bucketname/prefix`
-Supported options:
+
+Options:
 
 * `--b2-accountid (String)`
 The "B2 Cloud Storage Account ID".
@@ -352,11 +367,13 @@ Default value: `500`
 
 ## Box.com
 
-This backend can read and write data to Box.com. Supported format is
+This backend can read and write data to Box.com.
+
+URL Format:
 
 `box://folder/subfolder`
 
-Supported options:
+Options:
 
 * `--authid (Password)`
 The authorization code.
@@ -367,11 +384,13 @@ After deleting a file, it may end up in the trash folder where it will be delete
 
 ## Dropbox
 
-This backend can read and write data to Dropbox. Supported format is
+This backend can read and write data to Dropbox.
+
+URL Format:
 
 `dropbox://folder/subfolder`
 
-Supported options:
+Options:
 
 * `--authid (Password)`
 The authorization code.
@@ -379,11 +398,13 @@ The authorization token retrieved from [https://duplicati-oauth-handler.appspot.
 
 ## Google Cloud Storage
 
-This backend can read and write data to Google Cloud Storage. Supported format is
+This backend can read and write data to Google Cloud Storage.
+
+URL Format:
 
 `googlecloudstore://bucket/folder`
 
-Supported options:
+Options:
 
 * `--gcs-location (String)`
 Specifies location option for creating a bucket.
@@ -424,11 +445,13 @@ This option is only used when creating new buckets. Use this option to supply th
 
 ## Google Drive
 
-This backend can read and write data to Google Drive. Supported format is
+This backend can read and write data to Google Drive.
+
+URL Format:
 
 `googledrive://folder/subfolder`
 
-Supported options:
+Options:
 
 * `--authid (Password)`
 The authorization code.
@@ -436,11 +459,13 @@ The authorization token retrieved from [https://duplicati-oauth-handler.appspot.
 
 ## HubiC
 
-This backend can read and write data to HubiC. Supported format is
+This backend can read and write data to HubiC.
+
+URL Format:
 
 `hubic://container/folder`
 
-Supported options:
+Options:
 
 * `--authid (Password)`
 The authorization code.
@@ -448,11 +473,13 @@ The authorization token retrieved from [https://duplicati-oauth-handler.appspot.
 
 ## Jottacloud
 
-This backend can read and write data to Jottacloud using it's REST protocol. Allowed format is
+This backend can read and write data to Jottacloud using it's REST protocol.
+
+URL Format:
 
 `jottacloud://folder/subfolder`
 
-Supported options:
+Options:
 
 * `--auth-password (Password)`
 Supplies the password used to connect to the server.
@@ -469,11 +496,13 @@ The mount point to use on the server. The default is `Archive` for using the bui
 
 ## Mega.nz
 
-This backend can read and write data to Mega.co.nz. Allowed format:
+This backend can read and write data to Mega.co.nz.
+
+URL Format:
 
 `mega://folder/subfolder`
 
-Supported options:
+Options:
 
 * `--auth-password (Password)`
 Supplies the password used to connect to the server.
@@ -489,7 +518,9 @@ The username used to connect to the server. This may also be supplied as the env
 You can use this backend without this permission by using an AuthID generated for the `SharePoint v2` backend and passing the `--group-id` instead of `--group-email`. You can lookup the group ID by using the [Microsoft Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer).
 *****
 
-This backend can store backups in the document library associated with a Microsoft Office 365 Group, using the following URL format:
+This backend can store backups in the document library associated with a Microsoft Office 365 Group.
+
+URL Format:
 
 `msgroup://folder/subfolder`
 
@@ -516,30 +547,11 @@ Default value: `5`
 Amount of time (in milliseconds) to wait between failures when uploading fragments.
 Default value: `1000`
 
-## Microsoft OneDrive v2 (Microsoft Graph API)
-
-This backend can store backups in both OneDrive and OneDrive for Business via the Microsoft Graph API, using the following URL format:
-
-`onedrivev2://folder/subfolder`
-
-Options:
-
-* `--authid (Password)`  
-The authorization token retrieved from [https://duplicati-oauth-handler.appspot.com?type=onedrivev2](https://duplicati-oauth-handler.appspot.com?type=onedrivev2)
-* `--fragment-size (Integer)`  
-Size of individual fragments which are uploaded separately for large files.  
-It is recommended to be between `5-10 MiB` (though a smaller value may work better on a slower or less reliable connection), and to be a multiple of `320 KiB`.  
-Default value: `10 MiB`
-* `--fragment-retry-count (Integer)`  
-Number of retry attempts made for each fragment before failing the overall file upload.  
-Default value: `5`
-* `--fragment-retry-delay (Integer)`  
-Amount of time (in milliseconds) to wait between failures when uploading fragments.  
-Default value: `1000`
-
 ## Microsoft SharePoint v2 (Microsoft Graph API)
 
-This backend can store backups in SharePoint sites via the Microsoft Graph API, using the following URL format:
+This backend can store backups in SharePoint sites via the Microsoft Graph API.
+
+URL Format:
 
 `sharepoint://{tenant}.sharepoint.com/{Path/To/Web}//{BaseDocLibrary}/{folder/subfolder}`
 
@@ -569,82 +581,22 @@ Default value: `5`
 Amount of time (in milliseconds) to wait between failures when uploading fragments.
 Default value: `1000`
 
-## Microsoft OneDrive (LiveConnect API)
-
-*****
-> ![](icon_important.png) The LiveConnect API this backend is based on is deprecated and [will be disabled on November 1st, 2018](https://docs.microsoft.com/en-us/onedrive/developer/rest-api/concepts/migrating-from-live-sdk). New backups to OneDrive should be created using the OneDrive v2 backend based on the Microsoft Graph API, and existing backups should be migrated.
-*****
-
-Duplicati can use Microsoft OneDrive to store backups. The following target URL format is used:
-
-`onedrive://folder/subfolder`
-
-Options:
-
-* `--authid (Password)`  
-The authorization token retrieved from [https://duplicati-oauth-handler.appspot.com?type=onedrive](https://duplicati-oauth-handler.appspot.com?type=onedrive)
-
-## Microsoft OneDrive for Business (Microsoft.SharePoint.Client API)
-
-*****
-> ![](icon_info.png) This backend is based on the Microsoft.SharePoint.Client library, and doesn't support features like OAuth or two-factor authentication (2FA). The Microsoft OneDrive v2 backend supports these features, and is also compatible with OneDrive for Business.
-*****
-
-Supports connections to Microsoft OneDrive for Business. Allowed formats are
-
-`od4b://tennant.sharepoint.com/personal/username_domain/Documents/subfolder`
-
-or
-
-`od4b://username:password@tennant.sharepoint.com/personal/username_domain/Documents/folder`
-
-You can use a double slash '//' in the path to denote the base path from the documents folder.
-
-Supported options:
-
-* `--auth-password (Password)`  
-Supplies the password used to connect to the server.  
-The password used to connect to the server. This may also be supplied as the environment variable `AUTH_PASSWORD`.
-* `--auth-username (String)`  
-Supplies the username used to connect to the server.  
-The username used to connect to the server. This may also be supplied as the environment variable `AUTH_USERNAME`.
-* `--integrated-authentication (Boolean)`  
-Use windows integrated authentication to connect to the server.  
-If the server and client both supports integrated authentication, this option enables that authentication method.  
-This is likely only available with windows servers and clients.
-* `--delete-to-recycler (Boolean)`  
-Move deleted files to the recycle bin.  
-Use this option to have files moved to the recycle bin folder instead of removing them permanently when compacting or deleting backups.
-* `--binary-direct-mode (Boolean)`  
-Upload files using binary direct mode.  
-Use this option to upload files to SharePoint as a whole with BinaryDirect mode. This is the most efficient way of uploading, but can cause non-recoverable timeouts under certain conditions. Use this option only with very fast and stable internet connections.  
-Default value: `false`
-* `--web-timeout (Timespan)`  
-Set timeout for SharePoint web operations.  
-Use this option to specify a custom value for timeouts of web operation when communicating with SharePoint Server.  
-Recommended value is `180s`.
-* `--chunk-size (Size)`  
-Set block size for chunked uploads to SharePoint.  
-Use this option to specify the size of each chunk when uploading to SharePoint Server. Recommended value is 4MB.  
-Default value: `4mb`
-
 ## Microsoft SharePoint (Microsoft.SharePoint.Client API)
 
 *****
 > ![](icon_info.png) This backend is based on the Microsoft.SharePoint.Client library, and doesn't support features like OAuth or two-factor authentication (2FA). The Microsoft SharePoint v2 backend supports these features.
 *****
 
-Supports connections to a SharePoint server (including OneDrive for Business). Allowed formats are
+Supports connections to a SharePoint server (including OneDrive for Business).
+
+URL Format:
 
 `mssp://tennant.sharepoint.com/PathToWeb//BaseDocLibrary/subfolder`
-
-or
-
 `mssp://username:password@tennant.sharepoint.com/PathToWeb//BaseDocLibrary/subfolder`
 
 Use a double slash '//' in the path to denote the web from the documents library.
 
-Supported options:
+Options:
 
 * `--auth-password (Password)`
 Supplies the password used to connect to the server.
@@ -672,13 +624,98 @@ Set block size for chunked uploads to SharePoint.
 Use this option to specify the size of each chunk when uploading to SharePoint Server. Recommended value is `4MB`.
 Default value: `4mb`
 
+## Microsoft OneDrive v2 (Microsoft Graph API)
+
+This backend can store backups in both OneDrive and OneDrive for Business via the Microsoft Graph API.
+
+URL Format:
+
+`onedrivev2://folder/subfolder`
+
+Options:
+
+* `--authid (Password)`
+The authorization token retrieved from [https://duplicati-oauth-handler.appspot.com?type=onedrivev2](https://duplicati-oauth-handler.appspot.com?type=onedrivev2)
+* `--fragment-size (Integer)`
+Size of individual fragments which are uploaded separately for large files.
+It is recommended to be between `5-10 MiB` (though a smaller value may work better on a slower or less reliable connection), and to be a multiple of `320 KiB`.
+Default value: `10 MiB`
+* `--fragment-retry-count (Integer)`
+Number of retry attempts made for each fragment before failing the overall file upload.
+Default value: `5`
+* `--fragment-retry-delay (Integer)`
+Amount of time (in milliseconds) to wait between failures when uploading fragments.
+Default value: `1000`
+
+## Microsoft OneDrive (LiveConnect API)
+
+*****
+> ![](icon_important.png) The LiveConnect API this backend is based on is deprecated and [will be disabled on November 1st, 2018](https://docs.microsoft.com/en-us/onedrive/developer/rest-api/concepts/migrating-from-live-sdk). New backups to OneDrive should be created using the OneDrive v2 backend based on the Microsoft Graph API, and existing backups should be migrated.
+*****
+
+Duplicati can use Microsoft OneDrive to store backups.
+
+URL Format:
+
+`onedrive://folder/subfolder`
+
+Options:
+
+* `--authid (Password)`
+The authorization token retrieved from [https://duplicati-oauth-handler.appspot.com?type=onedrive](https://duplicati-oauth-handler.appspot.com?type=onedrive)
+
+## Microsoft OneDrive for Business (Microsoft.SharePoint.Client API)
+
+*****
+> ![](icon_info.png) This backend is based on the Microsoft.SharePoint.Client library, and doesn't support features like OAuth or two-factor authentication (2FA). The Microsoft OneDrive v2 backend supports these features, and is also compatible with OneDrive for Business.
+*****
+
+Supports connections to Microsoft OneDrive for Business.
+
+URL Format:
+
+`od4b://tennant.sharepoint.com/personal/username_domain/Documents/subfolder`
+`od4b://username:password@tennant.sharepoint.com/personal/username_domain/Documents/folder`
+
+You can use a double slash '//' in the path to denote the base path from the documents folder.
+
+Options:
+
+* `--auth-password (Password)`
+Supplies the password used to connect to the server.
+The password used to connect to the server. This may also be supplied as the environment variable `AUTH_PASSWORD`.
+* `--auth-username (String)`
+Supplies the username used to connect to the server.
+The username used to connect to the server. This may also be supplied as the environment variable `AUTH_USERNAME`.
+* `--integrated-authentication (Boolean)`
+Use windows integrated authentication to connect to the server.
+If the server and client both supports integrated authentication, this option enables that authentication method.
+This is likely only available with windows servers and clients.
+* `--delete-to-recycler (Boolean)`
+Move deleted files to the recycle bin.
+Use this option to have files moved to the recycle bin folder instead of removing them permanently when compacting or deleting backups.
+* `--binary-direct-mode (Boolean)`
+Upload files using binary direct mode.
+Use this option to upload files to SharePoint as a whole with BinaryDirect mode. This is the most efficient way of uploading, but can cause non-recoverable timeouts under certain conditions. Use this option only with very fast and stable internet connections.
+Default value: `false`
+* `--web-timeout (Timespan)`
+Set timeout for SharePoint web operations.
+Use this option to specify a custom value for timeouts of web operation when communicating with SharePoint Server.
+Recommended value is `180s`.
+* `--chunk-size (Size)`
+Set block size for chunked uploads to SharePoint.
+Use this option to specify the size of each chunk when uploading to SharePoint Server. Recommended value is 4MB.
+Default value: `4mb`
+
 ## Rackspace Cloudfiles
 
-Supports connections to the CloudFiles backend. Allowed formats is
+Supports connections to the CloudFiles backend.
+
+URL Format:
 
 `cloudfiles://container/folder`
 
-Supported options:
+Options:
 
 * `--auth-password (Password)`
 Supplies the password used to connect to the server.
@@ -703,11 +740,13 @@ Default value: `https://identity.api.rackspacecloud.com/auth`
 
 ## Rclone
 
-This backend can read and write data to Rclone. Allowed format:
+This backend can read and write data to Rclone.
+
+URL Format:
 
 `rclone://server/folder`
 
-Supported options:
+Options:
 
 * `--rclone-local-repository (String)`
 Local repository for Rclone. Make sure it is configured as a local drive, as it needs access to the files generated by Duplicati.
@@ -726,11 +765,13 @@ Default value: `rclone`
 
 ## Sia Decentralized Cloud
 
-This backend can read and write data to Sia. Allowed format:
+This backend can read and write data to Sia.
+
+URL Format:
 
 `sia://server/folder/BaseDocLibrary/subfolder`
 
-Supported options:
+Options:
 
 * `--sia-targetpath (String)`
 Backup path.
@@ -744,7 +785,9 @@ Default value: `1.5`
 
 ## Tahoe-LAFS
 
-Duplicati can use the TahoeLAFS to store backups. The following target URL format is used:
+Duplicati can use the TahoeLAFS to store backups.
+
+URL Format:
 
 `tahoe://hostname:port/uri/$DIRCAP`
 
@@ -752,6 +795,3 @@ Options:
 
 * `--use-ssl`
 Use this flag to communicate using Secure Socket Layer (SSL) over http (https).
-
-
-

mkdocs.yml

@@ -11,7 +11,7 @@ repo_name: 'kees-z/DuplicatiDocs'
 repo_url: 'https://github.com/kees-z/DuplicatiDocs/'
 
 # Copyright
-copyright: 'Copyright © 2016 - 2018 The Duplicati Team'
+copyright: 'Copyright © 2016 - 2020 The Duplicati Team'
 
 # Configuration
 theme: