deblan-mirror/abraunegg-onedrive
deblan-mirror/abraunegg-onedrive
1
0
Fork 0
mirror of https://github.com/abraunegg/onedrive synced 2026-03-14 14:35:46 +01:00
Code Issues Projects Releases Wiki Activity

Update readme.md

Browse source 
* Update readme
This commit is contained in:
abraunegg 2025-08-31 09:09:54 +10:00
commit f38a1d64a2
1 changed files with 66 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

83
readme.md
View file

@ -35,8 +35,7 @@ Since forking in early 2018, this client has evolved into a clean re-imagining o
* Validates file transfers to ensure data integrity
* Caches sync state for efficiency
* Monitors local files in real-time using inotify
* Capability to sync remote updates immediately via webhooks
* Supports interrupted uploads for completion at a later time
* Supports near real-time processing of online changes via either WebSockets (native support) or webhooks (manual configuration required)
* Enhanced synchronisation speed with multi-threaded file transfers
* Manages traffic bandwidth use with rate limiting
* Supports sending desktop alerts using libnotify
@ -67,28 +66,74 @@ To check your version, run: `onedrive --version`. Ensure you are using the curre
If you are using an older version, you must upgrade to the current release or newer to receive support.
## Basic Troubleshooting Steps
If you are encountering any issue running the application please follow these steps first:
1. Check the version of the application using `onedrive --version` and ensure that you are running the latest [release](https://github.com/abraunegg/onedrive/releases). If you are already using the latest release and are still experiencing an issue, you must manually build the client from 'master' to ensure you are running the latest code, which will include fixes for bugs found since the last release that may be impacting you.
2. Run the client in verbose mode (`--verbose`) to give you greater clarity on any issue you are facing.
3. Configure the application to only use IPv4 network connectivity, and then retest.
4. Configure the application to only use HTTP/1.1. operations with IPv4 network connectivity, and then retest.
5. If the above points do not resolve your issue, upgrade your 'curl' and 'libcurl' versions to the latest available by the curl developers. Refer to https://curl.se/docs/releases.html for details.
If you encounter any issues running the application, please follow these steps **before** raising a bug report:
1. **Check the application version**
Run `onedrive --version` to confirm which version you are using.
- Ensure you are running the latest [release](https://github.com/abraunegg/onedrive/releases).
- If you are already on the latest release but still experiencing issues, manually build the client from the `master` branch to test against the very latest code. This includes fixes for bugs discovered since the last tagged release.
2. **Run in verbose mode**
Use the `--verbose` option to provide greater clarity and detailed logging about the issue you are facing.
3. **Test with IPv4 only**
Configure the application to use **IPv4 network connectivity only**, then retest. See the `'ip_protocol_version'` option [documentation](https://github.com/abraunegg/onedrive/blob/master/docs/application-config-options.md#ip_protocol_version) for assistance.
4. **Test with HTTP/1.1 and IPv4**
Configure the application to use **HTTP/1.1 over IPv4 only**, then retest. See the `'force_http_11'` option [documentation](https://github.com/abraunegg/onedrive/blob/master/docs/application-config-options.md#force_http_11) for assistance.
5. **Verify cURL and libcurl versions**
If the above steps do not resolve your issue, upgrade both `curl` and `libcurl` to the latest versions provided by the curl developers.
- See [Compatibility with curl](https://github.com/abraunegg/onedrive/blob/master/docs/usage.md#compatibility-with-curl) for details on curl bugs that impact this client.
- Refer to the official [cURL Releases](https://curl.se/docs/releases.html) page for version information.
6. **Open a new issue**
If the problem persists after completing the steps above, proceed to **Reporting an Issue or Bug** below and open a new issue with the requested details and logs.
## Reporting an Issue or Bug
> [!IMPORTANT]
> Please ensure that issues reported as bugs are indeed software bugs. For installation problems, distribution package/version issues, or package dependency concerns, please start a [Discussion](https://github.com/abraunegg/onedrive/discussions) instead of filing a bug report.
> Please ensure the problem is a software bug. For installation issues, distribution package/version questions, or dependency problems, start a [Discussion](https://github.com/abraunegg/onedrive/discussions) instead of filing a bug report.
If you encounter any bugs you can report them here on GitHub. Before filing an issue be sure to:
If you encounter a bug, you can report it on GitHub. Before opening a new issue report:
1. **Complete the Basic Troubleshooting Steps**
Confirm you’ve run through all steps in the section above.
2. **Search existing issues**
Check both [Open](https://github.com/abraunegg/onedrive/issues) and [Closed](https://github.com/abraunegg/onedrive/issues?q=is%3Aissue%20state%3Aclosed) issues for a similar problem to avoid duplicates.
3. **Use the issue template**
Open a new bug report using the [issue template](https://github.com/abraunegg/onedrive/issues/new?template=bug_report.md) and fill in **all fields**. Complete detail helps us reproduce your environment and replicate the issue.
4. **Generate a debug log**
Follow this [process](https://github.com/abraunegg/onedrive/wiki/Generate-debug-log-for-support) to create a verbose debug log.
- If you are concerned about sensitive data in the verbose debug log, you may:
- Create a new OneDrive account, configure the client to use it, use **dummy** data to simulate your environment, and reproduce the issue; or
- Provide an NDA or confidentiality agreement for signature prior to sharing sensitive logs.
5. **Share the debug log securely**
- **Do not post debug logs publicly.** Debug logs can include sensitive details (file paths, filenames, API endpoints, environment info, etc.).
- **Send the log via email** to **support@mynas.com.au** using a trusted email account.
- **Archive and password-protect** the log before sending (e.g. `.zip` with AES or `.7z`):
- Example (zip with password): `zip -e onedrive-debug.zip onedrive-debug.log`
- Example (7z with password): `7z a -p onedrive-debug.7z onedrive-debug.log`
- **Send the password out-of-band (OOB)** — not in the same email as the archive. Email **support@mynas.com.au** to arrange an OOB method (e.g. separate email thread, phone/SMS, or agreed channel).
- **If you require an NDA**, attach your NDA or confidentiality agreement to your email. It will be reviewed and signed prior to exchanging sensitive data.
### Include in your report (strongly recommended)
- `onedrive --version` output and **distribution/OS** details.
- `curl --version` (shows libcurl/OpenSSL/HTTP features).
- Relevant **configuration** details.
- Exact **commands** used and **steps to reproduce**.
- A concise **problem description** and what you expected to happen.
- Any relevant **network constraints** (IPv4-only, proxies, corporate firewalls, etc.).
1. Follow the Basic Troubleshooting Steps
2. Search [Open](https://github.com/abraunegg/onedrive/issues) and [Closed](https://github.com/abraunegg/onedrive/issues?q=is%3Aissue%20state%3Aclosed) Issues for a similar a similar problem. Has this already been resolved?
3. Fill in a new bug report using the [issue template](https://github.com/abraunegg/onedrive/issues/new?template=bug_report.md) after following the Basic Troubleshooting Steps. Fill in *all* the details as this helps re-create your environment to replicate your issue.
4. Generate a debug log for support using the following [process](https://github.com/abraunegg/onedrive/wiki/Generate-debug-log-for-support)
* If you are in *any* way concerned regarding the sensitivity of the data contained with in the verbose debug log file, create a new OneDrive account, configure the client to use that, use *dummy* data to simulate your environment and then replicate your original issue
* If you are still concerned, provide an NDA or confidentiality document to sign
5. Upload the debug log to [pastebin](https://pastebin.com/) or archive and email to support@mynas.com.au
* If you are concerned regarding the sensitivity of your debug data, encrypt + password protect the archive file and provide the decryption password via an out-of-band (OOB) mechanism. Email support@mynas.com.au for an OOB method for the password to be sent.
* If you are still concerned, provide an NDA or confidentiality document to sign
## Known issues
Refer to [docs/known-issues.md](https://github.com/abraunegg/onedrive/blob/master/docs/known-issues.md)