mirror of
https://github.com/YunoHost-Apps/wallabag2_ynh.git
synced 2024-10-01 13:35:06 +02:00
52 lines
2.4 KiB
Markdown
52 lines
2.4 KiB
Markdown
<!--
|
|
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)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *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 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).
|
|
|
|
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
|
|
|
|
**Demo:** <https://demo.yunohost.org/wallabag/>
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## 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>
|
|
|
|
## 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
|
|
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>
|