.. include:: /urls.rst

.. _pureos_waydroid:

Waydroid
========


.. _pureos_waydroid_overview:

Overview
--------

While Android applications are not natively installed within PureOS [1]_, `Waydroid`_ makes it possible to install Android applications within PureOS for desktop and mobile.

.. raw:: html

    <video width="80%" controls>
        <source src="https://videos.puri.sm/promo/Anbox.mp4" type="video/mp4">
        <source src="https://videos.puri.sm/promo/Anbox.webm" type="video/webm">
        Your browser does not support HTML video.
    </video>

.. seealso::
   * :download:`Download <https://videos.puri.sm/promo/Anbox.mp4>` the video
   * `Original blog post <blog_app_spotlight_anbox_>`_

.. [1] Purism does not have any control over the quality or security of Waydroid or Android applications.
       Neither Waydroid nor any Android applications are covered by any warranty, expressed or implied.


.. _pureos_waydroid_install:

Install and configure
---------------------

#. :ref:`Update PureOS <pureos_sw_management_update>`
#. Download and install Waydroid

.. Desktop PureOS collapsible section

.. raw:: html

   <details>
   <summary><a>Desktop PureOS</a></summary>

#. Follow the official `Waydroid installation instructions <waydroid_desktop_install_>`_

.. raw:: html

   </details>

.. Mobile PureOS collapsible section

.. raw:: html

   <details>
   <summary><a>Mobile PureOS</a></summary>

#. Download the Waydroid installation package

    #. Navigate to the `Librem 5 CI builds <https://source.puri.sm/Librem5/debs/waydroid>`_
    #. Click/tap the green checkmark near the latest commit
    #. Select a packaging job and download the ``.deb`` artifact, adjusting the filename if necessary

#. Install Waydroid and its dependencies

    #. :ref:`Launch a terminal emulator <pureos_terminal_launch>`.
    #. Run the following command to install the ``.deb`` package:

       .. code-block:: bash

          sudo apt install ./waydroid_1.3.3-0pureos0+librem5ci79377.0353512_all.deb

       .. image:: ../../img/mobile/waydroid-pkg-install.png
          :scale: 50%
          :alt: Installing the waydroid deb package on the Librem 5

.. raw:: html

   </details>

3. Reboot the device
#. Launch Waydroid by clicking/tapping on its icon in the application list.

   .. image:: ../../img/mobile/phosh-waydroid-icon.png
      :scale: 50%
      :alt: Waydroid icon in the phosh app list

   A "Initialize Waydroid" window will launch which allows you to download an Android image.
#. Select an Android image to install.

    * **VANILLA**: no Google services installed
    * **GAPPS**: includes proprietary Google Apps services

   Leave the selection at the default value to use the official Waydroid OTA service.

   .. note::
      microG can be installed later, which is a free- and open-source implementation of Google Play services

#. Click or tap "Download".

   .. image:: ../../img/mobile/waydroid-init.png
      :scale: 50%
      :alt: Installing the waydroid environment on the Librem 5

#. After the image downloads complete, click or tap the blue "Done" button.
   Wait a few moments; an Android splash screen should appear and the Android system should eventually load.
#. Optional: Obtain `Google Play certification <waydroid_google_play_cert_>`_

   .. image:: ../../img/mobile/waydroid/missing-playservice.png
      :scale: 50%
      :alt: Warning prompt that Google Play services are missing

.. seealso::
   * `Original Waydroid installation instructions <snippet_waydroid_install_>`_
   * `Community wiki: Android applications on the Librem 5 <l5_wiki_android_compatibility_>`_


.. _pureos_waydroid_uninstall:

Uninstall
---------

.. caution::
   The following terminal commands remove all data stored within the Android container.

#. :ref:`Launch a terminal emulator <pureos_terminal_launch>` and run the following command:

   .. code-block:: bash

      sudo systemctl stop waydroid-container
      sudo rm -rf /usr/share/waydroid-extra /var/lib/waydroid ~/.local/share/waydroid ~/.local/share/applications/waydroid.*.desktop ~/.local/share/applications/Waydroid.desktop
      sudo apt remove libgbinder libgbinder1 libglibutil libglibutil1 libgbinder-dev libglibutil-dev python3-gbinder waydroid