1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/shlink_ynh.git synced 2024-09-03 20:16:22 +02:00
shlink_ynh/README.md
2022-06-17 09:46:42 +00:00

2.5 KiB
Executable file

Shlink for YunoHost

Integration level Working status Maintenance status
Install Shlink with YunoHost

Lire ce readme en français.

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

The definitive self-hosted URL shortener

Shipped version: 3.1.2~ynh1

Screenshots

Screenshot of Shlink

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

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