You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-4Lines changed: 17 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,13 @@ This software is an nginx HTTPS reverse proxy with support for Let's Encrypt. It
4
4
5
5
## Installation
6
6
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.
8
14
9
15
## Obtaining new certificates from Let's Encrypt
10
16
```
@@ -16,11 +22,18 @@ This command may be run on the host machine through `docker exec` as follows:
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
+
```
20
29
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
22
31
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.
0 commit comments