Skip to content
This repository was archived by the owner on Jul 28, 2021. It is now read-only.

Commit 1e22be6

Browse files
committed
update readme, add small documentation
1 parent 7d5c1e9 commit 1e22be6

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
11
# letsencrypt-nginx-proxy
2-
reverse proxy with automated vHost and SSL-cert generation
2+
letsencrypt-nginx-proxy is based on [jwilder/nginx-proxy](https://github.com/jwilder/nginx-proxy/). It sets up a container running nginx and [docker-gen](https://github.com/jwilder/docker-gen).
3+
See [Automated Nginx Reverse Proxy for Docker](http://jasonwilder.com/blog/2014/03/25/automated-nginx-reverse-proxy-for-docker/) for why you might want to use this.
4+
In addition tothe functionality that [jwilder/nginx-proxy](https://github.com/jwilder/nginx-proxy/ ) offers (reverse proxy configs for nginx and reloads nginx when containers are started and stopped) we use with docker-gen to generate a SSL certificate from letsencrypt to secure the domain.
35

4-
- todo: add detailed description
6+
### Usage
7+
If you want to run it without SSL support, please have a look at the page for the [jwilder/nginx-proxy](https://github.com/jwilder/nginx-proxy/). That's what you're actually looking for.
8+
9+
To run it:
10+
11+
$ docker-compose up -d
12+
13+
That's about it already.
14+
15+
### Configuration
16+
If there's anything else you want to configure. Please also have a look at [jwilder/nginx-proxy](https://github.com/jwilder/nginx-proxy/). There you'll find more beautiful documentation on how to do more magic with this reverse proxy.

0 commit comments

Comments
 (0)