mirror of
https://github.com/YunoHost-Apps/wallabag2_ynh.git
synced 2024-10-01 13:35:06 +02:00
Merge pull request #120 from YunoHost-Apps/readme_templates
Readme templates
This commit is contained in:
yalh76
GitHub
commit
3bcaad0789
5 changed files with 74 additions and 112 deletions
78
README.md
78
README.md
|
|
@ -1,86 +1,62 @@
|
|||
<!--
|
||||
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
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/wallabag2)  
|
||||
[](https://install-app.yunohost.org/?app=wallabag2)
|
||||
[](https://install-app.yunohost.org/?app=wallabag2)
|
||||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allow 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.*
|
||||
> *This package allows you to install Wallabag quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||
|
||||
## 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.
|
||||
A self hostable read-it-later app
|
||||
|
||||
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~ynh3
|
||||
|
||||
**Shipped version:** 2.3.8
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
## Demo
|
||||
|
||||
* [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
|
||||
|
||||
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 ?)
|
||||
* Asynchronous import using *Redis* (need to be enabled in the *Internal Settings*). *RabbitMQ* import not supported (yet?).
|
||||
|
||||
#### Multi-users support
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/wallabag2/)
|
||||
* ARMv8-A - [](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
|
||||
* 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).
|
||||
|
||||
## Additional information
|
||||
### (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.*
|
||||
|
||||
**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 !**
|
||||
(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`.
|
||||
|
||||
#### Upgrade from v1
|
||||
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).
|
||||
|
||||
The 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).
|
||||
## Documentation and resources
|
||||
|
||||
## Links
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_wallabag2
|
||||
* Report a bug: https://github.com/YunoHost-Apps/wallabag2_ynh/issues
|
||||
|
||||
* 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/
|
||||
## Developer info
|
||||
|
||||
---
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing).
|
||||
|
||||
## 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:
|
||||
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.
|
||||
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||
66
README_fr.md
66
README_fr.md
|
|
@ -1,38 +1,25 @@
|
|||
# Wallabag pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/wallabag2)  
|
||||
[](https://install-app.yunohost.org/?app=wallabag2)
|
||||
[](https://dash.yunohost.org/appci/app/wallabag2)  
|
||||
[](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.*
|
||||
|
||||
## 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.3.8~ynh3
|
||||
|
||||
**Version incluse:** 2.3.8
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
## Démo
|
||||
|
||||
* [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
|
||||
|
||||
En plus des fonctionnalités principales de Wallabag, ce paquet propose également :
|
||||
|
||||
|
|
@ -40,45 +27,34 @@ 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)
|
||||
* 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 - [](https://ci-apps.yunohost.org/ci/apps/wallabag2/)
|
||||
* ARMv8-A - [](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
|
||||
|
||||
## Informations additionnelles
|
||||
|
||||
**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 :) !**
|
||||
* 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).
|
||||
|
||||
|
||||
#### Mettre à niveau depuis la v1
|
||||
### 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.*
|
||||
|
||||
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).
|
||||
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`.
|
||||
|
||||
## Links
|
||||
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).
|
||||
|
||||
* 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/
|
||||
## Documentations et ressources
|
||||
|
||||
---
|
||||
* Documentation YunoHost pour cette app : https://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 ceci :
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
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
|
||||
```
|
||||
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
|
||||
|
|
@ -1,16 +1,18 @@
|
|||
### 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 ?)
|
||||
* Asynchronous import using *Redis* (need to be enabled in the *Internal Settings*). *RabbitMQ* import not supported (yet?).
|
||||
|
||||
## 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
|
||||
* 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).
|
||||
|
||||
#### Upgrade from v1
|
||||
### (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.*
|
||||
|
||||
The 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) 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).
|
||||
|
|
@ -1,14 +1,22 @@
|
|||
En plus des fonctionnalités principales de Wallabag, ce paquet propose également :
|
||||
### Caractéristiques spécifiques YunoHost
|
||||
|
||||
* 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é.
|
||||
En plus des fonctionnalités principales de Wallabag, ce paquet propose également :
|
||||
|
||||
## Limitations
|
||||
* 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é.
|
||||
|
||||
* 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
|
||||
### Limitations
|
||||
|
||||
#### Mettre à niveau depuis la v1
|
||||
* 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).
|
||||
|
||||
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).
|
||||
|
|
|
|||
BIN
doc/wallabag-quick-start-page.png
Normal file
BIN
doc/wallabag-quick-start-page.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 145 KiB |
Loading…
Add table
Reference in a new issue