Skip to content

Commit

Permalink
Merge pull request #193 from YunoHost-Apps/testing
Browse files Browse the repository at this point in the history
Testing - Packaging v2
  • Loading branch information
Salamandar authored Mar 15, 2024
2 parents 85182c2 + 4c2f0ef commit 696a0a2
Show file tree
Hide file tree
Showing 31 changed files with 273 additions and 1,410 deletions.
90 changes: 0 additions & 90 deletions .github/workflows/updater.sh

This file was deleted.

49 changes: 0 additions & 49 deletions .github/workflows/updater.yml

This file was deleted.

45 changes: 12 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
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.
-->

Expand All @@ -16,55 +16,34 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in

## 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.
It extracts content so that you can read it when you have time.
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 provides a web interface, browser (Firefox/Chrome/Opera) add-ons, mobile apps (Android/iOS/Windows Phone) and even on e-reader (PocketBook/Kobo).

It provides a web interface, browser (Firefox / Chrome / Opera) add-ons, mobile apps (Android / iOS / Windows Phone) and even on e-reader (PocketBook / Kobo).
Upgrade from the YunoHost [Wallabag v1](https://github.com/YunoHost-Apps/wallabag_ynh) 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).

**Shipped version:** 2.5.4~ynh3

**Shipped version:** 2.5.4~ynh2

**Demo:** https://demo.yunohost.org/wallabag/
**Demo:** <https://demo.yunohost.org/wallabag/>

## Screenshots

![Screenshot of Wallabag](./doc/screenshots/screenshot1.webp)

## 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](https://github.com/YunoHost-Apps/wallabag_ynh) 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).

### (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](https://github.com/YunoHost-Apps/wallabag2_ynh/pulls). 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 admin documentation: <https://doc.wallabag.org/en/>
* Upstream app code repository: <https://github.com/wallabag/wallabag>
* YunoHost Store: <https://apps.yunohost.org/app/wallabag2>
* Report a bug: <https://github.com/YunoHost-Apps/wallabag2_ynh/issues>
- Official app website: <https://www.wallabag.org>
- Official admin documentation: <https://doc.wallabag.org/en/>
- Upstream app code repository: <https://github.com/wallabag/wallabag>
- YunoHost Store: <https://apps.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](https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
```bash
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
Expand Down
51 changes: 13 additions & 38 deletions README_fr.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
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.
-->

Expand All @@ -16,62 +16,37 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po

## 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.
Wallabag 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.
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).

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

**Version incluse :** 2.5.4~ynh3

**Version incluse :** 2.5.4~ynh2

**Démo :** https://demo.yunohost.org/wallabag/
**Démo :** <https://demo.yunohost.org/wallabag/>

## Captures d’écran

![Capture d’écran de Wallabag](./doc/screenshots/screenshot1.webp)

## Avertissements / informations importantes

### Caractéristiques spécifiques YunoHost

En plus des fonctionnalités principales de Wallabag, ce paquet propose également :

* Une intégration avec le système de gestion des utilisateurs et le SSO de YunoHost - e.g. un bouton de déconnexion
* 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é.

### 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

* 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. 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).


### Branche de test (*Testing*)
*Soyez concient que la branche testing* pourrait *contenir des bugs et n'est pas recommandée si vous recherchez la stabilité de votre application.*

Les personnes souhaitant (bêta) tester de nouvelles mises à jour (ex: une nouvelle version), listée dans la [section des Pull Requests](https://github.com/YunoHost-Apps/wallabag2_ynh/pulls), sont les bienvenues. Plus de tests nous permettrons de sortir des mises à jour plus vite. Pour tester la branche *testing*, utilisez `sudo yunohost app upgrade wallabag2 -u https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing`.

Attention : Une mise à jour classique avec l'interface d'administration ou avec `sudo yunohost app upgrade wallabag2` (sans préciser l'URL) fera retourner votre application au niveau de la branche master. *Ceci pourrait casser votre wallabag* si vous revenez à une version précédente (et si la nouvelle n'est pas rétrocompatible).


## Documentations et ressources

* Site officiel de l’app : <https://www.wallabag.org>
* Documentation officielle de l’admin : <https://doc.wallabag.org/en/>
* Dépôt de code officiel de l’app : <https://github.com/wallabag/wallabag>
* YunoHost Store: <https://apps.yunohost.org/app/wallabag2>
* Signaler un bug : <https://github.com/YunoHost-Apps/wallabag2_ynh/issues>
- Site officiel de l’app : <https://www.wallabag.org>
- Documentation officielle de l’admin : <https://doc.wallabag.org/en/>
- Dépôt de code officiel de l’app : <https://github.com/wallabag/wallabag>
- YunoHost Store : <https://apps.yunohost.org/app/wallabag2>
- Signaler un bug : <https://github.com/YunoHost-Apps/wallabag2_ynh/issues>

## Informations pour les développeurs

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

``` bash
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing --debug
ou
sudo yunohost app upgrade wallabag2 -u https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing --debug
```

**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
30 changes: 0 additions & 30 deletions check_process

This file was deleted.

7 changes: 0 additions & 7 deletions conf/app.src

This file was deleted.

4 changes: 4 additions & 0 deletions conf/extra_php-fpm.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
; Additional php.ini defines, specific to this pool of workers.

php_admin_value[upload_max_filesize] = 50M
php_admin_value[post_max_size] = 50M
2 changes: 1 addition & 1 deletion conf/nginx.conf
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
location __PATH__/ {

# Path to source
alias __FINALPATH__/web/;
alias __INSTALL_DIR__/web/;

client_body_timeout 60m;
proxy_read_timeout 60m;
Expand Down
Loading

0 comments on commit 696a0a2

Please sign in to comment.