ThatGuyJack/DuplicatiDocs
1
0
Fork 0
mirror of https://github.com/kees-z/DuplicatiDocs.git synced 2025-04-26 15:02:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of https://github.com/kees-z/DuplicatiDocs into feature/filter-groups

Browse Source
This commit is contained in:
Tyler Gill 2018-04-10 10:42:10 -06:00
commit a3ed9cfcb6
4 changed files with 108 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/01-introduction.md
View File

@ -26,12 +26,12 @@ If a procedure is different for an operating system other than Windows, a small
*****
*****
![](icon_linux_begin.png) This is an example of a Windows-specific procedure. ![](icon_linux_end.png)
![](icon_linux_begin.png) This is an example of a Linux-specific procedure. ![](icon_linux_end.png)
*****
*****
![](icon_apple_begin.png) This is an example of a Windows-specific procedure. ![](icon_apple_end.png)
![](icon_apple_begin.png) This is an example of a MacOS-specific procedure. ![](icon_apple_end.png)
*****
@ -72,7 +72,7 @@ Duplicati comes with a web interface. It can be used to configure and run backup
* **Command Line interface**
We did not forget about system admins! Duplicati offers all functions and feature via Duplicati.Commandline.exe. This allows you to add backup features to your scripts or run backups in a terminal window.
* **Meta data**
Duplicati also stored the meta data of files in the backup. When backup files are restored, the timestamps (last modified, created) will also be restored as well as the system's access permissions. To avoid inaccessible files e.g. when the system user's have changed, restoring of access permissions is optional.
Duplicati also stores the meta data of files in the backup. When backup files are restored, the timestamps (last modified, created) will also be restored as well as the system's access permissions. To avoid inaccessible files e.g. when the system user's have changed, restoring of access permissions is optional.
* **Scheduler**
The built-in scheduler runs your backups automatically at the times and intervals you define. One backup everyday, at the weekend, every hour or even 3pm every 3rd Monday is possible. And even if a date is missed, Duplicati will run the job as soon as possible.
* **Auto-updater**
@ -115,6 +115,7 @@ The following Cloud Storage Providers are supported natively by Duplicati:
* HubiC
* Jottacloud
* Mega.nz
* Microsoft Office 365 Groups
* Microsoft OneDrive
* Microsoft OneDrive for Business
* Microsoft SharePoint
@ -140,7 +141,7 @@ Because many devices run on an operating system based on Linux, Duplicati can be
Windows-based devices should have .NET Framework 3.5 or higher installed. For Linux and OSX, a recent version of Mono is a requirement.
Duplicati can make backups of files that are opened by other processes. For Windows, a snapshot of the file system is created using Volume Shadowcopy Services (VSS), LVM is used on Linux Systems. To be able to create a VSS snapshot, Duplicati needs C++ run-time components for Visual Studio 2015 to be installed.
Duplicati can make backups of files that are opened by other processes. For Windows, a snapshot of the file system is created using Volume Shadowcopy Services (VSS), LVM is used on Linux Systems. To be able to create a VSS snapshot, Duplicati needs C++ run-time components for Visual Studio 2015 to be installed and must be run with administrator privileges.
Duplicati is resource-friendly by design. There are no specific requirements for internal memory or processor performance.

108
docs/05-storage-providers.md
View File

@ -438,13 +438,13 @@ Supplies the backup device to use.
The backup device to use. Will be created if not already exists. You can manage your devices from the backup panel in the Jottacloud web interface. When you specify a custom device you should also specify the mount point to use on this device with the `jottacloud-mountpoint` option.
* `--jottacloud-mountpoint (String)`
Supplies the mount point to use on the server.
The mount point to use on the server. The default is `Archive` for using the built-in archive mount point. Set this option to` `Sync` to use the built-in synchronization mount point instead, or if you have specified a custom device with option `jottacloud-device` you are free to name the mount point as you like.
The mount point to use on the server. The default is `Archive` for using the built-in archive mount point. Set this option to `Sync` to use the built-in synchronization mount point instead, or if you have specified a custom device with option `jottacloud-device` you are free to name the mount point as you like.
## Mega.nz
This backend can read and write data to Mega.co.nz. Allowed format:
`mega://folder/subfolder
`mega://folder/subfolder`
Supported options:
@ -455,18 +455,108 @@ The password used to connect to the server. This may also be supplied as the env
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`.
## Microsoft OneDrive
## Microsoft Office 365 Group (Microsoft Graph API)
Duplicati can use Microsoft Onedrive to store backups. The following target URL format is used:
This backend can store backups in the document library associated with a Microsoft Office 365 Group, using the following URL format:
`msgroup://folder/subfolder`
Options:
* `--authid (Password)`
The authorization token retrieved from [https://duplicati-oauth-handler.appspot.com?type=msgroup](https://duplicati-oauth-handler.appspot.com?type=msgroup)
* `--group-email (String)`
Email address of the group to store data in, for example: `test@example.com`.
Either this parameter or `--group-id` is required.
When this parameter is specified, the group's ID is looked up automatically.
* `--group-id (String)`
ID of the group to store data in.
Either this parameter or `--group-email` is required.
This ID can be looked up by querying in the [Microsoft Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer).
* `--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 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:
`sharepoint://{tenant}.sharepoint.com/{Path/To/Web}//{BaseDocLibrary}/{folder/subfolder}`
A double slash, `//`, can optionally be used in the path to provide a hint to the location of the split between the site's base web address and the document library path.
Additionally, if the ID of the site is known (e.g., by discovering it in the [Microsoft Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer)), it can be explicitly specified via the `--site-id` parameter, and the URL can be given with just the relative path within the document library:
`sharepoint://folder/subfolder`
Options:
* `--authid (Password)`
The authorization token retrieved from [https://duplicati-oauth-handler.appspot.com?type=sharepoint](https://duplicati-oauth-handler.appspot.com?type=sharepoint)
* `--site-id (String)`
ID of the SharePoint site to store data in.
This parameter is required when using the relative document library path (without specifying the SharePoint site's web address).
This ID can be looked up by querying in the [Microsoft Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer).
When the SharePoint site's full web address is provided, it is looked up automatically.
* `--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. The following target URL format is used:
`onedrive://folder/subfolder`
Options:
* `--authid`
* `--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 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
@ -506,7 +596,11 @@ 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 (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

2
docs/06-advanced-options.md
View File

@ -47,7 +47,7 @@ Set this option if you prefer to have the commandline version automatically upda
`--auto-vacuum = false`
Some operations that manipulate the local database leave unused entries behind. These entries are not deleted from a hard drive until a VACUUM operation is run. This operation saves disk space in the long run but needs to temporarily create a copy of all valid entries in the database. Setting this to true will allow Duplicati to perform VACUUM operations at its discretion.
#backup-name
### backup-name
`--backup-name = Duplicati.CommandLine`
A display name that is attached to this backup. Can be used to identify the backup when sending mail or running scripts.

2
docs/index.md
View File

@ -5,7 +5,7 @@
![](duplicatilogo.png)
Revision 1.0
2018/03/21