mirror of
https://github.com/YunoHost-Apps/reverseproxy_ynh.git
synced 2024-09-03 20:16:23 +02:00
49 lines
2.3 KiB
Markdown
49 lines
2.3 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.
|
|
-->
|
|
|
|
# Reverse Proxy for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/reverseproxy)  
|
|
|
|
[](https://install-app.yunohost.org/?app=reverseproxy)
|
|
|
|
*[Read this README in other languages.](./ALL_README.md)*
|
|
|
|
> *This package allows you to install Reverse Proxy 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 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.
|
|
|
|
The supported backends are:
|
|
|
|
- plaintext HTTP to localhost (127.x.x.x)
|
|
- HTTPS to any destination
|
|
- socket file on local disk
|
|
|
|
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).
|
|
|
|
|
|
**Shipped version:** 0.2~ynh2
|
|
## Documentation and resources
|
|
|
|
- Official app website: <https://en.wikipedia.org/wiki/Reverse_proxy>
|
|
- YunoHost Store: <https://apps.yunohost.org/app/reverseproxy>
|
|
- Report a bug: <https://github.com/YunoHost-Apps/reverseproxy_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/reverseproxy_ynh/tree/testing).
|
|
|
|
To try the `testing` branch, please proceed like that:
|
|
|
|
```bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/reverseproxy_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade reverseproxy -u https://github.com/YunoHost-Apps/reverseproxy_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|