From ac94d6b869f942ec05d7ef76840287a1d1f487f9 Mon Sep 17 00:00:00 2001 From: Jon Chambers Date: Thu, 22 Sep 2022 19:20:45 -0400 Subject: [PATCH] Add update instructions to the README --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c7cab1f..1d70bb2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Signal TLS Proxy -To run a Signal TLS proxy, you will need a host with a domain name that has ports 80 and 443 available. +To run a Signal TLS proxy, you will need a host that has ports 80 and 443 available and a domain name that points to that host. 1. Install docker and docker-compose (`apt update && apt install docker docker-compose`) 1. Ensure your current user has access to docker (`adduser $USER docker`) @@ -9,3 +9,13 @@ To run a Signal TLS proxy, you will need a host with a domain name that has port 1. `docker-compose up --detach` Your proxy is now running! You can share this with the URL `https://signal.tube/#` + +## Updating from a previous version + +If you've previously run a proxy, please update to the most recent version by pulling the most recent changes from `main`, then restarting your Docker containers: + +```shell +git pull +docker-compose down +docker-compose up --detach +```