mirror of
https://github.com/YunoHost-Apps/shlink_ynh.git
synced 2024-09-03 20:16:22 +02:00
49 lines
2 KiB
Markdown
Executable file
49 lines
2 KiB
Markdown
Executable file
<!--
|
|
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
|
|
|
|
[](https://dash.yunohost.org/appci/app/shlink)  
|
|
|
|
[](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
|
|
|
|
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.4.0~ynh2
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## 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>
|