blob: eba076a5f9ba96dc3a59fb17eb375c066069220e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
===========
TTUN Server
===========
|Release|
.. |Release| image:: https://github.com/tomvanderlee/ttun-server/actions/workflows/docker-image.yml/badge.svg
:target: https://github.com/tomvanderlee/ttun-server/actions/workflows/docker-image.yml
The self-hostable proxy tunnel.
Running
-------
Running::
docker run -e TUNNEL_DOMAIN=<Your tunnel domain> -e SECURE=<True if using SSL> ghcr.io/tomvanderlee/ttun-server:latest
Environment variables:
+----------------+--------------------------------------------------------------------------------------------------------------------------+--------------+
| Variable | Description | Valid Value |
+================+==========================================================================================================================+==============+
| TUNNEL_DOMAIN | The domain your tunnel server is hosted on. Any individual tunnels will be hosted as a subdomain of this one. | FQDN |
+----------------+--------------------------------------------------------------------------------------------------------------------------+--------------+
| SECURE | Set this value to True if you are hosting the tunnel with SSL. If not leave this variable out | |
+----------------+--------------------------------------------------------------------------------------------------------------------------+--------------+
| REDIS_URL | [OPTIONAL] Adding a redis url allows to scale this application and loadbalance the connection between multiple instances | |
+----------------+--------------------------------------------------------------------------------------------------------------------------+--------------+
Developing
----------
1. Create and activate a python 3.10 virtual environment
2. Install requirements::
pip install -r requirements.txt
3. Run::
uvicorn ttun_server:server --reload
|
