starred/vaultwarden
1
0
Fork 0
mirror of https://github.com/dani-garcia/vaultwarden.git synced 2025-12-22 09:15:25 +03:00
Code Issues 429 Packages Projects Releases 10 Wiki Activity

Finished the document

Mathijs van Veluw
2025-04-09 13:22:04 +02:00
parent 123de18a8c
commit de68b6b966
1 changed files with 48 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
Bitwarden-Android-troubleshooting.md

@@ -46,8 +46,56 @@ adb logcat --pid=$(adb shell pidof -s com.x8bit.bitwarden)
> [!NOTE]
> You can exit the logcat by pressing ctrl+c (or cmd+c)
> [!TIP]
> If you want to log everything to a file you can append the command with the following on at least Linux
> ```bash
> # Directly to a file:
> > bitwarden-android.log
> # Or, to a file and on screen at the same time:
> > | tee -a bitwarden-android.log
> # Full examples:
> adb logcat --pid=$(adb shell pidof -s com.x8bit.bitwarden) > bitwarden-android.log
> adb logcat --pid=$(adb shell pidof -s com.x8bit.bitwarden) | tee -a bitwarden-android.log
> ```
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.
### Getting more details
If there is no useful output, there is a way to get more details by using the Bitwarden Dev/Debug Android client.<br>
These versions are build via GitHub Actions and can be found here: https://github.com/bitwarden/android/actions/workflows/build.yml?query=is%3Asuccess
Basically, any successful build should contain an artifact file called `com.x8bit.bitwarden.dev.apk`.<br>
Download this file, which will be a zip file, extract that zip file, and install the extracted apk file.<br>
This can be done via the Android device it self if you have a File Manager which supports zip files.<br>
Or, use `adb` to install this like this:
```bash
adb install com.x8bit.bitwarden.dev.apk
```
Once this is done, you should have an extra Bitwarden client installed which should output more detailed logs.<br>
Follow the same steps as you normally do to login to your self-hosted instance.<br>
And to extract logs from this client, you need to adjust the `logcat` command a bit to look like this:
```bash
adb logcat --pid=$(adb shell pidof -s com.x8bit.bitwarden.dev)
```
This should provide much more details, and will be really helpful tracking down the issue.
> [!CAUTION]
> The output of of the dev client contains the response from the Vaultwarden server, which might contain sensitive data!<br>
> While most items are encrypted, some items like email address or your Vaultwarden domain are not!<br>
> **Be careful on how you share this output!**<br>
> While the full output is very useful to us developers, and helps troubleshooting, and we can't decrypt the data, still be careful!<br>
## Sharing the results
We suggest to share these files in a secure way either:
1. (_**Preferred**_) Via our Matrix chat: [![Matrix Chat](https://img.shields.io/matrix/vaultwarden:matrix.org.svg?style=flat-square&logo=matrix&logoColor=fff&color=953B00&cacheSeconds=14400)](https://matrix.to/#/#vaultwarden:matrix.org)
2. Via email, by sending an ![security-contact](https://github.com/dani-garcia/vaultwarden/raw/refs/heads/main/.github/security-contact.gif) to provide the details.
3. Via your self-hosted Vaultwarden using **Send** and a password (Shared via Matrix or email).<br>
If you have any questions regarding this topic, please start a new topic on our [![GitHub Discussions](https://img.shields.io/github/discussions/dani-garcia/vaultwarden?style=flat-square&logo=github&logoColor=fff&color=953B00&cacheSeconds=300)](https://github.com/dani-garcia/vaultwarden/discussions).