From 46af86f8ace136dd1d1d94590d3423e6b12e3f7b Mon Sep 17 00:00:00 2001 From: Tom van der Lee Date: Thu, 30 Dec 2021 10:16:41 +0100 Subject: Prepare for github --- README.rst | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.rst (limited to 'README.rst') diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..8688b23 --- /dev/null +++ b/README.rst @@ -0,0 +1,41 @@ +=========== +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= -e SECURE= 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 | | ++----------------+-----------------------------------------------------------------------------------------------------------------+--------------+ + +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 -- cgit v1.2.3