docs/en/user/android.rst

   1 Android application
   2 ===================
   3
   4 Purpose of this document
   5 ------------------------
   6
   7 This document describes how you can setup your Android application to work with your wallabag instance. There is no difference in this procedure for wallabag v1 or v2.
   8
   9 Steps to configure your app
  10 ---------------------------
  11
  12 When you first start the app, you see the welcome screen, where you are adviced to configure the app for your wallabag instance at first.
  13
  14 .. image:: ../../img/user/android_welcome_screen.en.png
  15     :alt: Welcome screen
  16     :align: center
  17
  18 Just confirm that message and you get redirected to the settings screen.
  19
  20 .. image:: ../../img/user/android_configuration_screen.en.png
  21     :alt: Settings screen
  22     :align: center
  23
  24 Fill in your wallabag data. You need to enter your wallabag address. **It is important that this URL does not end with a slash**. Also add your wallabag credentials to the user name and password field.
  25
  26 .. image:: ../../img/user/android_configuration_filled_in.en.png
  27     :alt: Filled in settings
  28     :align: center
  29
  30 After you have filled in your data, push the button Connection test and wait for the test to finish.
  31
  32 .. image:: ../../img/user/android_configuration_connection_test.en.png
  33     :alt: Connection test with your wallabag data
  34     :align: center
  35
  36 The connection test should finish with success. If not, you need to fix this first until you proceed.
  37
  38 .. image:: ../../img/user/android_configuration_connection_test_success.en.png
  39     :alt: Connection test successful
  40     :align: center
  41
  42 After the connection test was successful, you can push the button to get your feed credentials. The app now tries to login to your wallabag instance and get the user id and the corresponding token for the feeds.
  43
  44 .. image:: ../../img/user/android_configuration_get_feed_credentials.en.png
  45     :alt: Getting the feed credentials
  46     :align: center
  47
  48 When the process of getting your feed credentials finishes with success you see a toast message that the user id and the token were automatically filled in to the form.
  49
  50 .. image:: ../../img/user/android_configuration_feed_credentials_automatically_filled_in.en.png
  51     :alt: Getting feed credentials successful
  52     :align: center
  53
  54 Now you need to scroll to the bottom of the settings menu. Of course you can adjust the given settings to your needs. Finish the configuration of your app with pushing the save button.
  55
  56 .. image:: ../../img/user/android_configuration_scroll_bottom.en.png
  57     :alt: Bottom of the settings screen
  58     :align: center
  59
  60 After hitting the save button, you get the following screen. The app proposes to initiate a synchronization process to update your feeds of articles. It is recommended to acknowledge this action and press Yes.
  61
  62 .. image:: ../../img/user/android_configuration_saved_feed_update.en.png
  63     :alt: Settings saved the first time
  64     :align: center
  65
  66 Finally after the synchronization finished successfully, you are presented to the list of unread articles.
  67
  68 .. image:: ../../img/user/android_unread_feed_synced.en.png
  69     :alt: Filled article list cause feeds successfully synchronized
  70     :align: center
  71
  72 Known limitations
  73 -----------------
  74
  75 Two factor authentication (2FA)
  76 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  77
  78 Currently the Android application does not support two-factor authentication. You should disable that to get the application working.
  79
  80 Limited amount of articles with wallabag v2
  81 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  82
  83 In your wallabag web instance you can configure how many items are part of the RSS feed. This option did not exist in wallabag v1, where all articles were part of the feed. So if you set the amount of articles being displayed greater than the number of items being content of your RSS feed, you will only see the number of items in your RSS feed.
  84
  85 SSL/TLS encryption
  86 ~~~~~~~~~~~~~~~~~~
  87
  88 If you can reach your wallabag web instance via HTTPS, you should use that. Especially if your HTTP URL redirects you to the HTTPS one. Currently, the app cannot handle that redirect properly.
  89
  90 References
  91 ----------
  92
  93 - `Source code of the Android application <https://github.com/wallabag/android-app>`_
  94 - `Android Application on F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_
  95 - `Android Application on Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_