fix: rename env variables, fix nginx configuring

Author: iconben

Dockerfile

@@ -4,9 +4,9 @@ ARG PHP_VERSION=7.4.33
 FROM php:$PHP_VERSION-fpm-$DEBIAN_VERSION
 
 # Add environment variables for domain and port
-ENV SERVER_NAME="localhost"
-ENV SSL_ENABLED="false"
-ENV CERTBOT_ENABLED="true"
+ENV DOMAIN_NAME="localhost"
+ENV HTTPS_ENABLED="false"
+ENV LETSENCRYPT_ENABLED="true"
 
 ENV WP_DB_HOST="hub.docker.internal"
 ENV WP_DB_USER="wordpress"
@@ -139,6 +139,8 @@ COPY ./nginx/options-ssl-nginx.conf /etc/nginx/ssl/options-ssl-nginx.conf
 RUN openssl dhparam -out /etc/nginx/ssl/ssl-dhparams.pem 2048
 # Create a directory for SSL certificates when certbot is disabled
 RUN mkdir "/var/ssl";
+# Remove the default Nginx configuration file, later we will generate new one
+RUN rm -f /etc/nginx/conf.d/default.conf
 
 # Expose the default Nginx ports
 EXPOSE 80

README.md

@@ -75,7 +75,7 @@ services:
             - ./mysql/data:/var/lib/mysql
 ```
 
-The default port is 80. If you want to support HTTPS, you can set the environment variable SERVER_NAME, SSL_ENABLED to true, and publish the 443 port.
+The default port is 80. If you want to support HTTPS, you can set the environment variable DOMAIN_NAME, HTTPS_ENABLED to true, and publish the 443 port.
 
 Below is the example, to set HTTPS for domain name "example.com", so you can visit https://example.com.
 
@@ -88,9 +88,9 @@ services:
             - 80:80
             - 443:443
         environment:
-            - SERVER_NAME=example.com
-            - SSL_ENABLED=true
-            - CERTBOT_ENABLED=true
+            - DOMAIN_NAME=example.com
+            - HTTPS_ENABLED=true
+            - LETSENCRYPT_ENABLED=true
             - WP_DB_HOST=db
             - WP_DB_USER=wordpress
             - WP_DB_PASSWORD=password
@@ -112,9 +112,9 @@ services:
             - ./mysql/data:/var/lib/mysql
 ```
 
-Note that we use letsencrypt's certbot to generate SSL certificates for you, you need to prove the domain is controlled by you, in most case your domain name should already resolved to the host you run this container, otherwise the certbot will fail, and the container will not be able to serve.
+Note that we use letsencrypt to generate SSL certificates for you, you need to prove the domain is controlled by you, in most case your domain name should already resolved to the host you run this container, otherwise the certbot will fail to generate certificate, the website will only serve on 80 port.
 
-However, if you want to use your own certificate or if your environment does not support certbot to automatically generate certificate, you can set CERTBOT_ENABLED to false, and mount a volumn to /var/ssl, then put your own fullchain.pem and privkey.pem to this folder.
+However, if you want to use your own certificate or if your environment does not support letsencrypt to automatically generate certificate, you can set LETSENCRYPT_ENABLED to false, and mount a volumn to /var/ssl, then put your own fullchain.pem and privkey.pem to this folder. The website will not serve before the two files are properly placed.
 
 ## Develop
 Feel free to visit the repository site on Github: [https://github.com/augwit/wordpress/](https://github.com/augwit/wordpress/)

entrypoint.sh

@@ -1,20 +1,20 @@
 #!/bin/bash
 
-if [ -z "$(ls -A /etc/nginx/conf.d)" ]; then
+if [ ! -f /etc/nginx/conf.d/default.conf ]; then
     cp /usr/src/nginx-defaults/default.conf /etc/nginx/conf.d/;
     cp /usr/src/nginx-defaults/wordpress.conf.include /etc/nginx/conf.d/wordpress.conf.include
 
     # Update entrypoint to configure Nginx and configure SSL certificates
-    sed -i "s/server_name localhost;/server_name $SERVER_NAME;/" /etc/nginx/conf.d/default.conf
+    sed -i "s/server_name localhost;/server_name $DOMAIN_NAME;/" /etc/nginx/conf.d/default.conf
 
     # If SSL is enabled and Certbot is not enabled, copy the default SSL configuration
-    if [ "$SSL_ENABLED" = "true" ] && [ "$CERTBOT_ENABLED" = "false" ]; then 
+    if [ "$HTTPS_ENABLED" = "true" ] && [ "$LETSENCRYPT_ENABLED" = "false" ]; then 
         cp /usr/src/nginx-defaults/default_ssl.conf /etc/nginx/conf.d/;
     fi
 
     # If SSL is enabled and Certbot is enabled, run Certbot to obtain SSL certificates
-    if [ "$SSL_ENABLED" = "true" ] && [ "$CERTBOT_ENABLED" = "true" ]; then
-        certbot --nginx -d $SERVER_NAME --non-interactive --agree-tos --register-unsafely-without-email -m admin@$SERVER_NAME
+    if [ "$HTTPS_ENABLED" = "true" ] && [ "$LETSENCRYPT_ENABLED" = "true" ]; then
+        certbot --nginx -d $DOMAIN_NAME --non-interactive --agree-tos --register-unsafely-without-email -m admin@$DOMAIN_NAME
         # cerrtbot started nginx but we need to stop it for now. Later we will start it in the foreground.
         service nginx stop
     fi

tests/docker-compose.yml

@@ -5,6 +5,9 @@ services:
         ports:
             - 80:80
         environment:
+            - DOMAIN_NAME=localhost
+            - HTTPS_ENABLED=true
+            - LETSENCRYPT_ENABLED=true
             - WP_DB_HOST=db
             - WP_DB_USER=wordpress
             - WP_DB_PASSWORD=password