Merge branch 'master' of github.com:evertramos/docker-compose-letsencrypt-nginx-proxy-companion

Author: evertramos

README.md

@@ -1,77 +1,38 @@
-# Usage of Docker Compose (docker-compose) with NGINX Proxy and Letsencrypt
+# A Web Proxy using Docker, NGINX and Let's Encrypt
 
-Docker Compose (docker-compose) for [docker-letsencrypt-nginx-proxy-companion](https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion)
+With this repo you will be able to set up your server with multiple sites using a single NGINX proxy to manage your connections.
 
+Something like:
 
-## Purpose
+![Proxy Enviornment](https://cdn-images-1.medium.com/max/873/1*rnzxfcy2N_ffJPnBundJQw.jpeg)
 
-This docker-compose file, version '3', was built to help using NGINX as web proxy to your containers, integrated with LetsEncrypt certification, using the great work of [@jwilder](https://github.com/jwilder) with [docker-gen](https://github.com/jwilder/docker-gen) and [nginx-proxy](https://github.com/jwilder/nginx-proxy) along with the ultimate tool [docker-letsencrypt-nginx-proxy-companion](https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion) designed by [JrCs](https://github.com/JrCs) to integrate the great SSL Certificates from the best [LetsEncrypt](https://letsencrypt.org/).
 
+## Why use it?
 
-## Usage
+Using this set up you will be able start a productyion enviornment in a few seconds. And to start new web project simply start new containers the option `-e VIRTUAL_HOST=your.domain.com` and will be ready to go, if you want to use SSL (Let's Encrypt) just add the tag `-e LETSENCRYPT_HOST=your.domain.com`. Done!
 
-In order to use, you must follow these steps:
+Easy and trustworthy!
 
-1. Clone this repository:
 
-```bash
-git clone https://github.com/evertramos/webproxy.git
-```
+## Prerequisites
+
+In order to use this compose file (docker-compose.yml) you must have:
 
-Or just copy the content of `docker-compose.yml`, as of below and substitute with your own configuration settings:
+1. docker (https://docs.docker.com/engine/installation/)
+2. docker-compose (https://docs.docker.com/compose/install/)
+
+
+## How to use it
+
+1. Clone this repository:
 
 ```bash
-version: '3'
-services:
-  nginx:
-    image: nginx
-    labels:
-        com.github.jrcs.letsencrypt_nginx_proxy_companion.nginx_proxy: "true"
-    container_name: ${NGINX_WEB}
-    restart: unless-stopped
-    ports:
-      - "${IP}:80:80"
-      - "${IP}:443:443"
-    volumes:
-      - ${NGINX_FILES_PATH}/conf.d:/etc/nginx/conf.d
-      - ${NGINX_FILES_PATH}/vhost.d:/etc/nginx/vhost.d
-      - ${NGINX_FILES_PATH}/html:/usr/share/nginx/html
-      - ${NGINX_FILES_PATH}/certs:/etc/nginx/certs:ro
-
-  nginx-gen:
-    image: jwilder/docker-gen
-    command: -notify-sighup nginx -watch -wait 5s:30s /etc/docker-gen/templates/nginx.tmpl /etc/nginx/conf.d/default.conf
-    container_name: ${DOCKER_GEN}
-    restart: unless-stopped
-    volumes:
-      - ${NGINX_FILES_PATH}/conf.d:/etc/nginx/conf.d
-      - ${NGINX_FILES_PATH}/vhost.d:/etc/nginx/vhost.d
-      - ${NGINX_FILES_PATH}/html:/usr/share/nginx/html
-      - ${NGINX_FILES_PATH}/certs:/etc/nginx/certs:ro
-      - /var/run/docker.sock:/tmp/docker.sock:ro
-      - ./nginx.tmpl:/etc/docker-gen/templates/nginx.tmpl:ro
-
-  nginx-letsencrypt:
-    image: jrcs/letsencrypt-nginx-proxy-companion
-    container_name: ${LETS_ENCRYPT}
-    restart: unless-stopped
-    volumes:
-      - ${NGINX_FILES_PATH}/conf.d:/etc/nginx/conf.d
-      - ${NGINX_FILES_PATH}/vhost.d:/etc/nginx/vhost.d
-      - ${NGINX_FILES_PATH}/html:/usr/share/nginx/html
-      - ${NGINX_FILES_PATH}/certs:/etc/nginx/certs:rw
-      - /var/run/docker.sock:/var/run/docker.sock:ro
-    environment:
-      NGINX_DOCKER_GEN_CONTAINER: ${DOCKER_GEN}
-      NGINX_PROXY_CONTAINER: ${NGINX_WEB}
-
-networks:
-  default:
-    external:
-      name: ${NETWORK}
+git clone https://github.com/evertramos/docker-compose-letsencrypt-nginx-proxy-companion.git
 ```
 
-2. Create an `.env` file as of our `.env.sample`, save it in the same folder as your compose file:
+2. Make a copy of our `.env.sample` and rename it to `.env`:
+
+Update this file with your preferences.
 
 ```
 #
@@ -105,9 +66,16 @@ NGINX_FILES_PATH=/path/to/your/nginx/data
 
 Your proxy is ready to go!
 
+5. Test your proxy
+
+```bash
+ docker run -dit -e VIRTUAL_HOST=your.domain.com --network=webproxy --name test-web httpd:alpine
+```
+
+And access your browser with your domain already configured in your dns.
 
-> Please note that when running a new container to generate certificates with LetsEncrypt it may take a few minutes, depending on multiples circunstances.
 
+> Please note that when running a new container to generate certificates with LetsEncrypt (`-e LETSENCRYPT_HOST=your.domain.com`), it may take a few minutes, depending on multiples circunstances.
 
 
 ## Next Step