YunoHost-Apps/wallabag2_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/wallabag2_ynh.git synced 2024-10-01 13:35:06 +02:00
Code Issues Activity Actions

Merge branch 'PHP-version' of https://github.com/YunoHost-Apps/wallabag2_ynh into PHP-version

Browse source
This commit is contained in:
ericgaspar 2021-06-24 11:27:51 +02:00
commit e0d78d0d5c
No known key found for this signature in database
GPG key ID: 574F281483054D44
2 changed files with 45 additions and 95 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

74
README.md
View file

@ -1,37 +1,31 @@
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
# Wallabag for YunoHost # Wallabag for YunoHost
[![Integration level](https://dash.yunohost.org/integration/wallabag2.svg)](https://dash.yunohost.org/appci/app/wallabag2) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/wallabag2.svg)](https://dash.yunohost.org/appci/app/wallabag2) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.maintain.svg)
[![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wallabag2) [![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=wallabag2)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allow you to install Wallabag quickly and simply on a YunoHost server. > *This package allows you to install Wallabag quickly and simply on a YunoHost server.
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## Overview
[Wallabag](https://www.wallabag.org/) is a self hostable Read-It-Later application allowing you to not miss any content anymore. Click, save, read it when you can. A self hostable read-it-later app
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.4.2~ynh1
**Shipped version:** 2.4.2 **Demo:** https://demo.yunohost.org/wallabag/
## Screenshots ## Screenshots
![](https://www.linuxbabe.com/wp-content/uploads/2016/10/wallabag-quick-start-page.png) ![](./doc/screenshots/wallabag-quick-start-page.png)
## Demo ## Disclaimers / important information
* [YunoHost demo](https://demo.yunohost.org/wallabag/)
* [Video demo](https://player.vimeo.com/video/167435064)
## Configuration
## Documentation
* Official documentation: https://doc.wallabag.org/en/
* YunoHost documentation: https://yunohost.org/#/app_wallabag2
## YunoHost specific features ## YunoHost specific features
@ -41,46 +35,28 @@ In addition to Wallabag core features, the following are made available with thi
* Allow one user to be the administrator (set at the installation) * 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 ?) * Asynchronous import using Redis (need to be enabled in the *Internal Settings*). RabbitMQ import not supported (yet ?)
#### Multi-users support
#### Supported architectures
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wallabag2%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wallabag2/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wallabag2%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wallabag2/)
## Limitations ## 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 * 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 ## Documentation and resources
**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 !** * 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
#### Upgrade from v1 ## Developer info
The upgrade from the YunoHost [Wallabag v1](https://github.com/YunoHost-Apps/wallabag_ynh) Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing).
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](https://doc.wallabag.org/en/user/import/wallabagv1.html).
## Links To try the testing branch, please proceed like that.
* Report a bug: https://github.com/YunoHost-Apps/wallabag2_ynh/issues
* App website: https://www.wallabag.org/
* Upstream app repository: https://github.com/wallabag/wallabag
* YunoHost website: https://yunohost.org/
---
## Developers and testers info
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing).
To try the testing branch, please proceed like that:
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing --debug
or or
sudo yunohost app upgrade wallabag2 -u https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing --debug 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. **More info regarding app packaging:** https://yunohost.org/packaging_apps

66
README_fr.md
View file

@ -1,36 +1,27 @@
# Wallabag pour YunoHost # Wallabag pour YunoHost
[![Integration level](https://dash.yunohost.org/integration/wallabag2.svg)](https://dash.yunohost.org/appci/app/wallabag2) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.maintain.svg) [![Niveau d'intégration](https://dash.yunohost.org/integration/wallabag2.svg)](https://dash.yunohost.org/appci/app/wallabag2) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.maintain.svg)
[![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wallabag2) [![Installer Wallabag avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=wallabag2)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer Wallabag rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d'installer Wallabag rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble ## Vue d'ensemble
[Wallabag](https://www.wallabag.org/) est une application de lecture différée : elle permet simplement d’archiver une page web en ne conservant que le contenu. Les éléments superflus (menus, publicités, etc.) sont supprimés. Une application de lecture-plus-tard auto-hébergeable
Sont disponibles une interface web, des add-ons pour navigateurs (Firefox / Chrome / Opera), des applications pour mobile (Android / iOS / Windows Phone) et même sur liseuse (PocketBook / Kobo). **Version incluse :** 2.4.2~ynh1
**Version incluse:** 2.4.2 **Démo :** https://demo.yunohost.org/wallabag/
## Captures d'écran ## Captures d'écran
![](https://www.linuxbabe.com/wp-content/uploads/2016/10/wallabag-quick-start-page.png) ![](./doc/screenshots/wallabag-quick-start-page.png)
## Démo ## Avertissements / informations importantes
* [Démo YunoHost](https://demo.yunohost.org/wallabag/)
* [Démo video](https://player.vimeo.com/video/167435064)
## Configuration
## Documentation
* Documentation officielle : https://doc.wallabag.org/fr/
* Documentation YunoHost : https://yunohost.org/#/app_wallabag2
## Caractéristiques spécifiques YunoHost ## Caractéristiques spécifiques YunoHost
@ -40,45 +31,28 @@ En plus des fonctionnalités principales de Wallabag, ce paquet propose égaleme
* De permettre à un utilisateur d'être administrateur (réglage lors de l'installation) * De permettre à un utilisateur d'être administrateur (réglage lors de l'installation)
* Un import asynchrone utilisant Redis (à activer dans les *Paramètres Internes*). L'import via RabbitMQ n'est pas (encore ?) supporté. * Un import asynchrone utilisant Redis (à activer dans les *Paramètres Internes*). L'import via RabbitMQ n'est pas (encore ?) supporté.
#### Support multi-utilisateurs
#### Supported architectures
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wallabag2%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wallabag2/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wallabag2%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wallabag2/)
## Limitations ## Limitations
* Supprimer un utilisateur YunoHost ne supprimera pas l'utilisateur Wallabag lié, il sera seulement désactivé. Vous devez le supprimer manuellement avant. Voir : https://github.com/YunoHost-Apps/wallabag2_ynh/issues/39 * Supprimer un utilisateur YunoHost ne supprimera pas l'utilisateur Wallabag lié, il sera seulement désactivé. Vous devez le supprimer manuellement avant. Voir : https://github.com/YunoHost-Apps/wallabag2_ynh/issues/39
## Informations additionnelles ## Documentations et ressources
**NB: Depuis que @jeromelebleu ne maintient plus ce paquet, je (@lapineige) reprends la charge de ce dépôt. Mais j'ai un temps et une expérience limitées, donc n'hésitez pas à donner un coup de main :) !** * Site officiel de l'app : https://www.wallabag.org
* Documentation officielle utilisateur : https://yunohost.org/#/app_wallabag2
* Documentation officielle de l'admin : https://doc.wallabag.org/en/
#### Mettre à niveau depuis la v1 * Dépôt de code officiel de l'app : https://github.com/wallabag/wallabag
* Documentation YunoHost pour cette app : https://yunohost.org/app_wallabag2
La mise à niveau depuis le paquet YunoHost de [Wallabag v1](https://github.com/YunoHost-Apps/wallabag_ynh) demande une opération manuelle, c'est pourquoi un nouveau paquet est fournit. * Signaler un bug : https://github.com/YunoHost-Apps/wallabag2_ynh/issues
Pour le processus de migration, merci de vous référer à [la documentation officiel de Wallabag](https://doc.wallabag.org/fr/user/import/wallabagv1.html).
## Links
* Signaler un bug : https://github.com/YunoHost-Apps/wallabag2_ynh/issues
* Site de l'application : https://www.wallabag.org/
* Dépôt de l'application principale : https://github.com/wallabag/wallabag
* Site web YunoHost : https://yunohost.org/
---
## Informations pour les développeurs ## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing). Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing).
Pour essayer la branche testing, procédez comme ceci : Pour essayer la branche testing, procédez comme suit.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing --debug
ou ou
sudo yunohost app upgrade wallabag2 -u https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing --debug sudo yunohost app upgrade wallabag2 -u https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing --debug
``` ```
Soyez concient que la branche testing *pourrait* contenir des bugs et n'est pas recommandée si vous recherchez la stabilité de votre application.
Une mise à jour classique avec `sudo yunohost app upgrade wallabag2` (sans préciser l'URL) fera retourner votre application au niveau de la branche master. **Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps