2022-01-10 15:18:41 +01:00
# Shiori pour YunoHost
2022-01-10 15:18:34 +01:00
2022-01-10 15:18:41 +01:00
[![Niveau d'intégration ](https://dash.yunohost.org/integration/shiori.svg )](https://dash.yunohost.org/appci/app/shiori) ![](https://ci-apps.yunohost.org/ci/badges/shiori.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/shiori.maintain.svg)
[![Installer Shiori avec YunoHost ](https://install-app.yunohost.org/install-with-yunohost.svg )](https://install-app.yunohost.org/?app=shiori)
2022-01-10 15:18:34 +01:00
*[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
2022-01-10 15:18:41 +01:00
> *Ce package vous permet d'installer Shiori 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.*
2022-01-10 15:18:34 +01:00
## Vue d'ensemble
2022-01-10 15:25:33 +01:00
Shiori is a simple bookmarks manager written in Go language. Intended as a simple clone of Pocket. You can use it as command line application or as web application. This application is distributed as a single binary, which means it can be installed and used easily.
2022-01-10 15:18:34 +01:00
2022-01-10 15:18:41 +01:00
### Features
2022-01-10 15:18:34 +01:00
2022-01-10 15:25:33 +01:00
- Simple and clean command line interface.
- Basic bookmarks management i.e. add, edit and delete.
- Search bookmarks by their title, tags, url and page content.
- Import and export bookmarks from and to Netscape Bookmark file.
- Portable, thanks to its single binary format and sqlite3 database
- Simple web interface for those who don't want to use a command line app.
- Where possible, by default shiori will download a static copy of the webpage in simple text and HTML format, which later can be used as an offline archive for that page.
2022-01-10 15:18:34 +01:00
2022-01-10 15:18:41 +01:00
**Version incluse :** 1.5.0~ynh1
2022-01-10 15:18:34 +01:00
2022-01-10 15:18:41 +01:00
**Démo :** https://demo.example.com
2022-01-10 15:18:34 +01:00
2022-01-10 15:18:41 +01:00
## Captures d'écran
2022-01-10 15:18:34 +01:00
2022-01-10 15:25:33 +01:00
![](./doc/screenshots/screenshot.png)
2022-01-10 15:18:34 +01:00
## Avertissements / informations importantes
* Any known limitations, constrains or stuff not working, such as (but not limited to):
* requiring a full dedicated domain ?
* architectures not supported ?
* not-working single-sign on or LDAP integration ?
* the app requires an important amount of RAM / disk / .. to install or to work properly
* etc...
* Other infos that people should be aware of, such as:
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
* how to configure / administrate the application if it ain't obvious
* upgrade process / specificities / things to be aware of ?
* security considerations ?
## Documentations et ressources
2022-01-10 15:25:59 +01:00
* Site officiel de l'app : https://github.com/go-shiori/shiori
2022-01-10 15:25:33 +01:00
* Documentation officielle utilisateur : https://github.com/go-shiori/shiori/wiki/Usage
* Documentation officielle de l'admin : https://github.com/go-shiori/shiori/wiki
2022-01-10 15:18:41 +01:00
* Dépôt de code officiel de l'app : https://github.com/go-shiori/shiori
* Documentation YunoHost pour cette app : https://yunohost.org/app_shiori
* Signaler un bug : https://github.com/YunoHost-Apps/shiori_ynh/issues
2022-01-10 15:18:34 +01:00
## Informations pour les développeurs
2022-01-10 15:18:41 +01:00
Merci de faire vos pull request sur la [branche testing ](https://github.com/YunoHost-Apps/shiori_ynh/tree/testing ).
2022-01-10 15:18:34 +01:00
Pour essayer la branche testing, procédez comme suit.
```
2022-01-10 15:18:41 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/shiori_ynh/tree/testing --debug
ou
sudo yunohost app upgrade shiori -u https://github.com/YunoHost-Apps/shiori_ynh/tree/testing --debug
2022-01-10 15:18:34 +01:00
```
2022-01-10 15:18:41 +01:00
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps