waydroid / docs

Waydroid

Waydroid uses a container-based approach to boot a full Android system on a regular GNU/Linux system like Ubuntu.

Overview

Waydroid uses Linux namespaces (user, pid, uts, net, mount, ipc) to run a full Android system in a container and provide Android applications on any GNU/Linux-based platform.

The Android system inside the container has direct access to any needed hardware.

The Android runtime environment ships with a minimal customized Android system image based on LineageOS. The image is currently based on Android 11.

Documentation

Our documentation site can be found at docs.waydro.id

Reporting bugs

If you have found an issue with Waydroid, please file a bug.

Get in Touch

If you want to get in contact with the developers please feel free to join the Waydroid groups in Matrix or Telegram.

docs's Issues

"Source" should direct the user to the relevant page's source code.

For instance, https://docs.waydro.id/faq/google-play-certification should link to https://github.com/waydroid/docs/blob/9b5be41b9233aecf201471596fc6e84f7423ab85/faq/google-play-certification.md#google-play-protect-certification.

How to install on parabola distro?

due to #11

How to install on Gentoo?

due to #11

Help! Don't understand "apply-waydroid-patches"

In the "Compile waydroid - LineageOS based images" section, "apply-waydroid-patches" is just an instruction or a script? It seems to be an instruction, but I don’t understand what patches it contains and how it is applied.

Keeps returning to SDDM when attempting to launch "Waydroid on Weston" session after following tutorial

https://docs.waydro.id/faq/setting-up-waydroid-only-sessions#weston

First of all, the tutorials don't seem to mention that you have to make the script executable which might be good to add.

Even after doing that when attempting to launch a waydroid on weston session it shows the flowery background for a few seconds then returns to SDDM.
When launching the script from the tty it stays on the flowery background and doesn't launch waydroid.

I just installed weston without any other configuring than adding the mentioned ~/.config/weston.ini file

Using SDDM Wayland on KDE. I do have konsole/waydroid installed.

Tell the user that they need to extract the image files from the android rom zip files, in the "custom waydroid images" part of the docs.

The way it is written now makes it sound like you can just copy the zip images of your android rom to the /usr/share/waydroid-extra/images directory and your good. Which Waydroid clearly doesn't support.

How to install on non debian based distro?

Debian installation instructions are incomplete

Context: I'm attempting this on a minimal Debian Bookworm installation. To start with, this is a text-only install with only the basic system tools and ssh installed. There is no desktop, no X11, no Wayland, this is on purpose - to discover explicitly what is required to make this work as expected out of the box.

I'm opening this issue to attempt to document what's required to actually make waydroid launch under Debian and which dependencies are missing.

For example, it appears that waydroid is dependent on wayland, but that is not a dependency for the package. Similarly, there's a dependency for pyclip, which doesn't appear to exist as a Debian package and the only "working" solution is to break the system by using the --break-system-packages option for pip, which is also then a dependency, as-in python3-pip.

Note that I am completely unfamiliar with waydroid, but I've been using Debian for nearly 25 years.

I realise that one option is to make this a discussion rather than an issue, but at the end of all this I'm expecting to create (and hopefully close) a range of tickets and pull requests.

Progress to date:

• The standard Debian install does not come with curl, but wget is included in the standard utilities. I recommend that the installation script at https://repo.waydro.id is updated to use wget instead. I do not know where to lodge an issue for that, or where to submit a PR.
• While the installation of waydroid completes, the application does not launch, since it requires a display, but that's not a dependency.
• If I install lxde-core after installing waydroid, I can run waydroid show-full-ui once. It displays a download window and offers a selection of images. Once that's finished downloading, clicking "Done" does nothing.
• Starting it again, shows a missing pyclip as discussed here in an issue that in my opinion should be re-opened.
• Resolving that then reveals that wayland is missing. (I don't have the error handy, after a fresh install I'll see if I can reproduce this.)
• Installing weston (which Debian states is the Wayland reference compositor) offers a new window where you can attempt to launch waydroid show-full-ui.
• After setting $XDG_SESSION_TYPE to wayland, you get a message [gbinder] Service manager /dev/nbox-binder has appeared and nothing else.
• Installing cage depends on xwayland, after adding both, launching cage waydroid show-full-ui returns the same output as above.
• Changing to root and running waydroid container start returns: ERROR: WayDroid container service is already running
• Running waydroid container stop returns nothing and following that with waydroid container start returns the same error as above.
• Running waydroid container restart returns WayDroid container is STOPPED and following that with waydroid container start returns the same error as above.

Waydroid Only Sessions for KWin

https://docs.waydro.id/faq/setting-up-waydroid-only-sessions

doesn't feature KWin Wayland (KDE)

`Reset Waydroid` section contains wrong command

https://docs.waydro.id/debugging/troubleshooting#general-tips

this command as shown on the wiki rm -rf /var/lib/waydroid /home/.waydroid ~/waydroid ~/.share/waydroid ~/.local/share/applications/*aydroid* ~/.local/share/waydroid, many of the location now no longer exist.

Add "disable touch sounds" to FAQ

I was trying to figure out why there were strange audio clicks coming from Waydroid, which also sometimes had the effect of cutting out the first few hundred milliseconds of sounds played by Waydroid apps. Then I discovered that it was simply the Android touch feedback!Turning that off made the experience way better.

I would suggest adding an item "Disable touch sounds" to the FAQ with the instructions:

Start Settings and select Sound.
Expand the Advanced section. Under the heading "Other sounds and vibrations", disable "Touch sounds".

Generate usage/waydroid-command-line-options.md from tools/helpers/arguments.py

to avoid that it diverges and save manual work

Switch fedora instrucitons to new copr

Does not require to install a third party kernel
https://copr.fedorainfracloud.org/coprs/aleasto/waydroid/

curl writes HTTP error response to waydroid.gpg

At https://github.com/waydroid/docs/blob/master/usage/install-on-desktops.md#install
this command sudo curl https://repo.waydro.id/waydroid.gpg --output /usr/share/keyrings/waydroid.gpg
will also write HTTP error response, if it occurs, to waydroid.gpg

This command curl -# --proto '=https' --tlsv1.2 -Sf https://repo.waydro.id/waydroid.gpg --output /usr/share/keyrings/waydroid.gpg exits in case any HTTP error occurs. i am using this command in a bash script i wrote to automate waydroid installation.

How to update Lineage OS major version image release without full re-install?

Please provide an FAQ/guide page on the proper commands to upgrade from one major release to another (Lineage OS 17.1 to 18, etc).
When I did an upgrade recently on my pinephone it failed to boot, but I don't want to have to re-install everything from scratch, and generate a new GAPPs phone ID, etc from a fresh install.

Is seedvault the recommended way of doing this? https://docs.waydro.id/faq/backup-restore-apps-and-data

Which waydroid folders (if any) need to be deleted before doing the first boot of the new installation?
Is a specific init command sequence required?

I have my pinephone pro setup with a full backup (and still on lineage 17) so I can test this process out over the weekend.

An issue will come up that on many distros the images are updated from the package manager, so possibly waydroid itself needs a way to detect that you changed images from a system upgrade. Probably a separate issue will need to be created for such a feature enhancement...

Instructions for openSUSE Leap/Tumbleweed

There doesn't seem to be any documentation for how waydroid would be installed on this distro.

I guess this could be combined with #36 and #37