1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/shlink_ynh.git synced 2024-09-03 20:16:22 +02:00
This commit is contained in:
Éric Gaspar 2022-06-17 11:55:37 +02:00
commit 5d8d44e4a0
No known key found for this signature in database
GPG key ID: 574F281483054D44
2 changed files with 6 additions and 32 deletions

View file

@ -15,7 +15,9 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
## Overview
The definitive self-hosted URL shortener
Shlink is a self-hosted URL shortener which provides both a REST and a CLI interface to interact with it.
Additionally, there's also an official Shlink web client which, by making use of Shlink's REST API, provides a beautiful web UI to handle multiple Shlink instances.
**Shipped version:** 3.1.2~ynh1
@ -23,21 +25,6 @@ The definitive self-hosted URL shortener
![Screenshot of Shlink](./doc/screenshots/shlink-web-client-placeholder.jpg)
## 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://shlink.io/>

View file

@ -15,7 +15,9 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour
## Vue d'ensemble
The definitive self-hosted URL shortener
Shlink is a self-hosted URL shortener which provides both a REST and a CLI interface to interact with it.
Additionally, there's also an official Shlink web client which, by making use of Shlink's REST API, provides a beautiful web UI to handle multiple Shlink instances.
**Version incluse :** 3.1.2~ynh1
@ -23,21 +25,6 @@ The definitive self-hosted URL shortener
![Capture d'écran de Shlink](./doc/screenshots/shlink-web-client-placeholder.jpg)
## 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
* Site officiel de l'app : <https://shlink.io/>