docs/en/user/android.rst

   1 Android App
   2 ===========
   3
   4
   5 Purpose of this document
   6 ------------------------
   7
   8 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.
   9
  10
  11 Steps to configure your app
  12 ---------------------------
  13
  14 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.
  15
  16 .. image:: ../../img/user/android_welcome_screen.en.png
  17     :alt: Welcome screen
  18     :align: center
  19
  20 Just confirm that message and you get redirected to the settings screen.
  21
  22 .. image:: ../../img/user/android_configuration_screen.en.png
  23     :alt: Settings screen
  24     :align: center
  25
  26 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.
  27
  28 .. image:: ../../img/user/android_configuration_filled_in.en.png
  29     :alt: Filled in settings
  30     :align: center
  31
  32 After you have filled in your data, push the button Connection test and wait for the test to finish.
  33
  34 .. image:: ../../img/user/android_configuration_connection_test.en.png
  35     :alt: Connection test with your wallabag data
  36     :align: center
  37
  38 The connection test shall finish with success. If not, you need to fix this first until you proceed.
  39
  40 .. image:: ../../img/user/android_configuration_connection_test_success.en.png
  41     :alt: Connection test successful
  42     :align: center
  43
  44 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.
  45
  46 .. image:: ../../img/user/android_configuration_get_feed_credentials.en.png
  47     :alt: Getting the feed credentials
  48     :align: center
  49
  50 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.
  51
  52 .. image:: ../../img/user/android_configuration_feed_credentials_automatically_filled_in.en.png
  53     :alt: Getting feed credentials successful
  54     :align: center
  55
  56 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.
  57
  58 .. image:: ../../img/user/android_configuration_scroll_bottom.en.png
  59     :alt: Bottom of the settings screen
  60     :align: center
  61
  62 After hitting the save button, you get the following screen. The app proposes to initiate a syncronisation process to update your feeds of articles. It is recommended to acknowledge this action and press Yes.
  63
  64 .. image:: ../../img/user/android_configuration_saved_feed_update.en.png
  65     :alt: Settings saved the first time
  66     :align: center
  67
  68 Finally after the syncronisation finished successfully, you are presented the list of unread articles.
  69
  70 .. image:: ../../img/user/android_unread_feed_synced.en.png
  71     :alt: Filled article list cause feeds successfully syncronized
  72     :align: center
  73
  74
  75
  76 Known limitations
  77 ----
  78
  79 2FA
  80 ~~~
  81
  82 Currently the does not support two-factor authentication. You should disable that to get the app working.
  83
  84
  85 Limited amount of articles with wallabag v2
  86 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  87
  88 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.
  89
  90
  91 SSL/TLS encryption
  92 ~~~~~~~~~~~~~~~~~~
  93
  94 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.
  95
  96
  97 References
  98 ----------
  99
 100 `Source code of the Android application <https://github.com/wallabag/android-app>`_
 101
 102 `Android Application on F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_
 103
 104 `Android Application on Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_
 105
 106 `Support chat <https://gitter.im/wallabag/wallabag>`_
 107