mirror of https://github.com/YunoHost-Apps/shiori_ynh.git synced 2024-09-03 20:26:17 +02:00

Shiori package for YunoHost

Find a file

ericgaspar 8df6b3a2a8 Merge branch 'db' of https://github.com/YunoHost-Apps/shiori_ynh into db		2022-01-12 10:22:41 +01:00
conf	Fix	2022-01-12 10:22:29 +01:00
doc	Fix	2022-01-12 10:18:27 +01:00
scripts	Fix	2022-01-12 10:18:27 +01:00
sources	First commit	2022-01-10 15:18:34 +01:00
check_process	Update check_process	2022-01-12 09:19:52 +01:00
LICENSE	Update LICENSE	2022-01-12 09:12:04 +01:00
manifest.json	Fix	2022-01-12 09:04:38 +01:00
README.md	Auto-update README	2022-01-12 09:18:39 +00:00
README_fr.md	Auto-update README	2022-01-12 09:18:39 +00:00

README.md

Shiori for YunoHost

Lire ce readme en français.

This package allows you to install Shiori quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide 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

The default account is shiori with password gopher. It is removed once another 'owner' account is created.

username: shiori
password: gopher

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.

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