reverseproxy_ynh/README.md

63 lines
3.3 KiB
Markdown
Raw Permalink 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.
-->
2023-01-08 14:33:31 +01:00
# Reverse Proxy for YunoHost
2021-01-23 15:21:17 +01:00
2023-01-08 14:33:31 +01:00
[![Integration level](https://dash.yunohost.org/integration/reverseproxy.svg)](https://dash.yunohost.org/appci/app/reverseproxy) ![Working status](https://ci-apps.yunohost.org/ci/badges/reverseproxy.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/reverseproxy.maintain.svg)
[![Install Reverse Proxy with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=reverseproxy)
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)*
2023-01-08 14:33:31 +01:00
> *This package allows you to install Reverse Proxy quickly and simply on a YunoHost server.
2021-06-04 16:26:21 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2023-01-08 14:33:31 +01:00
This application allows to configure a HTTP(S) reverse proxy to serve another web service, as well as an (optional) static assets directory to serve directly from nginx. The application appears as a tile in the SSOWat panel, unless configured otherwise after install. The access to the application can be made public.
2021-06-04 16:26:21 +02:00
2023-01-08 14:33:31 +01:00
The supported backends are:
2021-06-04 16:26:21 +02:00
2023-01-08 14:33:31 +01:00
- plaintext HTTP to localhost (127.x.x.x)
- HTTPS to any destination
- socket file on local disk
2021-06-04 16:26:21 +02:00
2023-01-08 14:33:31 +01:00
Please be aware that SSOWat sends user credentials in plaintext to the backend, so do not use this application to reverse-proxy a service you don't trust (for example to mirror a site hosted by someone else).
2022-08-16 23:30:29 +02:00
2016-06-20 23:43:51 +02:00
2023-01-08 14:33:31 +01:00
**Shipped version:** 0.1~ynh1
## Disclaimers / important information
2016-06-20 23:43:51 +02:00
2023-01-08 14:33:31 +01:00
### Backend web path
2016-06-20 23:43:51 +02:00
2023-01-08 14:33:31 +01:00
The request is transmitted as-is to the backend server. This usually means that the backend service shoudl be aware of the web path used to access the service. For example, if using the application is installed to `example.com/proxy`, your backend application should produce absolute links starting with `example.com/proxy/` too.
2023-01-08 14:33:31 +01:00
To support relative URLs from the backend, accessing the application via `http(s)://example.com/proxy` will permanent redirect (302) to `http(s)://example.com/proxy/` (trailing slash). Otherwise, a relative link like `<link rel="stylesheet" href="style.css">` would try to load `http(s)://example.com/style.css` which would fail.
2016-06-20 23:43:51 +02:00
2023-01-08 14:33:31 +01:00
It is possible that your backend service does not support setting up a "base URL" (custom web path). In that case, you will have to install the application on a dedicated (sub)domain.
2021-06-04 16:26:21 +02:00
2023-01-09 12:41:40 +01:00
### Plaintext localhost backend
Plaintext HTTP backend is only allowed on localhost. For now, only 127.X.X.X is allowed. 10.X.X.X should also be supported.
2021-06-04 16:26:21 +02:00
## Documentation and resources
2023-01-08 14:33:31 +01:00
* Official app website: <https://en.wikipedia.org/wiki/Reverse_proxy>
* YunoHost documentation for this app: <https://yunohost.org/app_reverseproxy>
* Report a bug: <https://github.com/YunoHost-Apps/reverseproxy_ynh/issues>
2021-06-04 16:26:21 +02:00
## Developer info
2023-01-08 14:33:31 +01:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/reverseproxy_ynh/tree/testing).
2021-06-04 16:26:21 +02:00
To try the testing branch, please proceed like that.
2022-06-05 16:08:00 +02:00
``` bash
2023-01-08 14:33:31 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/reverseproxy_ynh/tree/testing --debug
2021-06-04 16:26:21 +02:00
or
2023-01-08 14:33:31 +01:00
sudo yunohost app upgrade reverseproxy -u https://github.com/YunoHost-Apps/reverseproxy_ynh/tree/testing --debug
2021-06-04 16:26:21 +02:00
```
2022-06-05 16:08:00 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>