From 7857a5057f8a887ce92bfba190308964bfa87e54 Mon Sep 17 00:00:00 2001 From: abraunegg Date: Sat, 31 Jul 2021 10:26:11 +1000 Subject: [PATCH] Update INSTALL.md * Explicitly add details re process to upgrade client --- docs/INSTALL.md | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/docs/INSTALL.md b/docs/INSTALL.md index a4ee79db..57e97dab 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -1,6 +1,6 @@ -# Installing from Distribution Packages or Building the OneDrive Client for Linux from source +# Installing or Upgrading using Distribution Packages or Building the OneDrive Client for Linux from source -## Installing from Distribution Packages +## Installing or Upgrading using Distribution Packages This project has been packaged for the following Linux distributions as per below. The current client release is: [![Version](https://img.shields.io/github/v/release/abraunegg/onedrive)](https://github.com/abraunegg/onedrive/releases) Only the current release version or greater is supported. @@ -17,7 +17,7 @@ Distribution packages may be of an older release when compared to the latest rel | Gentoo | [onedrive](https://gpo.zugaina.org/net-misc/onedrive) | No API Available |supported|supported|not_supported|not_supported| | | NixOS | [onedrive](https://search.nixos.org/packages?channel=20.09&from=0&size=50&sort=relevance&query=onedrive)|nixpkgs unstable package|not_supported|supported|not_supported|not_supported| Use package `onedrive` either by adding it to `configuration.nix` or by using the command `nix-env -iA .onedrive`. This does not install a service. To install a service, use unstable channel (will stabilize in 20.09) and add `services.onedrive.enable=true` in `configuration.nix`. You can also add a custom package using the `services.onedrive.package` option (recommended since package lags upstream). Enabling the service installs a default package too (based on the channel). You can also add multiple onedrive accounts trivially, see [documentation](https://github.com/NixOS/nixpkgs/pull/77734#issuecomment-575874225). | | OpenSuSE | [onedrive](https://software.opensuse.org/package/onedrive) |openSUSE Tumbleweed package|supported|supported|not_supported|not_supported| | -| OpenSuSE Build Service | [onedrive](https://build.opensuse.org/project/show/home:npreining:debian-ubuntu-onedrive) | No API Available |supported|supported|supported|supported| Package Build Service for Debian and Ubuntu | +| OpenSuSE Build Service | [onedrive](https://build.opensuse.org/package/show/home:npreining:debian-ubuntu-onedrive/onedrive) | No API Available |supported|supported|supported|supported| Package Build Service for Debian and Ubuntu | | Raspbian | [onedrive](https://archive.raspbian.org/raspbian/pool/main/o/onedrive/) |Raspbian Stable package|not_supported|not_supported|supported|not_supported| | | Slackware | [onedrive](https://slackbuilds.org/repository/14.2/network/onedrive/) |SlackBuilds package|supported|supported|not_supported|not_supported| | | Solus | [onedrive](https://dev.getsol.us/search/query/FB7PIf1jG9Z9/#R) |Solus package|supported|supported|not_supported|not_supported| | @@ -323,15 +323,28 @@ make clean; make sudo make install ``` -## Uninstall +## Uninstalling the client +From within your GitHub repository clone, perform the following to remove the 'onedrive' binary: ```text sudo make uninstall -# delete the application state +``` + +If you are not upgrading your client, to remove your application state and configuration, perform the following additional step: +``` rm -rf ~/.config/onedrive ``` -If you are using the `--confdir option`, substitute `~/.config/onedrive` above for that directory. +**Note:** If you are using the `--confdir option`, substitute `~/.config/onedrive` above for that directory. If you want to just delete the application key, but keep the items database: ```text rm -f ~/.config/onedrive/refresh_token ``` + +## Upgrading the client +If you have installed the client from a distribution package, the client will be updated when the distribution package is updated by the package maintainer and will be updated to the new application version when you perform your package update. + +If you have built the client from source, to upgrade your client, you must first uninstall your existing 'onedrive' binary (see above), then re-install the client by re-cloning, re-compiling and re-installing the client again to install the new version. + +To confirm you have the new version installed, use `onedrive --version` to determine the version that is now installed. + +