1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/redirect_ynh.git synced 2024-09-03 20:16:10 +02:00
redirect_ynh/README.md

46 lines
2.1 KiB
Markdown
Raw Normal View History

2021-06-04 16:26:21 +02:00
<!--
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
2021-01-23 15:21:17 +01:00
2023-09-26 21:24:23 +02:00
[![Integration level](https://dash.yunohost.org/integration/redirect.svg)](https://dash.yunohost.org/appci/app/redirect) ![Working status](https://ci-apps.yunohost.org/ci/badges/redirect.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/redirect.maintain.svg)
2021-01-23 15:21:17 +01:00
[![Install Redirect with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=redirect)
2016-06-20 23:43:51 +02:00
2021-06-04 16:26:21 +02:00
*[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
2021-08-29 17:25:38 +02:00
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
2021-06-04 16:26:21 +02:00
2021-08-29 17:25:38 +02:00
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.
2021-06-04 16:26:21 +02:00
2023-12-05 00:55:05 +01:00
**Shipped version:** 2.0~ynh1
2021-06-04 16:26:21 +02:00
## Documentation and resources
2023-12-05 01:08:20 +01:00
* Official app website: <https://en.wikipedia.org/wiki/Reverse_proxy>
2023-11-02 23:27:19 +01:00
* YunoHost Store: <https://apps.yunohost.org/app/redirect>
2022-06-05 16:08:00 +02:00
* Report a bug: <https://github.com/YunoHost-Apps/redirect_ynh/issues>
2021-06-04 16:26:21 +02:00
## 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.
2022-06-05 16:08:00 +02:00
``` bash
2021-06-04 16:26:21 +02:00
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
```
2022-06-05 16:08:00 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>