4.2 KiB
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.
Just confirm that message and you get redirected to the settings screen.
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.
After you have filled in your data, push the button Connection test and wait for the test to finish.
The connection test shall finish with success. If not, you need to fix this first until you proceed.
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.
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.
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.
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.
Finally after the syncronisation finished successfully, you are presented the list of unread articles.
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
Android Application on F-Droid