Skip to content

Commit 5ea9f01

Browse files
authored
Update README.md
1 parent 7cc1dab commit 5ea9f01

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,13 @@ This software is an nginx HTTPS reverse proxy with support for Let's Encrypt. It
44

55
## Installation
66

7-
To start using this software, clone this repository and then run `docker-compose up`. Then, follow the instructions in the next two sections to get an HTTPS certificate set up and to configure the redirect for your domain.
7+
To start using this software, clone this repository and then run `docker-compose up`. Then, follow the instructions in the next two sections to get an HTTPS certificate set up and to configure the redirect for your domain. You must have Docker and docker-compose installed.
8+
9+
## Configuration
10+
11+
You will want to obtain the certificate from Let's Encrypt using the command above before adding your site's configuration.
12+
13+
To set up the HTTPS reverse proxy for your site, copy the [example configuration file](nginx-proxy/sites/enabled/.example.com) from `nginx-proxy/sites/enabled` to a new file in the same directory. Edit the certificate location to match your domain name.
814

915
## Obtaining new certificates from Let's Encrypt
1016
```
@@ -16,11 +22,18 @@ This command may be run on the host machine through `docker exec` as follows:
1622
docker exec -ti nginx-https-proxy_app_1 certbot certonly --webroot -w /var/www/letsencrypt/ -d example.com
1723
```
1824

19-
## Configuration
25+
The helper script `gen-cert.sh` will run the above command inside the nginx Docker container for you.
26+
```
27+
bash gen-cert.sh [domain name]
28+
```
2029

21-
You will want to obtain the certificate from Let's Encrypt using the command above before adding your site's configuration.
30+
## Creating a site configuration
2231

23-
To set up the HTTPS reverse proxy for your site, copy the [example configuration file](nginx-proxy/sites/enabled/.example.com) from `nginx-proxy/sites/enabled` to a new file in the same directory. Edit the certificate location to match your domain name.
32+
In `ngxin/sites-enabled`, copy `.example.com` into a new file, named to match the domain you would like to serve. Modify the contents of the example file to fit your domain.
33+
34+
## Launching the service
35+
36+
Running the service is as easy as `docker-compose up` (or `docker-compose up --build` if you recently changed the `sites-enabled` directory. You may also run `bash start.sh` to start the service for you.
2437

2538
## Notes
2639

0 commit comments

Comments
 (0)