73f23104d6
Co-authored-by: @ericgaspar Co-authored-by: lapineige <lapineige@users.noreply.github.com> |
||
|---|---|---|
| conf | ||
| doc | ||
| hooks | ||
| scripts | ||
| sources/patches | ||
| .gitignore | ||
| check_process | ||
| LICENSE | ||
| manifest.json | ||
| pull_request_template.md | ||
| README.md | ||
| README_fr.md | ||
Wallabag for YunoHost
This package allows you to install Wallabag quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.
Overview
Self hostable read-it-later app
Shipped version: 2.4.2~ynh2
Demo: https://demo.yunohost.org/wallabag/
Screenshots
Disclaimers / important information
YunoHost specific features
In addition to Wallabag core features, the following are made available with this package:
- Integrate with YunoHost users and SSO - i.e. logout button
- Allow one user to be the administrator (set at the installation)
- Asynchronous import using Redis (need to be enabled in the Internal Settings). RabbitMQ import not supported (yet?).
Limitations
- Removing a Yunohost's user won't delete the related wallabag user, but only desactivate it. You need to manualy remove it from wallabag before. See: https://github.com/YunoHost-Apps/wallabag2_ynh/issues/39
- Upgrade from the YunoHost Wallabag v1 app requires a manual operation. That's why it's provided as a new package. For the migration process, please refer to the Wallabag official documentation.
(Beta) Testing branch
Please be aware that the testing branch (or any PR branch) might contains some bugs and is not recommended if you need a stable app.
(Beta) Testers are welcome to try new upgrades (such as a new version), as listed in the Pull Requests section. More testing will allow us to provide upgrades faster 🙂. In order to try the testing branch, use sudo yunohost app upgrade wallabag2 -u https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing.
Warning : Doing a normal upgrade of the package with the web admin or sudo yunohost app upgrade wallabag2 (without any URL specified) will revert you app to the master branch. This may break you wallabag if it goes to a previous version (if the newest is not retrocompatible).
Documentation and resources
- Official app website: https://www.wallabag.org
- Official user documentation: https://yunohost.org/#/app_wallabag2
- Official admin documentation: https://doc.wallabag.org/en/
- Upstream app code repository: https://github.com/wallabag/wallabag
- YunoHost documentation for this app: https://yunohost.org/app_wallabag2
- Report a bug: https://github.com/YunoHost-Apps/wallabag2_ynh/issues
Developer info
Please send your pull request to the testing branch.
To try the testing branch, please proceed like that.
sudo yunohost app install https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing --debug
or
sudo yunohost app upgrade wallabag2 -u https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing --debug
More info regarding app packaging: https://yunohost.org/packaging_apps