1
0
mirror of https://github.com/bpozdena/OneDriveGUI.git synced 2026-10-24 04:59:17 +03:00
Files
OneDriveGUI/README.md
Boris Pozdena 8a781a7e18 Fix packaging follow-ups from PR #301
- Fix autostart Exec fallback: the package now uses relative imports, so
  a desktop entry pointing at the script path fails at login. Use
  "-m onedrive_gui" with PYTHONPATH instead, and recognise the pip
  console script "onedrive-gui" when it is on PATH.
- AppImageBuilder.yml: revert accidental python3.10 -> python3.12 change,
  drop the now-redundant "cp src AppDir/usr" (the wheel install covers
  it), quote the *.whl glob.
- pyproject.toml: read version dynamically from options.py so it is not
  duplicated in a third place; declare runtime dependencies; remove the
  pyproject sed step from build_appimage.sh.
- MANIFEST.in: ship the resources/ directory only; stop packaging .ui
  sources and remove the stray mainwindow.ui.autosave.
- Ignore build/, dist/ and *.egg-info; update README wheel filename.
2026-09-15 14:26:13 +02:00

4.5 KiB

GitHub all releases

OneDriveGUI

About

A GUI for Linux OneDrive Client with multi-account support. image

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.
  • Progress monitoring of multiple simultaneous file transfers.
  • Import and management of SharePoint Shared Libraries.
  • Tooltips with brief explanations of various OneDrive Client configuration options.
  • Prompt for re-sync authorization to prevent unexpected data loss.

Known Limitations

  • No window shadows for Wayland sessions.
  • No window icon when using AppImage on Wayland sessions.
  • AppImage still requires the use of an external browser for authentication.
  • Check for other reported issues/limitations.

Compatibility

  • Minimum supported OneDrive client version: v2.5.11.
  • You will be shown warnings if 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

❗ Ensure the latest version of OneDrive for Linux is installed based on instructions for your distro.

AppImage

  1. Download the latest OneDriveGUI-*-x86_64.AppImage from the release assets.
  2. Make the .AppImage file executable with chmod +x ./OneDriveGUI-<**version**>-x86_64.AppImage and run it.
📝 Users of Ubuntu 22.04+ may also need to install FUSE2 with sudo apt install libfuse2.

AUR

Python Package

Use setuptools and build to build the package:

python3 -m pip install setuptools build
python3 -m build

That produces a wheel package in the directory dist/ that can be installed (this also provides an onedrive-gui command):

python3 -m pip install dist/onedrive_gui-*.whl

Running from Source

  1. Ensure Python3 and pip are installed on your system.

  2. Clone or download the content of this repository and cd into the resultant folder:

    git clone https://github.com/bpozdena/OneDriveGUI.git
    cd OneDriveGUI
    
  3. Install dependencies:

    python3 -m pip install -r requirements.txt
    
  4. Start OneDrive GUI:

    cd src/
    python3 -m onedrive_gui
    

    Optionally, you can detach the GUI from the terminal by using the command below:

    cd src/
    nohup python3 -m onedrive_gui > /dev/null 2>&1 &
    

Usage

  • 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 a OneDrive config file, all comments will be removed.
  • If multi-line options skip_file and skip_dir are used, they will be consolidated into a single line.
  • The list of managed OneDrive profiles is stored in ~/.config/onedrive-gui/profiles. You can manually rename your profile or path to the config file there.
  • Newly created OneDrive config files are stored in ~/.config/onedrive/accounts/<profile_name>.
  • Debug logs are saved in ``. Logging can be changed in the GUI settings.

Attribution