Start on creating the android troubleshooting page.

Mathijs van Veluw
2025-04-09 12:11:38 +02:00
parent 1aabb614fd
commit 123de18a8c

@@ -0,0 +1,53 @@
# Bitwarden Android troubleshooting
## General
Ever since the new Bitwarden Mobile clients, some issues keep arising.
These issues are mainly because the new clients are more strict regarding the JSON returned by the server.
Because the old clients were less strict, and Vaultwarden did not (and still isn't fully) filtered or corrected the input from all the clients to keep as flexible as possible when Bitwarden adds new features, sometimes the stored data might contain invalid values.
We try to correct all these items during the sync to fix all old invalid values where possible, and trust that the clients send correct new data.
Since we can not know all invalid data ever generated by any client, it's sometimes hard for the developers to figure out what the specific issues is. For this, we need the help of the community to troubleshoot and find the culprit.
Bellow are some troubleshooting guides which should help finding the issues which might help you fix it your self, or help the developers to fix it on the server side.
## Things to try first
The first thing to do is ensure the client does not have a invalid cached JSON locally. This is loaded before the sync request is done, and might cause issues we can not solve server side.
1. Logout from the mobile client
2. Clear cache and data of the Bitwarden app
3. Uninstall the Bitwarden app
4. And to be fully sure it is all cleaned, reboot
5. Install the Bitwarden app again
6. Configure the app to connect to your self-hosted instance
7. Login and cross your fingers
If the steps above did not solved your issue, then there might be something wrong with the data returned by Vaultwarden.
In that case continue below.
## Install Android Debugging tools (adb)
Most (if not all) Android devices are able to extract logs from the device by connecting your device to a computer which has the right tools installed. You can find a detailed guide per platform on how to install this here https://www.xda-developers.com/install-adb-windows-macos-linux/ .
**Please read everything regarding your platform first before actually installing the tools, sometimes there are multiple ways described and the first one might not be the easiest one.**
After you have installed those tools, and are able to connect to your phone you can continue to the next steps.
## The actual debugging
Now that everything is setup we can start extracting logs which hopefully help tracking the issue.
Run the following command to show only the Bitwarden Client logs:
```bash
adb logcat --pid=$(adb shell pidof -s com.x8bit.bitwarden)
```
> [!NOTE]
> You can exit the logcat by pressing ctrl+c (or cmd+c)
This should start showing some logs, if so continue, if not, check the error message and try to resolve the issue.
Now with the logs outputting on the screen, try to trigger the error in the client and check the output.
This output is needed for the developers to try and figure out where the issue is.