YunoHost-Apps/shaarli_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/shaarli_ynh.git synced 2024-09-03 20:26:10 +02:00
Code Issues Activity Actions

Updated readme

Browse source
This commit is contained in:
anmol26s 2018-06-25 11:09:55 +05:30 committed by GitHub
parent f1a528a49d
commit 6cc13093c0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
README.md
View file

@ -1,43 +1,32 @@
shaarli_ynh - Shaarli app for Yunohost
===========
# Shaarli app for Yunohost
[![Integration level](https://dash.yunohost.org/integration/shaarli.svg)](https://ci-apps.yunohost.org/jenkins/job/shaarli%20%28Community%29/lastBuild/consoleFull)
[![Install Shaarli with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=shaarli)
Current version: **0.9.7**
This app intends to provide to Yunohost's users Shaarli (https://github.com/shaarli/Shaarli), a simple but advanced bookmarking service.
It is based on the community version of Shaarli (from @sebsauvage original software).
Current version: **0.9.7**
Maintainer: @Lapineige
[![Install Shaarli with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=shaarli)
**Work In Progress** - the packaging is usable and almost complete, but need more tests.
Please backup your data (with export + yunohost backup) before updating the app.
NB: see https://github.com/YunoHost-Apps/shaarli_ynh/tree/v0.0.41beta if you need a very stable (but old) version.
Related topic on Yunohost's forum: https://forum.yunohost.org/t/fr-en-shaarli-app-lets-remove-the-dust/2200/
Help for dev/testing hightly appreciated :)
## Current features
* Install / remove scripts
* Backup/restore scripts
* Adding / removing a link
* Upgrade *not tested*
* Configure Shaarli during installation
- [X] Install / remove scripts
- [X] Backup/restore scripts
- [X] Upgrade Script
- [X] Change url
## Installation information
When doing the installation you will be prompted if you want to have a public site, meaning that you don't have to be a user of this Yunohost instance to access the site.
You will also be asked if you want to have a private instance, meaning that the authentication will be deactivated and the application will be only available to the owner designed during install.
After the installation go to the domain and create your account. After the creation of the account the registration will be locked.
## TODO
* Integrate the ssowat authentication (currently the authentication is done by Shaarli)
* Add upgrade script
* Refactoring of the code
* Add change_url
- [ ] Integrate the LDAP/SSOWAT authentication (currently the authentication is done by Shaarli)
- [ ] Integrate fail2ban for the app
## Changelog