Skip to content

Commit 27bf0c5

Browse files
authored
Update README.md
1 parent 4fd4070 commit 27bf0c5

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ simple-tls-proxy is an Nginx-based TLS reverse proxy container with modern TLS s
44

55
It can can be placed in front of an existing HTTP website to enable HTTPS functionality with, hopefully, minimal hassle. You can think of it as a (limited) TLS terminator. You are free to change the configuration to better suit your needs, of course.
66

7+
![Network architecture overview](/images/architecture.png)
8+
79
We provide two Terraform configurations that will automatically create the required cloud infrastructure and deploy the TLS reverse proxy. This way, you can easily try out the TLS configurations on AWS or GCP.
810

911
We also detail the manual steps required to run the examples on a stand-alone virtual machine. This assumes that the VM has an assigned public IP, and is reachable on ports 80 and 443. 
@@ -34,8 +36,8 @@ With the exception of the stand-alone example, familiarity with AWS or GCP is re
3436
## Requirements
3537

3638
This setup needs a dedicated virtual machine with the following requirements:
37-
* Docker;
38-
* Docker Compose;
39+
* [Docker](https://docs.docker.com/engine/installation/);
40+
* [Docker Compose](https://docs.docker.com/compose/install/);
3941
* Systemd (available in most Linux distributions);
4042
* Public IP;
4143
* Public DNS hostname, pointing to the IP above;
@@ -77,10 +79,10 @@ If everything is configured correctly, you should see Let's Encrypt log entries
7779

7880
## Requirements
7981

80-
* A working AWS account;
81-
* Install the AWS Command Line Interface (CLI);
82-
* Configure the AWS CLI;
83-
* Install Terraform.
82+
* A working AWS [account](https://docs.docker.com/compose/install/);
83+
* [Install](https://docs.aws.amazon.com/cli/latest/userguide/installing.html) the AWS Command Line Interface (CLI);
84+
* [Configure](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) the AWS CLI;
85+
* Install [Terraform](https://www.terraform.io/intro/getting-started/install.html).
8486

8587
## Procedure
8688

@@ -138,10 +140,10 @@ sudo journalctl -fu tls-proxy
138140
# Google Cloud Platform deployment
139141

140142
## Requirements
141-
* A working GCP account;
142-
* Install the Google Cloud SDK;
143-
* Configure the Google Cloud SDK;
144-
* Install Terraform.
143+
* A working GCP [account](https://console.cloud.google.com);
144+
* [Install](https://cloud.google.com/sdk/install) the Google Cloud SDK;
145+
* [Configure](https://cloud.google.com/sdk/docs/initializing) the Google Cloud SDK;
146+
* Install [Terraform](https://www.terraform.io/intro/getting-started/install.html).
145147

146148
## Procedure
147149

0 commit comments

Comments
 (0)