Fetch upstream

.env.sample

@@ -1,102 +1,146 @@
+#-----------------------------------------------------------------------
 #
-# docker-compose-letsencrypt-nginx-proxy-companion
+# https://github.com/evertramos/nginx-proxy-automation
 #
-# A Web Proxy using docker with NGINX and Let's Encrypt
-# Using the great community docker-gen, nginx-proxy and docker-letsencrypt-nginx-proxy-companion
+# NGINX Proxy automation
 #
-# This is the .env file to set up your webproxy environment
-
-#
-# Your local containers NAME
+# This is the .env file to set up nginx-proxy in your environment
 #
-NGINX_WEB=nginx-web
-DOCKER_GEN=nginx-gen
-LETS_ENCRYPT=nginx-letsencrypt
+#-----------------------------------------------------------------------
 
+#-----------------------------------------------------------------------
 #
-# Set the IP address of the external access Interface
+# Script requirements
 #
-IP=0.0.0.0
 
-#
-# Default Network
-#
-NETWORK=webproxy
+# PID file the running script
+PID_FILE=.fresh_start.pid
 
-# If you want to customize the created network, use the following variable
-#NETWORK_OPTIONS="--opt encrypted=true"
+# Allow run commands with sudo if needed
+ALLOW_RUN_WITH_SUDO=false
 
+#-----------------------------------------------------------------------
 #
-# Service Network (Optional)
+# NGINX-Proxy containers/service
 #
-# In case you decide to add a new network to your services containers you can set this
-# network as a SERVICE_NETWORK
+# The variables below is used to set the containers name for the nginx-proxy
+# and the image version for each service, please note that if you use our script
+# we will replace the service name in docker-compose file with the container name
 #
-# [WARNING] This setting was built to use our `start.sh` script or in that special case
-#           you could use the docker-composer with our multiple network option, as of:
-#           `docker-compose -f docker-compose-multiple-networks.yml up -d`
-#
-#SERVICE_NETWORK=webservices
+NGINX_WEB_SEVICE_NAME=proxy-web
+NGINX_IMAGE_VERSION=stable-alpine
 
-# If you want to customize the created network, use the following variable
-#SERVICE_NETWORK_OPTIONS="--opt encrypted=true"
+DOCKER_GEN_SEVICE_NAME=docker-gen
+DOCKER_GEN_IMAGE_VERSION=latest
 
-#
-## NGINX file path (mount into the host)
-# Here you can configure the path where nginx stores all the configurations and certificates.
-# With the value ./nginx-data it creates a new sub-folder into your current path.
+LETS_ENCRYPT_SEVICE_NAME=letsencrypt-companion
+NGINX_PROXY_COMPANION_IMAGE_VERSION=2.0
 
-NGINX_FILES_PATH=./nginx-data
+#-----------------------------------------------------------------------
+#
+# IP address of the external interface
+#
+# The IP address below is used to bind your local services to the internet
+# please make sure you use the correct address otherwise your proxy will not
+# work properly, '0.0.0.0' will work, but we recommend to update this variable
+#
+IPv4=0.0.0.0
+IPv6=::0
 
+#-----------------------------------------------------------------------
+#
+# Default network name
 #
-# NGINX use special conf files
+# The network name set below is used by the proxy to forward internet requests
+# to the correct containers in your environment, so please make sure to add this
+# network in all docker containers, otherwise it will break the proxy redirection
 #
-# In case you want to add some special configuration to your NGINX Web Proxy you could
-# add your files to ./conf.d/ folder as of sample file 'uploadsize.conf'
+NETWORK=proxy
+
+#-----------------------------------------------------------------------
 #
-# [WARNING] This setting was built to use our `start.sh`.
+# Data path for the nginx-proxy files
 #
-# [WARNING] Once you set this options to true all your files will be copied to data
-#           folder (./data/conf.d). If you decide to remove this special configuration
-#           you must delete your files from data folder ./data/conf.d.
+# The variable below will be used to place all files used by the nginx-proxy
+# please consider including this folder to your backup services, once all config
+# files, settings and certificates will be placed here in case you need to recover
 #
-#USE_NGINX_CONF_FILES=true
+NGINX_FILES_PATH=./data
 
+#-----------------------------------------------------------------------
 #
-# Docker Logging Config
+# Docker logging settings
 #
-# This section offers two options max-size and max-file, which follow the docker documentation
-# as follow:
+# Logs! Very important, right? But if you do not clean it up, it might causes you
+# issues on disk space over time, so keep in mind to set this log options making sure
+# you will have the least to audit, any further information on that please check the docs
 #
-# logging:
-#      driver: "json-file"
-#      options:
-#        max-size: "200k"
-#        max-file: "10"
+# https://docs.docker.com/config/containers/logging/configure/
 #
-#NGINX_WEB_LOG_DRIVER=json-file
-#NGINX_WEB_LOG_MAX_SIZE=4m
-#NGINX_WEB_LOG_MAX_FILE=10
+NGINX_WEB_LOG_DRIVER=json-file
+NGINX_WEB_LOG_MAX_SIZE=4m
+NGINX_WEB_LOG_MAX_FILE=10
 
