mirror of
https://github.com/YunoHost-Apps/shiori_ynh.git
synced 2024-09-03 20:26:17 +02:00
75 lines
No EOL
3.3 KiB
Markdown
75 lines
No EOL
3.3 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.
|
|
-->
|
|
|
|
# Shiori for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/shiori)  
|
|
[](https://install-app.yunohost.org/?app=shiori)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install Shiori 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
|
|
|
|
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.
|
|
|
|
### Features
|
|
|
|
- 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.
|
|
|
|
|
|
|
|
**Shipped version:** 1.5.0~ynh1
|
|
|
|
**Demo:** https://demo.example.com
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
* 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 ?
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: https://github.com/go-shiori/shiori
|
|
* Official user documentation: https://github.com/go-shiori/shiori/wiki/Usage
|
|
* Official admin documentation: https://github.com/go-shiori/shiori/wiki
|
|
* Upstream app code repository: https://github.com/go-shiori/shiori
|
|
* YunoHost documentation for this app: https://yunohost.org/app_shiori
|
|
* Report a bug: https://github.com/YunoHost-Apps/shiori_ynh/issues
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/shiori_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
```
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/shiori_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade shiori -u https://github.com/YunoHost-Apps/shiori_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps |