aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user/android.rst
diff options
context:
space:
mode:
authorNicolas LÅ“uillet <nicolas@loeuillet.org>2016-11-18 09:28:20 +0100
committerGitHub <noreply@github.com>2016-11-18 09:28:20 +0100
commit19d401b15c1151bfa6c2364f31cc1eb87e7c99ef (patch)
tree9c47399f9b1a9ad2228ec365a1fd5e20edc7771f /docs/en/user/android.rst
parent9e0a49e6acf60c3dbf3c479cb36d404239dfda89 (diff)
parent50540682ffcaa6acf16f3b17cede3da9694c494f (diff)
downloadwallabag-19d401b15c1151bfa6c2364f31cc1eb87e7c99ef.tar.gz
wallabag-19d401b15c1151bfa6c2364f31cc1eb87e7c99ef.tar.zst
wallabag-19d401b15c1151bfa6c2364f31cc1eb87e7c99ef.zip
Merge pull request #2550 from wallabag/reorder-documentation
Reordered documentation
Diffstat (limited to 'docs/en/user/android.rst')
-rw-r--r--docs/en/user/android.rst32
1 files changed, 10 insertions, 22 deletions
diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst
index 91dcb2fc..e286bb3b 100644
--- a/docs/en/user/android.rst
+++ b/docs/en/user/android.rst
@@ -1,13 +1,11 @@
1Android App 1Android application
2=========== 2===================
3
4 3
5Purpose of this document 4Purpose of this document
6------------------------ 5------------------------
7 6
8This 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. 7This 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 8
10
11Steps to configure your app 9Steps to configure your app
12--------------------------- 10---------------------------
13 11
@@ -23,7 +21,7 @@ Just confirm that message and you get redirected to the settings screen.
23 :alt: Settings screen 21 :alt: Settings screen
24 :align: center 22 :align: center
25 23
26Fill 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. 24Fill 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 25
28.. image:: ../../img/user/android_configuration_filled_in.en.png 26.. image:: ../../img/user/android_configuration_filled_in.en.png
29 :alt: Filled in settings 27 :alt: Filled in settings
@@ -59,49 +57,39 @@ Now you need to scroll to the bottom of the settings menu. Of course you can adj
59 :alt: Bottom of the settings screen 57 :alt: Bottom of the settings screen
60 :align: center 58 :align: center
61 59
62After 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. 60After 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.
63 61
64.. image:: ../../img/user/android_configuration_saved_feed_update.en.png 62.. image:: ../../img/user/android_configuration_saved_feed_update.en.png
65 :alt: Settings saved the first time 63 :alt: Settings saved the first time
66 :align: center 64 :align: center
67 65
68Finally after the synchronisation finished successfully, you are presented to the list of unread articles. 66Finally after the synchronization finished successfully, you are presented to the list of unread articles.
69 67
70.. image:: ../../img/user/android_unread_feed_synced.en.png 68.. image:: ../../img/user/android_unread_feed_synced.en.png
71 :alt: Filled article list cause feeds successfully synchronized 69 :alt: Filled article list cause feeds successfully synchronized
72 :align: center 70 :align: center
73 71
74
75
76Known limitations 72Known limitations
77----------------- 73-----------------
78 74
792FA 75Two factor authentication (2FA)
80~~~ 76~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
81 77
82Currently the Android application does not support two-factor authentication. You should disable that to get the application working. 78Currently the Android application does not support two-factor authentication. You should disable that to get the application working.
83 79
84
85Limited amount of articles with wallabag v2 80Limited amount of articles with wallabag v2
86~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 81~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
87 82
88In 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. 83In 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 84
90
91SSL/TLS encryption 85SSL/TLS encryption
92~~~~~~~~~~~~~~~~~~ 86~~~~~~~~~~~~~~~~~~
93 87
94If 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. 88If 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 89
96
97References 90References
98---------- 91----------
99 92
100`Source code of the Android application <https://github.com/wallabag/android-app>`_ 93- `Source code of the Android application <https://github.com/wallabag/android-app>`_
101 94- `Android Application on F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_
102`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>`_
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