shaarli_ynh/README.md

# Shaarli app for Yunohost
---

This app intends to provide Yunohost's users with Shaarli (https://github.com/shaarli/Shaarli), a simple but advanced bookmarking service.

[![Integration level](https://dash.yunohost.org/integration/shaarli.svg)](https://dash.yunohost.org/appci/app/shaarli)  
[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=shaarli)

![UI](https://framapic.org/ui93xwvieFC5/bdLqopk0JqVv)
It is based on the community version of Shaarli (from @sebsauvage original software).
You can get a demo [here](https://shaarli.readthedocs.io/en/master/#demo).


Current version: **0.10.3**

Maintainer: @Lapineige

## This app claims following features

- [X] Install / remove scripts
- [X] Backup/restore scripts
- [X] Upgrade Script
- [X] Change url
- [X] Integrate fail2ban for the app

## Installation information

During the installation app will prompt you to install itself as public or private, if you choose public then anyone (not just Yunohost users) would be able to access your Shaarli instance.

After the installation is complete, go to the domain where the Shaarli is installed and create your account. After the creation of the account the registration will be locked.

## TODO/Limitations
    
- [ ] Integrate the LDAP/SSOWAT authentication (currently the authentication is done by Shaarli)


## Changelog

For Shaarli changelog, see: https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md

## Report a bug

https://github.com/YunoHost-Apps/shaarli_ynh/issues

#### Supported architectures

* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/shaarli%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/shaarli/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/shaarli%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/shaarli/)
* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/shaarli%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/shaarli/)
Minor readme tweaks 2018-07-20 19:16:09 +02:00			`# Shaarli app for Yunohost`
Fix Readme 2018-07-20 15:16:57 +02:00			`---`

Updated the package according to latest yunohost standards and app updated to version 0.10.3 2019-04-05 12:29:32 +02:00			`This app intends to provide Yunohost's users with Shaarli (https://github.com/shaarli/Shaarli), a simple but advanced bookmarking service.`
Initial commit 2013-12-15 02:03:35 +01:00
Updated the package according to latest yunohost standards and app updated to version 0.10.3 2019-04-05 12:29:32 +02:00			`[![Integration level](https://dash.yunohost.org/integration/shaarli.svg)](https://dash.yunohost.org/appci/app/shaarli)`
			`[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=shaarli)`
Update to 0.8.3 + fix typo 2017-02-19 23:13:28 +01:00
Minor readme tweaks 2018-07-20 19:16:09 +02:00			`![UI](https://framapic.org/ui93xwvieFC5/bdLqopk0JqVv)`
			`It is based on the community version of Shaarli (from @sebsauvage original software).`
			`You can get a demo [here](https://shaarli.readthedocs.io/en/master/#demo).`

Add "Install with Yunohost" button 2017-07-09 17:23:44 +02:00
Updated the package according to latest yunohost standards and app updated to version 0.10.3 2019-04-05 12:29:32 +02:00			`Current version: 0.10.3`
Update description with new app status 2016-11-28 23:16:05 +01:00
Updated readme 2018-06-25 07:39:55 +02:00			`Maintainer: @Lapineige`
Add Working features + TODO 2017-02-19 23:20:18 +01:00
Updated the package according to latest yunohost standards and app updated to version 0.10.3 2019-04-05 12:29:32 +02:00			`## This app claims following features`
Add Working features + TODO 2017-02-19 23:20:18 +01:00
Updated readme 2018-06-25 07:39:55 +02:00			`- [X] Install / remove scripts`
			`- [X] Backup/restore scripts`
			`- [X] Upgrade Script`
			`- [X] Change url`
Added logrotate,fail2ban 2018-09-27 22:44:34 +02:00			`- [X] Integrate fail2ban for the app`
Add Working features + TODO 2017-02-19 23:20:18 +01:00
Add the possibility of a private instance and update the README 2017-03-05 09:12:23 +01:00			`## Installation information`
Add Working features + TODO 2017-02-19 23:20:18 +01:00
Minor readme tweaks 2018-07-20 19:16:09 +02:00			`During the installation app will prompt you to install itself as public or private, if you choose public then anyone (not just Yunohost users) would be able to access your Shaarli instance.`
Fix Readme 2018-07-20 15:16:57 +02:00
Updated the package according to latest yunohost standards and app updated to version 0.10.3 2019-04-05 12:29:32 +02:00			`After the installation is complete, go to the domain where the Shaarli is installed and create your account. After the creation of the account the registration will be locked.`
Add the possibility of a private instance and update the README 2017-03-05 09:12:23 +01:00
Updated the package according to latest yunohost standards and app updated to version 0.10.3 2019-04-05 12:29:32 +02:00			`## TODO/Limitations`
Add the possibility of a private instance and update the README 2017-03-05 09:12:23 +01:00
Updated readme 2018-06-25 07:39:55 +02:00			`- [ ] Integrate the LDAP/SSOWAT authentication (currently the authentication is done by Shaarli)`
Added logrotate,fail2ban 2018-09-27 22:44:34 +02:00
Add changelog info 2017-02-19 23:36:03 +01:00
			`## Changelog`

			`For Shaarli changelog, see: https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md`
Update README.md 2017-06-17 16:45:18 +02:00
			`## Report a bug`

			`https://github.com/YunoHost-Apps/shaarli_ynh/issues`
Updated the package according to latest yunohost standards and app updated to version 0.10.3 2019-04-05 12:29:32 +02:00
			`#### Supported architectures`

			`* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/shaarli%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/shaarli/)`
			`* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/shaarli%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/shaarli/)`
			`* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/shaarli%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/shaarli/)`