YunoHost-Apps/reverseproxy_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/reverseproxy_ynh.git synced 2024-09-03 20:16:23 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
WIP fork of redirect_ynh
52 commits 6 branches 0 tags 198 KiB
Shell 100%
Find a file
Yunohost-Bot 28970db89b Auto-update README
2021-08-29 15:25:38 +00:00
.github Add templates 2021-06-04 16:26:13 +02:00
conf Add X-Forwarded-Port header 2017-06-15 16:38:09 +02:00
doc Rewite DISCLAIMER, split into DISCLAIMER + DESCRIPTION 2021-08-29 17:25:07 +02:00
scripts Update upgrade 2021-08-22 09:01:11 +02:00
check_process Merge branch 'testing' into enh-testing 2021-06-05 19:16:11 +02:00
LICENSE Add AGPL3+ licence and improve manifest 2018-05-26 10:27:44 +02:00
manifest.json Fix 2021-08-22 08:58:18 +02:00
README.md Auto-update README 2021-08-29 15:25:38 +00:00
README_fr.md Auto-update README 2021-08-29 15:25:38 +00:00

README.md

Redirect for YunoHost

Integration level
Install Redirect with 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.0~ynh5

Disclaimers / important information

Redirect type

Visible redirect

The client will be redirected to another url or external website

  • your-domain.com -> another-domain.net
  • your-domain.com/foo -> another-domain.net/bar

Invisible redirect (a.k.a "reverse-proxy")

Visitor's address bar will remain the same. Typically used to integrate into YunoHost a manually-installed app into the portal.

  • you-domain.com/foo -> http://172.0.0.1:8080/app

IMPORTANT: you may have to further tweak the redirect.conf in the nginx configuration, depending on your needs!

IMPORTANT: Many apps do not support being redirected to a different path due to relative links! This means that some apps being hosted for example on http://127.0.0.1:5050/app/ MUST be redirected to http://domain.tld/app/ and NOT http://domain.tld/someotherapp/. For example : an Odoo Docker container runs on http://127.0.0.1:8069/. You will not be able to redirect it to http://domain.tld/odoo/ ! You have to redirect it to the root, so for example http://odoo.domain.tld/

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/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