Add update instructions to the README

This commit is contained in:
Jon Chambers 2022-09-22 19:20:45 -04:00
parent 7d03721445
commit ac94d6b869
1 changed files with 11 additions and 1 deletions

View File

@ -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/#<your_host_name>`
## 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
```