From 1eda30d29dcea3c88b8add7b22231b9b793ddac8 Mon Sep 17 00:00:00 2001 From: abraunegg Date: Wed, 2 Nov 2022 06:58:23 +1100 Subject: [PATCH] Add note regarding what application version should be used (#2200) * Add note regarding what application version should be used --- docs/BusinessSharedFolders.md | 4 ++++ docs/SharePoint-Shared-Libraries.md | 4 ++++ docs/USAGE.md | 2 ++ docs/national-cloud-deployments.md | 4 ++++ 4 files changed, 14 insertions(+) diff --git a/docs/BusinessSharedFolders.md b/docs/BusinessSharedFolders.md index daa079de..3f042943 100644 --- a/docs/BusinessSharedFolders.md +++ b/docs/BusinessSharedFolders.md @@ -1,4 +1,8 @@ # How to configure OneDrive Business Shared Folder Sync +## Application Version +Before reading this document, please ensure you are running application version [![Version](https://img.shields.io/github/v/release/abraunegg/onedrive)](https://github.com/abraunegg/onedrive/releases) or greater. Use `onedrive --version` to determine what application version you are using and upgrade your client if required. + +## Process Overview Syncing OneDrive Business Shared Folders requires additional configuration for your 'onedrive' client: 1. List available shared folders to determine which folder you wish to sync & to validate that you have access to that folder 2. Create a new file called 'business_shared_folders' in your config directory which contains a list of the shared folders you wish to sync diff --git a/docs/SharePoint-Shared-Libraries.md b/docs/SharePoint-Shared-Libraries.md index c2674a89..c549c64a 100644 --- a/docs/SharePoint-Shared-Libraries.md +++ b/docs/SharePoint-Shared-Libraries.md @@ -1,4 +1,8 @@ # How to configure OneDrive SharePoint Shared Library sync +## Application Version +Before reading this document, please ensure you are running application version [![Version](https://img.shields.io/github/v/release/abraunegg/onedrive)](https://github.com/abraunegg/onedrive/releases) or greater. Use `onedrive --version` to determine what application version you are using and upgrade your client if required. + +## Process Overview Syncing a OneDrive SharePoint library requires additional configuration for your 'onedrive' client: 1. Login to OneDrive and under 'Shared Libraries' obtain the shared library name 2. Query that shared library name using the client to obtain the required configuration details diff --git a/docs/USAGE.md b/docs/USAGE.md index b0bf53f7..42a84c7c 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -66,6 +66,8 @@ ## Using the client +### Application Version +Before reading this document, please ensure you are running application version [![Version](https://img.shields.io/github/v/release/abraunegg/onedrive)](https://github.com/abraunegg/onedrive/releases) or greater. Use `onedrive --version` to determine what application version you are using and upgrade your client if required. ### Upgrading from 'skilion' client The 'skilion' version contains a significant number of defects in how the local sync state is managed. When upgrading from the 'skilion' version to this version, it is advisable to stop any service / onedrive process from running and then remove any `items.sqlite3` file from your configuration directory (`~/.config/onedrive/`) as this will force the creation of a new local cache file. diff --git a/docs/national-cloud-deployments.md b/docs/national-cloud-deployments.md index fc7fb2b6..6b348388 100644 --- a/docs/national-cloud-deployments.md +++ b/docs/national-cloud-deployments.md @@ -1,4 +1,8 @@ # How to configure access to specific Microsoft Azure deployments +## Application Version +Before reading this document, please ensure you are running application version [![Version](https://img.shields.io/github/v/release/abraunegg/onedrive)](https://github.com/abraunegg/onedrive/releases) or greater. Use `onedrive --version` to determine what application version you are using and upgrade your client if required. + +## Process Overview In some cases it is a requirement to utilise specific Microsoft Azure cloud deployments to conform with data and security reuqirements that requires data to reside within the geographic borders of that country. Current national clouds that are supported are: * Microsoft Cloud for US Government