redirect_ynh/README.md

Redirect for YunoHost

Lire ce readme en français.

This package allows you to install Redirect quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

This application allows to integrate a custom tile in YunoHost's user portal. Typical use cases include:

• visible 301/302 redirect : having a "virtual" app tile that's just a redirection to another url or external website
• invisible redirect / reverse-proxy : creating an app tile for a local app listening on a specific port, or a Docker container, or an app hosted on another machine

In technical terms: this app only adds a NGINX configuration snippet with either redirect or proxy_pass rule, and a YunoHost tile + appropriate SSOwat configuration.

Shipped version: 1.0.2~ynh1

Documentation and resources

• Official app website: https://github.com/YunoHost-Apps/redirect_ynh
• YunoHost documentation for this app: https://yunohost.org/app_redirect
• Report a bug: https://github.com/YunoHost-Apps/redirect_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/redirect_ynh/tree/testing --debug
or
sudo yunohost app upgrade redirect -u https://github.com/YunoHost-Apps/redirect_ynh/tree/testing --debug

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