mirror of
https://github.com/YunoHost-Apps/redirect_ynh.git
synced 2024-09-03 20:16:10 +02:00
45 lines
2.1 KiB
Markdown
45 lines
2.1 KiB
Markdown
<!--
|
|
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.
|
|
-->
|
|
|
|
# Redirect for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/redirect)  
|
|
|
|
[](https://install-app.yunohost.org/?app=redirect)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install Redirect 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
|
|
|
|
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 Store: <https://apps.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](https://github.com/YunoHost-Apps/redirect_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
``` bash
|
|
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>
|