-#NGINX_GEN_LOG_DRIVER=json-file
-#NGINX_GEN_LOG_MAX_SIZE=2m
-#NGINX_GEN_LOG_MAX_FILE=10
+NGINX_GEN_LOG_DRIVER=json-file
+NGINX_GEN_LOG_MAX_SIZE=2m
+NGINX_GEN_LOG_MAX_FILE=10
 
-#NGINX_LETSENCRYPT_LOG_DRIVER=json-file
-#NGINX_LETSENCRYPT_LOG_MAX_SIZE=2m
-#NGINX_LETSENCRYPT_LOG_MAX_FILE=10
+NGINX_LETSENCRYPT_LOG_DRIVER=json-file
+NGINX_LETSENCRYPT_LOG_MAX_SIZE=2m
+NGINX_LETSENCRYPT_LOG_MAX_FILE=10
 
+#-----------------------------------------------------------------------
 #
-# Set the local exposed ports for http and https on the Host
+# Docker ports that should be binded by the proxy
 #
-# NOTE: The default values are 80 and 443, only change this options if you really know what you are doing
+# This option were added by a contributor long ago, so might be a very specific case
+# where you might need to change http and https port number, keep in mind that changes
+# on that setting might will break the auto renewing Let's Encrypt certificate services
 #
-#DOCKER_HTTP=80
-#DOCKER_HTTPS=443
-
+DOCKER_HTTP_=80
+DOCKER_HTTPS=443
 
+#-----------------------------------------------------------------------
+#
+# SSL policy (defaults to Mozilla-Intermediate)
 #
-# Set the SSL policy (defaults to Mozilla-Intermediate).
-# See available options here: https://github.com/jwilder/nginx-proxy#how-ssl-support-works
+# This also was added by a contributor which sets the default cipher configuration
+# to the nginx-proxy container, which has the 'Mozilla-Intermediate' as default value
+# plase make sure you take a good look at options in the url below before messing around
+#
+# https://github.com/nginx-proxy/nginx-proxy#how-ssl-support-works
 #
 #SSL_POLICY=Mozilla-Modern
+
+#-----------------------------------------------------------------------
+#
+# Let's Encrypt default email
+#
+# You might want to inform a default email to Let's Encrypt certificate once it is
+# a required parameter in order to issue the new certificate. This information will be
+# replaced by the LETSENCRYPT_EMAIL environment varibale present in your docker container
+#
+DEFAULT_EMAIL=mail@yourdomain.tld
+
+#-----------------------------------------------------------------------
+#
+# Default host
+#
+# Nginx-proxy will then redirect all requests to a container where you have set
+# "VIRTUAL HOST" set to "DEFAULT HOST", if they don't match any (other) container
+# You might want to check the link below for more information:
+# https://github.com/nginx-proxy/nginx-proxy#default-host
+#
+DEFAULT_HOST=
+
+#-----------------------------------------------------------------------
+#
+# Docker Rootless
+#
+# In case you want to use this proxy on Docker Rootless (DR) and you also have followed
+# the DR installation from the official documentation (https://docs.docker.com/engine/security/rootless/)
+# Set the following value of the DOCKER_HOST variable that you got in the final info messages after executing
+# the "$ dockerd-rootless-setuptool.sh install" command.
+# For example DOCKER_HOST_PATH=$XDG_RUNTIME_DIR/docker.sock
+# If you are not using Docker Rootless, leave this variable blank
+DOCKER_HOST_ROOTLESS_PATH=

.github/CONTRIBUTING.md

@@ -1,9 +1,16 @@
-### Contributions
+## Contributions
 
-All contributions regarding the `nginx.tmpl` should be suggested or implemented in the [nginx-proxy repository](https://raw.githubusercontent.com/jwilder/nginx-proxy).
+### NGINX template file (nginx.tmpl)
+
+All contributions regarding the `nginx.tmpl` should be suggested or implemented in the [nginx-proxy repository](https://github.com/nginx-proxy/nginx-proxy).
 
 We always use the latest version of this file:
 
 [https://raw.githubusercontent.com/jwilder/nginx-proxy/master/nginx.tmpl](https://raw.githubusercontent.com/jwilder/nginx-proxy/master/nginx.tmpl)
 
+### Pull requests
+
+Sometimes it's better to start a discussion or an issue to find out the best solution of suggestion before sending a pull request... and if you do so, please test it with the automation script before sending new code.
+
+
 Thanks!

.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: evertramos
+open_collective: # nginx-proxy-automation
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
+

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,39 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: ''
+assignees: evertramos
+
+---
+
+**Check [Discussions](https://github.com/evertramos/nginx-proxy-automation/discussions) to see if there is an answer might help you before opening an issue**
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If the error is in one of the scripts, an screen show will help a lot to identify which part of the script the error occurred. 
+
+**Server info (please complete the following information):**
+ - Linux release: [e.g. Ubuntu 20.10]
+ - Server type [e.g. vps, Raspberry Pi]
+ - Docker version [e.g. 20.10]
+ - docker-compose version [e.g. 1.27]
+
+**Logs (please send some logs):**
+ - nginx container
+ - letsencrypt container (if related to ssl)
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: evertramos
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.