# Waydroid

Waydroid is 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 inside the container has direct access to needed hardwares.

The Android runtime environment ships with a minimal customized Android system image based on the [LineageOS](https://lineageos.org). The used image is currently based on Android 13.

## Index

### Usage

{% content-ref url="usage/install-on-desktops" %}
[install-on-desktops](https://docs.waydro.id/usage/install-on-desktops)
{% endcontent-ref %}

{% content-ref url="usage/install-and-run-android-applications" %}
[install-and-run-android-applications](https://docs.waydro.id/usage/install-and-run-android-applications)
{% endcontent-ref %}

{% content-ref url="usage/waydroid-command-line-options" %}
[waydroid-command-line-options](https://docs.waydro.id/usage/waydroid-command-line-options)
{% endcontent-ref %}

{% content-ref url="usage/waydroid-prop-options" %}
[waydroid-prop-options](https://docs.waydro.id/usage/waydroid-prop-options)
{% endcontent-ref %}

### FAQ

{% content-ref url="faq/google-play-certification" %}
[google-play-certification](https://docs.waydro.id/faq/google-play-certification)
{% endcontent-ref %}

{% content-ref url="faq/disable-on-screen-keyboard" %}
[disable-on-screen-keyboard](https://docs.waydro.id/faq/disable-on-screen-keyboard)
{% endcontent-ref %}

{% content-ref url="faq/disable-touch-sounds" %}
[disable-touch-sounds](https://docs.waydro.id/faq/disable-touch-sounds)
{% endcontent-ref %}

{% content-ref url="faq/community-projects-we-like" %}
[community-projects-we-like](https://docs.waydro.id/faq/community-projects-we-like)
{% endcontent-ref %}

{% content-ref url="faq/get-waydroid-to-work-through-a-vm" %}
[get-waydroid-to-work-through-a-vm](https://docs.waydro.id/faq/get-waydroid-to-work-through-a-vm)
{% endcontent-ref %}

{% content-ref url="faq/using-adb-with-waydroid" %}
[using-adb-with-waydroid](https://docs.waydro.id/faq/using-adb-with-waydroid)
{% endcontent-ref %}

{% content-ref url="faq/setting-up-waydroid-only-sessions" %}
[setting-up-waydroid-only-sessions](https://docs.waydro.id/faq/setting-up-waydroid-only-sessions)
{% endcontent-ref %}

{% content-ref url="faq/setting-up-a-shared-folder" %}
[setting-up-a-shared-folder](https://docs.waydro.id/faq/setting-up-a-shared-folder)
{% endcontent-ref %}

{% content-ref url="faq/color-correction-in-mutter" %}
[color-correction-in-mutter](https://docs.waydro.id/faq/color-correction-in-mutter)
{% endcontent-ref %}

{% content-ref url="faq/backup-restore-apps-and-data" %}
[backup-restore-apps-and-data](https://docs.waydro.id/faq/backup-restore-apps-and-data)
{% endcontent-ref %}

{% content-ref url="faq/using-custom-waydroid-images" %}
[using-custom-waydroid-images](https://docs.waydro.id/faq/using-custom-waydroid-images)
{% endcontent-ref %}

{% content-ref url="<https://github.com/waydroid/docs/blob/master/faq/install-system-app.md>" %}
<https://github.com/waydroid/docs/blob/master/faq/install-system-app.md>
{% endcontent-ref %}

### Development

{% content-ref url="development/compile-waydroid-lineage-os-based-images" %}
[compile-waydroid-lineage-os-based-images](https://docs.waydro.id/development/compile-waydroid-lineage-os-based-images)
{% endcontent-ref %}

{% content-ref url="development/manual-patch-resolution" %}
[manual-patch-resolution](https://docs.waydro.id/development/manual-patch-resolution)
{% endcontent-ref %}

### Help improve this page

You may help improve this page by opening a pull request to the [docs repo](https://github.com/waydroid/docs)

### Licensing

{% content-ref url="<https://github.com/waydroid/docs/blob/master/licensing/licensing.md>" %}
<https://github.com/waydroid/docs/blob/master/licensing/licensing.md>
{% endcontent-ref %}

## Reporting bugs

If you have found an issue with Waydroid, please [file a bug](https://github.com/waydroid/waydroid/issues/new/choose).

## Get in Touch

If you want to get in contact with the developers please feel free to join the *Waydroid* groups in

* [Matrix](https://matrix.to/#/#waydroid:matrix.org)
* [Telegram](https://t.me/WayDroid)
* [Reddit](https://www.reddit.com/r/waydroid/)

## Credits

We'd like to say thanks to all these great teams & projects: @Anbox @LineageOS @Android-x86 @spurv @LXC and many others, for you still lead the way for Open Innovation in Linux and the Android community.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.waydro.id/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
