[github/wallabag/wallabag.git] / docs / en / user / android.rst

Android App
===========


Purpose of this document
------------------------

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.


Steps to configure your app
---------------------------

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.

.. image:: ../../img/user/android_welcome_screen.en.png
    :alt: Welcome screen
    :align: center

Just confirm that message and you get redirected to the settings screen.

.. image:: ../../img/user/android_configuration_screen.en.png
    :alt: Settings screen
    :align: center

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.

.. image:: ../../img/user/android_configuration_filled_in.en.png
    :alt: Filled in settings
    :align: center

After you have filled in your data, push the button Connection test and wait for the test to finish. 

.. image:: ../../img/user/android_configuration_connection_test.en.png
    :alt: Connection test with your wallabag data
    :align: center

The connection test shall finish with success. If not, you need to fix this first until you proceed. 

.. image:: ../../img/user/android_configuration_connection_test_success.en.png
    :alt: Connection test successful
    :align: center

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.

.. image:: ../../img/user/android_configuration_get_feed_credentials.en.png
    :alt: Getting the feed credentials
    :align: center

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.

.. image:: ../../img/user/android_configuration_feed_credentials_automatically_filled_in.en.png
    :alt: Getting feed credentials successful
    :align: center

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.

.. image:: ../../img/user/android_configuration_scroll_bottom.en.png
    :alt: Bottom of the settings screen
    :align: center

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.

.. image:: ../../img/user/android_configuration_saved_feed_update.en.png
    :alt: Settings saved the first time
    :align: center

Finally after the syncronisation finished successfully, you are presented the list of unread articles. 

.. image:: ../../img/user/android_unread_feed_synced.en.png
    :alt: Filled article list cause feeds successfully syncronized
    :align: center


Known limitations
----

2FA
~~~

Currently the does not support two-factor authentication. You should disable that to get the app working.


Limited amount of articles with wallabag v2
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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. 


SSL/TLS encryption
~~~~~~~~~~~~~~~~~~

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.


References
----------

`Source code of the Android application <https://github.com/wallabag/android-app>`_

`Android Application on F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_

`Android Application on Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_

`Support chat <https://gitter.im/wallabag/wallabag>`_
Commit	Line	Data
3bd50951 SF	1	Android App
	2	===========
	3
	4
	5	Purpose of this document
	6	------------------------
	7
c6b1112b	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.
3bd50951 SF	9
	10
	11	Steps to configure your app
	12	---------------------------
	13
c6b1112b	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.
3bd50951	15
5ecdfcd0	16	.. image:: ../../img/user/android_welcome_screen.en.png
3bd50951 SF	17	:alt: Welcome screen
	18	:align: center
	19
	20	Just confirm that message and you get redirected to the settings screen.
	21
5ecdfcd0	22	.. image:: ../../img/user/android_configuration_screen.en.png
3bd50951 SF	23	:alt: Settings screen
	24	:align: center
	25
c6b1112b	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.
3bd50951	27
5ecdfcd0	28	.. image:: ../../img/user/android_configuration_filled_in.en.png
3bd50951 SF	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
5ecdfcd0	34	.. image:: ../../img/user/android_configuration_connection_test.en.png
c6b1112b	35	:alt: Connection test with your wallabag data
3bd50951 SF	36	:align: center
	37
	38	The connection test shall finish with success. If not, you need to fix this first until you proceed.
	39
5ecdfcd0	40	.. image:: ../../img/user/android_configuration_connection_test_success.en.png
3bd50951 SF	41	:alt: Connection test successful
	42	:align: center
	43
c6b1112b	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.
3bd50951	45
5ecdfcd0	46	.. image:: ../../img/user/android_configuration_get_feed_credentials.en.png
3bd50951 SF	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
5ecdfcd0	52	.. image:: ../../img/user/android_configuration_feed_credentials_automatically_filled_in.en.png
3bd50951 SF	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
5ecdfcd0	58	.. image:: ../../img/user/android_configuration_scroll_bottom.en.png
3bd50951 SF	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
5ecdfcd0	64	.. image:: ../../img/user/android_configuration_saved_feed_update.en.png
3bd50951 SF	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
5ecdfcd0	70	.. image:: ../../img/user/android_unread_feed_synced.en.png
3bd50951 SF	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
c6b1112b	85	Limited amount of articles with wallabag v2
3bd50951 SF	86	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3bd50951 SF	87
c6b1112b	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.
3bd50951 SF	89
	90
	91	SSL/TLS encryption
	92	~~~~~~~~~~~~~~~~~~
	93
c6b1112b	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.
3bd50951 SF	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