Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Lyncredible committed Sep 10, 2021
1 parent 9887b8d commit b73b853
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 54 deletions.
104 changes: 51 additions & 53 deletions docs/USAGE.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,56 @@
# Configuration and Usage of the OneDrive Free Client
## Table of Contents
- [Configuration and Usage of the OneDrive Free Client](#configuration-and-usage-of-the-onedrive-free-client)
- [Table of Contents](#table-of-contents)
- [Using the client](#using-the-client)
- [Upgrading from 'skilion' client](#upgrading-from-skilion-client)
- [Local File and Folder Naming Conventions](#local-file-and-folder-naming-conventions)
- [curl compatibility](#curl-compatibility)
- [Authorize the application with your OneDrive Account](#authorize-the-application-with-your-onedrive-account)
- [Show your configuration](#show-your-configuration)
- [Testing your configuration](#testing-your-configuration)
- [Performing a sync](#performing-a-sync)
- [Performing a selective directory sync](#performing-a-selective-directory-sync)
- [Performing a 'one-way' download sync](#performing-a-one-way-download-sync)
- [Performing a 'one-way' upload sync](#performing-a-one-way-upload-sync)
- [Increasing logging level](#increasing-logging-level)
- [Client Activity Log](#client-activity-log)
- [Notifications](#notifications)
- [Handling a OneDrive account password change](#handling-a-onedrive-account-password-change)
- [Configuration](#configuration)
- [The default configuration file is listed below:](#the-default-configuration-file-is-listed-below)
- ['config' file configuration examples:](#config-file-configuration-examples)
- [sync_dir](#sync_dir)
- [sync_dir directory and file permissions](#sync_dir-directory-and-file-permissions)
- [skip_dir](#skip_dir)
- [skip_file](#skip_file)
- [skip_dotfiles](#skip_dotfiles)
- [skip_symlinks](#skip_symlinks)
- [monitor_interval](#monitor_interval)
- [min_notify_changes](#min_notify_changes)
- [Selective sync via 'sync_list' file](#selective-sync-via-sync_list-file)
- [Configuring the client for 'single tenant application' use](#configuring-the-client-for-single-tenant-application-use)
- [Configuring the client to use older 'skilion' application identifier](#configuring-the-client-to-use-older-skilion-application-identifier)
- [How to 'skip' directories from syncing?](#how-to-skip-directories-from-syncing)
- [How to 'rate limit' the application to control bandwidth consumed for upload & download operations](#how-to-rate-limit-the-application-to-control-bandwidth-consumed-for-upload--download-operations)
- [Shared folders (OneDrive Personal)](#shared-folders-onedrive-personal)
- [Shared folders (OneDrive Business or Office 365)](#shared-folders-onedrive-business-or-office-365)
- [SharePoint / Office 365 Shared Libraries](#sharepoint--office-365-shared-libraries)
- [Running 'onedrive' in 'monitor' mode](#running-onedrive-in-monitor-mode)
- [Use webhook to subscribe to remote updates in 'monitor' mode](#use-webhook-to-subscribe-to-remote-updates-in-monitor-mode)
- [More webhook configuration options](#more-webhook-configuration-options)
- [webhook_listening_host and webhook_listening_port](#webhook_listening_host-and-webhook_listening_port)
- [webhook_expiration_interval and webhook_renewal_interval](#webhook_expiration_interval-and-webhook_renewal_interval)
- [Running 'onedrive' as a system service](#running-onedrive-as-a-system-service)
- [OneDrive service running as root user via init.d](#onedrive-service-running-as-root-user-via-initd)
- [OneDrive service running as root user via systemd (Arch, Ubuntu, Debian, OpenSuSE, Fedora)](#onedrive-service-running-as-root-user-via-systemd-arch-ubuntu-debian-opensuse-fedora)
- [OneDrive service running as root user via systemd (Red Hat Enterprise Linux, CentOS Linux)](#onedrive-service-running-as-root-user-via-systemd-red-hat-enterprise-linux-centos-linux)
- [OneDrive service running as a non-root user via systemd (All Linux Distributions)](#onedrive-service-running-as-a-non-root-user-via-systemd-all-linux-distributions)
- [OneDrive service running as a non-root user via systemd (with notifications enabled) (Arch, Ubuntu, Debian, OpenSuSE, Fedora)](#onedrive-service-running-as-a-non-root-user-via-systemd-with-notifications-enabled-arch-ubuntu-debian-opensuse-fedora)
- [OneDrive service running as a non-root user via runit (antiX, Devuan, Artix, Void)](#onedrive-service-running-as-a-non-root-user-via-runit-antix-devuan-artix-void)
- [Additional Configuration](#additional-configuration)
- [Using multiple OneDrive accounts](#using-multiple-onedrive-accounts)
- [Access OneDrive service through a proxy](#access-onedrive-service-through-a-proxy)
- [Setup selinux for a sync folder outside of the home folder](#setup-selinux-for-a-sync-folder-outside-of-the-home-folder)
- [All available commands](#all-available-commands)
- [Using the client](#using-the-client)
* [Upgrading from 'skilion' client](#upgrading-from-skilion-client)
* [Local File and Folder Naming Conventions](#local-file-and-folder-naming-conventions)
* [curl compatibility](#curl-compatibility)
* [Authorize the application with your OneDrive Account](#authorize-the-application-with-your-onedrive-account)
* [Show your configuration](#show-your-configuration)
* [Testing your configuration](#testing-your-configuration)
* [Performing a sync](#performing-a-sync)
* [Performing a selective directory sync](#performing-a-selective-directory-sync)
* [Performing a 'one-way' download sync](#performing-a-one-way-download-sync)
* [Performing a 'one-way' upload sync](#performing-a-one-way-upload-sync)
* [Increasing logging level](#increasing-logging-level)
* [Client Activity Log](#client-activity-log)
* [Notifications](#notifications)
* [Handling a OneDrive account password change](#handling-a-onedrive-account-password-change)
- [Configuration](#configuration)
* [The default configuration file is listed below:](#the-default-configuration-file-is-listed-below)
* ['config' file configuration examples:](#config-file-configuration-examples)
+ [sync_dir](#sync_dir)
+ [sync_dir directory and file permissions](#sync_dir-directory-and-file-permissions)
+ [skip_dir](#skip_dir)
+ [skip_file](#skip_file)
+ [skip_dotfiles](#skip_dotfiles)
+ [skip_symlinks](#skip_symlinks)
+ [monitor_interval](#monitor_interval)
+ [min_notify_changes](#min_notify_changes)
+ [Selective sync via 'sync_list' file](#selective-sync-via-sync_list-file)
* [Configuring the client for 'single tenant application' use](#configuring-the-client-for-single-tenant-application-use)
* [Configuring the client to use older 'skilion' application identifier](#configuring-the-client-to-use-older-skilion-application-identifier)
* [How to 'skip' directories from syncing?](#how-to-skip-directories-from-syncing)
* [How to 'rate limit' the application to control bandwidth consumed for upload & download operations](#how-to-rate-limit-the-application-to-control-bandwidth-consumed-for-upload--download-operations)
* [Shared folders (OneDrive Personal)](#shared-folders-onedrive-personal)
* [Shared folders (OneDrive Business or Office 365)](#shared-folders-onedrive-business-or-office-365)
* [SharePoint / Office 365 Shared Libraries](#sharepoint--office-365-shared-libraries)
- [Running 'onedrive' in 'monitor' mode](#running-onedrive-in-monitor-mode)
* [Use webhook to subscribe to remote updates in 'monitor' mode](#use-webhook-to-subscribe-to-remote-updates-in-monitor-mode)
* [More webhook configuration options](#more-webhook-configuration-options)
+ [webhook_listening_host and webhook_listening_port](#webhook_listening_host-and-webhook_listening_port)
+ [webhook_expiration_interval and webhook_renewal_interval](#webhook_expiration_interval-and-webhook_renewal_interval)
- [Running 'onedrive' as a system service](#running-onedrive-as-a-system-service)
* [OneDrive service running as root user via init.d](#onedrive-service-running-as-root-user-via-initd)
* [OneDrive service running as root user via systemd (Arch, Ubuntu, Debian, OpenSuSE, Fedora)](#onedrive-service-running-as-root-user-via-systemd-arch-ubuntu-debian-opensuse-fedora)
* [OneDrive service running as root user via systemd (Red Hat Enterprise Linux, CentOS Linux)](#onedrive-service-running-as-root-user-via-systemd-red-hat-enterprise-linux-centos-linux)
* [OneDrive service running as a non-root user via systemd (All Linux Distributions)](#onedrive-service-running-as-a-non-root-user-via-systemd-all-linux-distributions)
* [OneDrive service running as a non-root user via systemd (with notifications enabled) (Arch, Ubuntu, Debian, OpenSuSE, Fedora)](#onedrive-service-running-as-a-non-root-user-via-systemd-with-notifications-enabled-arch-ubuntu-debian-opensuse-fedora)
* [OneDrive service running as a non-root user via runit (antiX, Devuan, Artix, Void)](#onedrive-service-running-as-a-non-root-user-via-runit-antix-devuan-artix-void)
- [Additional Configuration](#additional-configuration)
* [Using multiple OneDrive accounts](#using-multiple-onedrive-accounts)
* [Access OneDrive service through a proxy](#access-onedrive-service-through-a-proxy)
* [Setup selinux for a sync folder outside of the home folder](#setup-selinux-for-a-sync-folder-outside-of-the-home-folder)
- [All available commands](#all-available-commands)


## Using the client
Expand Down
8 changes: 7 additions & 1 deletion src/arsd/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
cgi.d is a copy from [adamdruppe/arsd](https://github.com/adamdruppe/arsd) to provide a simple web server implementation. The last copy was done @ a870179988b8881b04126856105f0fad2cc0018d.
The files in this directory have been obtained form the following places:

cgi.d
https://github.com/adamdruppe/arsd/blob/a870179988b8881b04126856105f0fad2cc0018d/cgi.d
License: Boost Software License - Version 1.0
Copyright 2008-2021, Adam D. Ruppe
see https://github.com/adamdruppe/arsd/blob/a870179988b8881b04126856105f0fad2cc0018d/LICENSE

0 comments on commit b73b853

Please sign in to comment.