Skip to content

Commit

Permalink
Fix NGINX failing to start when IPv6 is not available
Browse files Browse the repository at this point in the history
This is a regression introduced in #427.

The original NGINX image has a mechanism to enable IPv6 when it's available: https://github.com/nginxinc/docker-nginx-unprivileged/blob/1.25.2/entrypoint/10-listen-on-ipv6-by-default.sh

 However, that mechanism is disabled when the `default.conf` file was modified (which we did).

 This commit copies the entrypoint script from the base image, and modifies it, to make it work with our custom `default.conf`.

 Fixes #427 (comment)

Signed-off-by: nscuro <[email protected]>
  • Loading branch information
nscuro committed Oct 23, 2023
1 parent d3f72e2 commit 546d01c
Show file tree
Hide file tree
Showing 5 changed files with 77 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ node_modules/
release.sh
snapshot.sh
!docker/etc/nginx/conf.d/default.conf
!docker/docker-entrypoint.sh
!docker/docker-entrypoint.d/*.sh
2 changes: 1 addition & 1 deletion docker/Dockerfile.alpine
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ USER 101

# Setup entrypoint
COPY --chown=101:0 ./docker/etc/nginx/conf.d/default.conf /etc/nginx/conf.d/default.conf
COPY ./docker/docker-entrypoint.sh /docker-entrypoint.d/30-oidc-configuration.sh
COPY --chmod=755 ./docker/docker-entrypoint.d/ /docker-entrypoint.d/

# Specify the container working directory
WORKDIR ${APP_DIR}
Expand Down
75 changes: 75 additions & 0 deletions docker/docker-entrypoint.d/10-listen-on-ipv6-by-default.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
#!/bin/sh
# vim:sw=4:ts=4:et

# Copied and modified from:
# https://github.com/nginxinc/docker-nginx-unprivileged/blob/1.25.2/entrypoint/10-listen-on-ipv6-by-default.sh

set -e

entrypoint_log() {
if [ -z "${NGINX_ENTRYPOINT_QUIET_LOGS:-}" ]; then
echo "$@"
fi
}

ME=$(basename $0)
DEFAULT_CONF_FILE="etc/nginx/conf.d/default.conf"

# check if we have ipv6 available
if [ ! -f "/proc/net/if_inet6" ]; then
entrypoint_log "$ME: info: ipv6 not available"
exit 0
fi

if [ ! -f "/$DEFAULT_CONF_FILE" ]; then
entrypoint_log "$ME: info: /$DEFAULT_CONF_FILE is not a file or does not exist"
exit 0
fi

# check if the file can be modified, e.g. not on a r/o filesystem
touch /$DEFAULT_CONF_FILE 2>/dev/null || { entrypoint_log "$ME: info: can not modify /$DEFAULT_CONF_FILE (read-only file system?)"; exit 0; }

# check if the file is already modified, e.g. on a container restart
grep -q "listen \[::]\:8080;" /$DEFAULT_CONF_FILE && { entrypoint_log "$ME: info: IPv6 listen already enabled"; exit 0; }

if [ -f "/etc/os-release" ]; then
. /etc/os-release
else
entrypoint_log "$ME: info: can not guess the operating system"
exit 0
fi

# Modified from original by nscuro:
# Do not check whether the default configuration file has been changed vs
# what is packaged with the distribution's installation. We customized the
# file and want the changes the applied regardless.

#entrypoint_log "$ME: info: Getting the checksum of /$DEFAULT_CONF_FILE"
#
#case "$ID" in
# "debian")
# CHECKSUM=$(dpkg-query --show --showformat='${Conffiles}\n' nginx | grep $DEFAULT_CONF_FILE | cut -d' ' -f 3)
# echo "$CHECKSUM /$DEFAULT_CONF_FILE" | md5sum -c - >/dev/null 2>&1 || {
# entrypoint_log "$ME: info: /$DEFAULT_CONF_FILE differs from the packaged version"
# exit 0
# }
# ;;
# "alpine")
# CHECKSUM=$(apk manifest nginx 2>/dev/null| grep $DEFAULT_CONF_FILE | cut -d' ' -f 1 | cut -d ':' -f 2)
# echo "$CHECKSUM /$DEFAULT_CONF_FILE" | sha1sum -c - >/dev/null 2>&1 || {
# entrypoint_log "$ME: info: /$DEFAULT_CONF_FILE differs from the packaged version"
# exit 0
# }
# ;;
# *)
# entrypoint_log "$ME: info: Unsupported distribution"
# exit 0
# ;;
#esac

# enable ipv6 on default.conf listen sockets
sed -i -E 's,listen 8080;,listen 8080;\n listen [::]:8080;,' /$DEFAULT_CONF_FILE

entrypoint_log "$ME: info: Enabled listen on IPv6 in /$DEFAULT_CONF_FILE"

exit 0
File renamed without changes.
1 change: 0 additions & 1 deletion docker/etc/nginx/conf.d/default.conf
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
server {
listen 8080;
listen [::]:8080;
server_name _;

location / {
Expand Down

0 comments on commit 546d01c

Please sign in to comment.