README.md

Shlink for YunoHost

Read this README in other languages.

This package allows you to install Shlink quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide 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: 4.4.2~ynh1

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 Store: https://apps.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.

To try the testing branch, please proceed like that:

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