sysutils/OneDriveGUI
1
0
Fork 0
mirror of https://github.com/bpozdena/OneDriveGUI.git synced 2026-10-24 04:59:17 +03:00
Code Activity

update readme file

Browse Source
This commit is contained in:
Boris Pozdena
2023-10-12 19:55:16 +02:00
parent b74c8d620c
commit bb34eedcf0
1 changed files with 1 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
README.md
View File

@@ -1,92 +1 @@
# OneDriveGUI
![GitHub all releases](https://img.shields.io/github/downloads/bpozdena/OneDriveGUI/total)
A simple GUI for [Linux OneDrive Client](https://github.com/abraunegg/onedrive), with multi-account support.
![GUI_git](https://user-images.githubusercontent.com/24818591/187522951-bcfb05c6-8f8c-46ff-a213-80dce8f0d87a.png)
## Feature highlights
- Management and configuration of multiple OneDrive accounts
- Asynchronous real-time monitoring of multiple OneDrive accounts
- Setup wizard for easy OneDrive profile creation and import
- Auto-sync on GUI startup
- Support for GUI based login process
- System tray (if supported by your desktop environment)
- Start minimized to tray/dock
- Input validation to prevent configuration of incompatible OneDrive client options
- Import and management of Business Shared Folders
- Import and management of SharePoint Shared Libraries
- ToolTips with brief explanation of various OneDrive Client configuration options.
- Prompt for re-sync authorization to prevent unexpected data loss.
## Known Limitations
- No window shadows for Wayland sessions
- AppImage still requires the use of external browser for authentication
- Check for other reported [issues/limitations](https://github.com/bpozdena/OneDriveGUI/issues).
## Compatibility
- Minimum supported OneDrive client v2.4.15
- You will be shown warnings when your OneDrive Client is not up to date.
## Other notes
- Questions, suggestions, contributions and bug reports are welcome.
- Backup your OneDrive config files before importing them to the GUI.
- Backup your data before use to prevent accidental file deletion due to OneDrive misconfiguration.
- No warranty.
# Running and Installing OneDriveGUI
| :exclamation: |Ensure the latest version of [OneDrive for Linux](https://abraunegg.github.io/) is installed based on [instructions](https://github.com/abraunegg/onedrive/blob/master/docs/INSTALL.md) for your distro. |
|---------------|:--------------------------------------------------------------------------------------------|
## AppImage
1) Download the latest `OneDriveGUI-*-x86_64.AppImage` from the [release assets](https://github.com/bpozdena/OneDriveGUI/releases)
1) Make the .AppImage file executable with `chmod +x ./OneDriveGUI-<**version**>-x86_64.AppImage` and run it.
| :memo: | Users of Ubuntu 22.04+ may also need to install FUSE2 with `sudo apt install libfuse2` |
|---------------|:--------------------------------------------------------------------------------------------|
## AUR
- An AUR package [onedrivegui-git](https://aur.archlinux.org/packages/onedrivegui-git) is available. (maintainer: ZhangHua)
## Running from source
1) Ensure Python3 and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your system.
1) Clone or download content of this repository and cd into the resultant folder.
```
git clone https://github.com/bpozdena/OneDriveGUI.git
cd OneDriveGUI
```
1) Install dependencies:
```sh
python3 -m pip3 install -r requirements.txt
```
1) Start OneDrive GUI:
```sh
cd src/
python3 OneDriveGUI.py
```
Optionally, you can detach the GUI from terminal by using the bellow command:
```sh
cd src/
nohup python3 OneDriveGUI.py > /dev/null 2>&1&
```
# Use
- Once the GUI starts, you will be able to create a new OneDrive profile or import your pre-existing one. Just follow the wizard steps.
- You can adjust your OneDrive profile options as needed.
- Start OneDrive sync in monitor mode via the GUI by pressing the `Play` button.
# Additional Notes
- When importing OneDrive config file, all comments will be removed. Missing options will be replaced with [default values](src/resources/default_config).
- If multi-line options 'skip_file' and 'skip_dir' are used, they will be consolidated into a single line.
- List of managed OneDrive profiles is stored in `~/.config/onedrive-gui/profiles`. You can manually rename your profile or path to config file there.
- Newly created OneDrive config files are stored in `~/.config/onedrive/accounts/<profile_name>`
- Debug logs are saved in `/tmp/onedrive-gui/onedrive-gui.log`. Logging can be changed in the GUI settings.
:exclamation: :exclamation: :exclamation: This branch aims to provide compatibility with the upcoming OneDrive v2.5.0-alpha. Still very broken... :exclamation: :exclamation: :exclamation: