mirror of https://github.com/YunoHost-Apps/wallabag2_ynh.git synced 2024-10-01 13:35:06 +02:00

Wallabag v2 package for YunoHost

closember official-ynh read-it-later wallabag yunohost

Find a file

lapineige c8a54a8ce6 Fix version number Useless "-1"		2019-05-16 21:51:53 +02:00
conf	Update to 2.3.8	2019-05-14 17:58:45 +02:00
hooks	[enh] Add post_user_{create,delete} hooks	2016-07-16 14:04:47 +02:00
scripts	Merge branch 'testing' into package_upgrade	2019-05-08 17:46:14 +02:00
sources/patches	Update to 2.3.7 (#61 )	2019-05-08 17:25:02 +02:00
.gitignore	Initial commit	2016-05-22 22:16:15 +02:00
check_process	Normalization from example_ynh	2019-05-03 15:08:22 +02:00
LICENSE	Initial commit	2016-05-22 22:16:15 +02:00
manifest.json	Fix version number	2019-05-16 21:51:53 +02:00
pull_request_template.md	Move from ci-apps-dev to ci-apps-hq	2019-04-15 20:54:05 +02:00
README.md	Change version to 2.3.8	2019-05-14 17:57:57 +02:00
README_fr.md	Change version to 2.3.8	2019-05-14 17:58:05 +02:00

README.md

Wallabag for YunoHost

Lire ce readme en français.

This package allow you to install Wallabag quickly and simply on a YunoHost server.
If you don't have YunoHost, please see here to know how to install and enjoy it.

Overview

Wallabag is a self hostable Read-It-Later application allowing you to not miss any content anymore. Click, save, read it when you can. It extracts content so that you can read it when you have time.

It provides a web interface, browser (Firefox / Chrome / Opera) add-ons, mobile apps (Android / iOS / Windows Phone) and even on e-reader (PocketBook / Kobo).

Shipped version: 2.3.8

Screenshots

Demo

Configuration

Documentation

Official documentation: https://doc.wallabag.org/en/
YunoHost documentation: https://yunohost.org/#/app_wallabag2

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 ?)

Multi-users support

Supported architectures

x86-64b -
ARMv8-A -
Jessie x86-64b -

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

Additional information

NB: Since @jeromelebleu is no longer maintaining this package, I (@lapineige) take over this repository. But I have limited time and experience, so feel free to help !

Upgrade from v1

The 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.

Developers and testers info

Only if you want to use a testing branch for coding, instead of merging directly into master. Please do 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

Please be aware that the testing branch might contains some bugs and is not recommended if you need a stable app. Doing a normal upgrade of the package avec sudo yunohost app upgrade wallabag2 (without any URL specified) will revert you app to the master branch.