shlink_ynh/README.md

<!--
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.
-->

# Shlink for YunoHost

[![Integration level](https://dash.yunohost.org/integration/shlink.svg)](https://dash.yunohost.org/appci/app/shlink) ![Working status](https://ci-apps.yunohost.org/ci/badges/shlink.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/shlink.maintain.svg)  
[![Install Shlink with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=shlink)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install Shlink 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

The definitive self-hosted URL shortener

**Shipped version:** 3.1.2~ynh1

## Screenshots

![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/>
* Official user documentation: <https://shlink.io/documentation/>
* Upstream app code repository: <https://github.com/shlinkio/shlink>
* YunoHost documentation for this app: <https://yunohost.org/app_shlink>
* Report a bug: <https://github.com/YunoHost-Apps/shlink_ynh/issues>

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/shlink_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/shlink_ynh/tree/testing --debug
or
sudo yunohost app upgrade shlink -u https://github.com/YunoHost-Apps/shlink_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>