TecoRoute Proxy
TecoRoute Proxy is a reverse proxy server that allows easy authentication to the TecoRoute service web interface using a simple POST request. It also saves the credentials and automatically logs the user in when the TecoRoute session expires.
For more TecoRoute tools, see TecoRoute.
How it works
The server has one control endpoint (/TR_PROXY
by default) that is used
to log in and log out of the user from the proxy. All other requests are proxied
to TecoRoute. The proxy session is stored only in the user’s session cookies, so
the server is completely stateless and no database is required.
The control endpoint accepts POST
requests with
application/x-www-form-urlencoded
content type (HTML form).
Log the user in
The user logs in with the following data:
Name |
Value |
---|---|
|
|
|
TecoRoute username |
|
TecoRoute password |
|
TecoRoute PLC |
An example of a HTML form that logs the user in:
<form method="post" action="https://tecoroute-proxy.cze.tech/TR_PROXY">
<button name="action" value="login">Open PLC</button>
<input type="hidden" name="username" value="BroukPytlik" />
<input type="hidden" name="password" value="ferda1" />
<input type="hidden" name="plc" value="AB_1234" />
</form>
Log the user out
The user logs out with the following data:
Name |
Value |
---|---|
|
|
An example of a HTML form that logs the user out:
<form method="post" action="https://tecoroute-proxy.cze.tech/TR_PROXY">
<button name="action" value="logout">Logout from TecoRoute</button>
</form>
Logging out will try to log the user out from TecoRoute and delete the login data from the user’s cookies.
Command-line interface
The server starts with:
tecoroute-proxy
On an unprivileged port (e.g. 8080), the server starts with:
tecoroute-proxy --port 8080
For all options, run tecoroute-proxy --help
.
Library API
It is possible to use the package as a Python library. An example of usage:
from asyncio import ensure_future, get_event_loop
from logging import INFO, basicConfig
from tecoroute_proxy import ProxyServer
async def main():
server = ProxyServer(port=8080)
await server.start()
basicConfig(level=INFO)
ensure_future(main())
get_event_loop().run_forever()
See full documentation at https://tecoroute-proxy.readthedocs.io.
Installing
Install from PyPI
Requirements:
Installation using pip is done with:
pip install tecoroute-proxy
Run from Docker Hub
Run the image from Docker Hub:
docker run -p 80:80 czetech/tecoroute-proxy
Install to Kubernetes using Helm
Setup Helm repository:
helm repo add czetech https://charts.cze.tech/
Install Helm chart:
helm install tecoroute-proxy czetech/tecoroute-proxy \
--set ingress.enabled=true \
--set ingress.hosts[0]=<ingress-host>
see the chart for more options.
Use as a service
Server is deployed at https://tecoroute-proxy.cze.tech. The control URL is:
https://tecoroute-proxy.cze.tech/TR_PROXY
Feel free to use the service for testing or simple production purposes.
Support
Professional support by Czetech is available at hello@cze.tech.
Source code
The source code is available at https://github.com/czetech/tecoroute-proxy.