Skip to content

update #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 195 commits into from
Nov 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
195 commits
Select commit Hold shift + click to select a range
5d10467
fix: set worker_rlimit_nofile to (worker_connections x 2)
buchdag Feb 10, 2024
af56ba2
Merge pull request #2387 from nginx-proxy/1780
buchdag Feb 10, 2024
40a347b
fix: add non standard port to Host header
buchdag Feb 10, 2024
df890de
Merge pull request #2388 from nginx-proxy/2386
buchdag Feb 10, 2024
fa23c11
feat: define basic auth for virtual path
jmformenti Feb 10, 2024
e50429e
Merge pull request #2389 from nginx-proxy/2300
buchdag Feb 10, 2024
de9809a
Add more control over log_format config directive
darh Mar 14, 2023
8aefce9
tests: fix the json log test compose files
buchdag Feb 10, 2024
76778ce
refactor: parse LOG_JSON as boolean + avoid unnecessary backticks
buchdag Feb 10, 2024
62f55b4
docs: add logging documentation
buchdag Feb 10, 2024
25883ac
style: remove extra blank lines
buchdag Feb 10, 2024
f47c874
Merge pull request #2197 from darh/json_log_format
buchdag Feb 10, 2024
3a19382
build: bump nginxproxy/docker-gen from 0.11.1-debian to 0.11.2-debian
dependabot[bot] Feb 10, 2024
887e2e9
Merge pull request #2390 from nginx-proxy/dependabot/docker/nginxprox…
buchdag Feb 10, 2024
cb59c24
tests non standard port Host header
SchoNie Feb 13, 2024
5c0c8c9
Merge pull request #2393 from SchoNie/tests-nonstandardport-hostheader
buchdag Feb 13, 2024
1aef017
build: bump nginx from 1.25.3 to 1.25.4
dependabot[bot] Feb 15, 2024
d9b1751
build: update docs and tests with nginx 1.25.4
buchdag Feb 15, 2024
5583b38
style: docs linting
buchdag Feb 15, 2024
020b993
Merge pull request #2395 from nginx-proxy/dependabot/docker/nginx-1.25.4
buchdag Feb 15, 2024
e75c2df
build: revert nginx to 1.25.3 (#2396)
buchdag Feb 15, 2024
2eaf689
fix typo README.md
whomobile Feb 15, 2024
2916865
build: bump nginx from 1.25.3 to 1.25.4
dependabot[bot] Feb 16, 2024
745a203
Merge pull request #2397 from whomobile/patch-1
buchdag Feb 16, 2024
5a32bff
Merge pull request #2398 from nginx-proxy/dependabot/docker/nginx-1.25.4
buchdag Feb 18, 2024
a2a441e
docs: update nginx badge
buchdag Feb 18, 2024
0dd4f7a
ci: bump pytest from 7.4.4 to 8.0.1 in /test/requirements
dependabot[bot] Feb 19, 2024
50750be
highlight variables similar to other in readme
SchoNie Feb 19, 2024
d4438b5
prevent double slash
SchoNie Feb 19, 2024
b4902f1
Merge pull request #2401 from SchoNie/docs-htpasswd-readability
buchdag Feb 19, 2024
4464269
remove obsolete stress-test
SchoNie Feb 19, 2024
da00655
Merge pull request #2400 from SchoNie/tests-remove-obsolete
buchdag Feb 21, 2024
a9f8a9c
htpasswd tests
SchoNie Feb 19, 2024
24592e3
Merge pull request #2402 from SchoNie/htpasswd-tests
buchdag Feb 21, 2024
9d2eeb7
Merge pull request #2399 from nginx-proxy/dependabot/pip/test/require…
buchdag Feb 21, 2024
8c95ed1
docs: add comment about host network to compose example
iloveitaly Feb 22, 2024
4d9d067
refactor: refactor virtual hosts
buchdag Feb 24, 2024
e97be61
refactor: refactor virtual paths
buchdag Feb 24, 2024
f960061
Merge pull request #2404 from nginx-proxy/network-host
buchdag Feb 25, 2024
d588c96
build: bump nginxproxy/docker-gen from 0.11.2-debian to 0.12.0-debian
dependabot[bot] Feb 25, 2024
b8b5379
Merge pull request #2406 from nginx-proxy/dependabot/docker/nginxprox…
buchdag Feb 25, 2024
2a55216
ci: bump pytest from 8.0.1 to 8.0.2 in /test/requirements
dependabot[bot] Feb 26, 2024
60618af
Merge pull request #2407 from nginx-proxy/dependabot/pip/test/require…
buchdag Feb 26, 2024
418f1a3
fix: don't re-assign variable
buchdag Feb 27, 2024
b095752
docs: typo in comments
buchdag Feb 27, 2024
12e1360
ci: bump pytest from 8.0.2 to 8.1.0 in /test/requirements
dependabot[bot] Mar 4, 2024
4b38bf2
Merge pull request #2405 from nginx-proxy/refactor-template-2
buchdag Mar 4, 2024
26b0a00
Merge pull request #2408 from nginx-proxy/dependabot/pip/test/require…
buchdag Mar 4, 2024
45770e0
refactor: add 'ports' dict to the data structure
pini-gh Mar 9, 2024
6441daf
ci: bump pytest from 8.1.0 to 8.1.1 in /test/requirements
dependabot[bot] Mar 11, 2024
16b84ea
Update README.md to use 1.5 version and link DockerHub
Huge Mar 12, 2024
3c3b367
Merge pull request #2413 from Huge/patch-1
buchdag Mar 12, 2024
c7bf756
Merge pull request #2411 from nginx-proxy/dependabot/pip/test/require…
buchdag Mar 12, 2024
94fb845
Merge pull request #2410 from pini-gh/pini-refactor-template-3
buchdag Mar 12, 2024
103cb7d
ci: bump pytest from 8.1.1 to 8.2.0 in /test/requirements
dependabot[bot] Apr 29, 2024
0d7aac7
Merge pull request #2428 from nginx-proxy/dependabot/pip/test/require…
buchdag May 1, 2024
559c43e
build: bump nginx from 1.25.4 to 1.26.0
dependabot[bot] Apr 24, 2024
766db8d
docs: update nginx version badge
buchdag May 1, 2024
769d58b
Merge pull request #2425 from nginx-proxy/dependabot/docker/nginx-1.26.0
buchdag May 1, 2024
2ac4540
docs: redordering, grouping and navigation
buchdag May 2, 2024
1e55d98
Merge pull request #2429 from nginx-proxy/docs-qol
buchdag May 2, 2024
12d639d
Change to raw string literal
SchoNie Apr 19, 2024
43b8ab8
Merge pull request #2432 from SchoNie/webserver-syntaxwarning-fix
buchdag May 3, 2024
877f243
docs: url fixes
SchoNie May 3, 2024
e46e62e
Merge pull request #2433 from SchoNie/docs-urls
buchdag May 3, 2024
46724e7
tests: add test if nginx-proxy-builder can be build successfully
SchoNie May 3, 2024
c678cfd
Apply suggestions from code review
SchoNie May 3, 2024
6602769
style: linting
buchdag May 3, 2024
08f5638
build: bump nginxproxy/docker-gen from 0.12.0-debian to 0.12.1-debian
dependabot[bot] May 3, 2024
b4bceac
Merge pull request #2435 from SchoNie/nginx-proxy-tester
buchdag May 3, 2024
2ac4509
Merge pull request #2436 from nginx-proxy/dependabot/docker/nginxprox…
buchdag May 3, 2024
340f6b0
build: bump nginxproxy/docker-gen from 0.12.1-debian to 0.13.0-debian
dependabot[bot] May 5, 2024
6e771fb
Merge pull request #2439 from nginx-proxy/dependabot/docker/nginxprox…
buchdag May 5, 2024
87e5b58
feat: multiports support using yaml syntax
pini-gh Mar 24, 2024
fc98f4c
refactor: cleanup template
buchdag May 2, 2024
62d9c08
fix: default values if port and dest are missing
buchdag May 2, 2024
6221218
test: re-organize test files
buchdag May 2, 2024
216eae9
test: multiports base test
buchdag May 2, 2024
47e2838
refactor: rename VIRTUAL_HOST_YAML -> VIRTUAL_HOST_MULTIPORTS
buchdag May 2, 2024
8359aa2
docs: documentation for multiports support
buchdag May 2, 2024
0baff18
refactor: get rid of get_path_info template
buchdag May 3, 2024
53e9a03
feat: print warning on unparsable VIRTUAL_HOST_MULTIPORTS
buchdag May 3, 2024
d80ca7e
test: json syntax for multiports variable
buchdag May 4, 2024
8b91f09
docs: use examples closer to real life scenarios
buchdag May 4, 2024
1b97b11
test: use python:3-alpine as base for the web image
buchdag May 5, 2024
9a76577
style: shellcheck linting
buchdag May 5, 2024
be7c4c8
fix: do not discard containers without VIRTUAL_PATH
buchdag May 5, 2024
c4c65a4
Merge pull request #2440 from nginx-proxy/web-image-alpine
buchdag May 5, 2024
1bf7eff
test: multiport merge with legacy variable
buchdag May 4, 2024
d6c38a0
tests: Add tests for how Let's Encrypt ACME challenge is handled
p12tic May 4, 2024
f964176
Merge pull request #2438 from p12tic/test-acme-challenge
buchdag May 6, 2024
99645f1
docs: typo
buchdag May 6, 2024
be319e6
docs: typo
buchdag May 6, 2024
12c4f0c
Support TCP and UDP proxy
KagurazakaNyaa Oct 28, 2022
ec405f3
Merge pull request #2078 from KagurazakaNyaa/main
buchdag May 8, 2024
59d5293
fix 'requirements' path in test/test_build.py
pini-gh May 8, 2024
fc02a5a
Merge pull request #2444 from pini-gh/pini-fix-test-test_build.py
buchdag May 8, 2024
5b1491f
build: disambiguate base image names
pini-gh Apr 29, 2023
8e26429
Merge pull request #2445 from pini-gh/pini-disambiguate
buchdag May 8, 2024
db07d90
Merge pull request #2434 from nginx-proxy/multiport-support
buchdag May 9, 2024
6c1b532
Improve acme-challenge handling
pini-gh May 9, 2024
2564a93
Merge pull request #2446 from pini-gh/pini-acme-challenge
buchdag May 13, 2024
91652aa
fix: constistent behavior for `HTTPS_METHOD=nohttp`
pini-gh May 14, 2024
1b4a3b0
Merge pull request #2448 from pini-gh/pini-nohttp-behavior
buchdag May 15, 2024
8e372c3
fix: include a complete fastcgi_params config
rodrigoaguilera Jul 10, 2022
f22b64d
build: bump nginxproxy/docker-gen from 0.13.0-debian to 0.13.1-debian
dependabot[bot] May 16, 2024
87ce03e
Merge pull request #2451 from nginx-proxy/dependabot/docker/nginxprox…
buchdag May 16, 2024
57501eb
Merge pull request #2449 from nginx-proxy/fix-fastcgi
buchdag May 17, 2024
49f0b89
ci: bump pytest from 8.2.0 to 8.2.1 in /test/requirements
dependabot[bot] May 20, 2024
ce2a78b
Merge pull request #2455 from nginx-proxy/dependabot/pip/test/require…
buchdag May 20, 2024
1c1f8e8
dependabot[bot] May 21, 2024
df464bb
Merge pull request #2459 from nginx-proxy/dependabot/pip/test/require…
buchdag May 21, 2024
2a793b2
fix: hardcode requests package version to 2.31.0
buchdag May 21, 2024
b4c7ea6
Merge pull request #2460 from nginx-proxy/pin-request
buchdag May 21, 2024
fb9c3a6
feat: custom default error page (#2430)
buchdag May 22, 2024
7a761e1
ci: bump docker from 7.0.0 to 7.1.0 in /test/requirements (#2461)
dependabot[bot] May 23, 2024
0dfc8b7
ci: bump requests from 2.31.0 to 2.32.2 in /test/requirements (#2462)
dependabot[bot] May 23, 2024
5f3ec18
docs: explicit policy on missing certificate (#2465)
pini-gh May 27, 2024
e904471
build: bump nginxproxy/docker-gen from 0.13.1-debian to 0.14.0-debian…
dependabot[bot] May 28, 2024
9cf736f
feat: variable ACME_HTTP_CHALLENGE_LOCATION (#2468)
pini-gh May 30, 2024
57e8656
build: bump library/nginx from 1.26.0 to 1.27.0 (#2470)
dependabot[bot] May 31, 2024
7922c92
chore: spelling fixes for #2468 (#2471)
SchoNie May 31, 2024
8de923f
ci: bump requests from 2.32.2 to 2.32.3 in /test/requirements (#2472)
dependabot[bot] Jun 3, 2024
4bd542d
feat: handle acme challenge location by default
buchdag Jun 5, 2024
714fa25
style: docs linting
buchdag Jun 5, 2024
cea905f
docs: typo
buchdag Jun 5, 2024
9506e60
Merge pull request #2473 from nginx-proxy/enable-acme-challenge
buchdag Jun 6, 2024
60b123d
feat: ENABLE_HTTP_ON_MISSING_CERT variable
pini-gh May 27, 2024
50608d7
Merge pull request #2452 from pini-gh/pini-enforce-HTTPS_METHOD
buchdag Jun 6, 2024
4606b15
fix: nohttp(s) shouldn't disable fallback server
pini-gh Jun 6, 2024
477366d
Merge pull request #2475 from pini-gh/pini-fallback-https
buchdag Jun 9, 2024
ff46571
ci: bump pytest from 8.2.1 to 8.2.2 in /test/requirements
dependabot[bot] Jun 10, 2024
e6c301a
Merge pull request #2477 from nginx-proxy/dependabot/pip/test/require…
buchdag Jun 10, 2024
705dfa0
docs: update version in README.md
SchoNie Jun 10, 2024
b67b434
Merge pull request #2478 from SchoNie/docs-1.6
buchdag Jun 12, 2024
261ac6f
ci: bump docker/build-push-action from 5 to 6
dependabot[bot] Jun 24, 2024
31642a7
Merge pull request #2485 from nginx-proxy/dependabot/github_actions/d…
buchdag Jun 24, 2024
f4ccdbd
ci: bump pytest from 8.2.2 to 8.3.1 in /test/requirements
dependabot[bot] Jul 22, 2024
8d47458
Merge pull request #2493 from nginx-proxy/dependabot/pip/test/require…
buchdag Jul 22, 2024
5fe5244
ci: bump pytest from 8.3.1 to 8.3.2 in /test/requirements
dependabot[bot] Jul 29, 2024
434a089
Merge pull request #2495 from nginx-proxy/dependabot/pip/test/require…
buchdag Jul 29, 2024
5f4e77b
fix: use fastcgi.conf on alpine and fastcgi_params on debien
buchdag Jul 29, 2024
290d275
Merge pull request #2497 from nginx-proxy/2496
buchdag Jul 29, 2024
c5f054e
fix: limit exposed ports in template comment to 10 (#2494)
mikfar Jul 29, 2024
dee91b4
build: bump nginxproxy/docker-gen from 0.14.0-debian to 0.14.1-debian
dependabot[bot] Jul 31, 2024
83110b2
Merge pull request #2498 from nginx-proxy/dependabot/docker/nginxprox…
buchdag Jul 31, 2024
54a1b0a
build: bump nginxproxy/forego from 0.18.1-debian to 0.18.2-debian
dependabot[bot] Aug 27, 2024
d4d3f12
Merge pull request #2504 from nginx-proxy/dependabot/docker/nginxprox…
buchdag Aug 27, 2024
1c00b89
build: bump nginxproxy/docker-gen from 0.14.1-debian to 0.14.2-debian
dependabot[bot] Aug 27, 2024
f100b44
Merge pull request #2505 from nginx-proxy/dependabot/docker/nginxprox…
buchdag Aug 27, 2024
1baf048
build: bump nginx 1.27.0 to 1.27.1 (#2506)
SchoNie Aug 27, 2024
246da3f
Fix nginx.tmpl when enabled TLSv1 TLSv1.1
liuxiaoy Sep 13, 2024
90f6e1b
ci: bump pytest from 8.3.2 to 8.3.3 in /test/requirements
dependabot[bot] Sep 16, 2024
7687374
Merge pull request #2512 from nginx-proxy/dependabot/pip/test/require…
buchdag Sep 19, 2024
712a7ef
fix: reject SSL handshake rather than using empty certificate
buchdag Oct 3, 2024
6948880
Merge pull request #2520 from nginx-proxy/reject-handshake
buchdag Oct 3, 2024
e95a66e
build: bump library/nginx from 1.27.1 to 1.27.2
dependabot[bot] Oct 3, 2024
4251249
Merge pull request #2519 from nginx-proxy/dependabot/docker/library/n…
buchdag Oct 3, 2024
3ba0678
fix: re-enable TLSv1 and TLSv1.1 on relevant policies
buchdag Sep 28, 2024
ac0a4ca
docs: warn about TLSv1 / TLSv1.1 being available only on debian
buchdag Oct 6, 2024
8417046
Merge pull request #2510 from liuxiaoy/patch-1
buchdag Oct 12, 2024
5ec120a
docs: TLSv1/TLSv1.1 work on the alpine image too
buchdag Oct 16, 2024
73ba280
fix: use sha1 hash for config files when using regex host
buchdag Nov 1, 2024
5baf4a1
docs: update docs regex file name change
buchdag Nov 1, 2024
1cd7b97
test: regex vhost file names
buchdag Nov 1, 2024
4c67b24
test: rename file for clarity
buchdag Nov 1, 2024
a3db62b
Merge pull request #2533 from nginx-proxy/2529
buchdag Nov 2, 2024
8fed348
refactor: move global config properties to a sub dict
buchdag Oct 9, 2024
ebed622
feat: nginx-proxy debug endpoint
buchdag Oct 16, 2024
fe52878
refactor: expose clearly access log status in debug endpoint
buchdag Oct 16, 2024
dce7663
refactor: remove duplicate code
buchdag Oct 16, 2024
7dafac8
docs: documentation for debug endpoint
buchdag Oct 17, 2024
32ad9b7
feat: protection against too long debug response
buchdag Oct 17, 2024
1900307
test: nginx-proxy debug endpoint
buchdag Nov 2, 2024
9114b80
test: paths are stripped from debug endpoint response if too long
buchdag Nov 2, 2024
031a2b1
Merge pull request #2525 from nginx-proxy/debug-endpoint
buchdag Nov 2, 2024
52100c4
refactor: move global hsts to $globals.config
buchdag Nov 2, 2024
07aef2b
refactor: move global acme challenge location to $globals.config
buchdag Nov 2, 2024
dcbb695
refactor: move global http2/http3 to $globals.config
buchdag Nov 2, 2024
30b909d
refactor: move https enforcing to $globals.config
buchdag Nov 2, 2024
db0421e
refactor: move https method to $globals.config
buchdag Nov 2, 2024
946485e
refactor: move default host to $globals.config
buchdag Nov 2, 2024
a06cd1a
refactor: move resolvers to $globals.config
buchdag Nov 2, 2024
cab2a2d
refactor: move log configs to $globals.config
buchdag Nov 2, 2024
01d14f0
refactor: align global config template syntax
buchdag Nov 2, 2024
72bb8a6
refactor: further align template syntax
buchdag Nov 2, 2024
7d90978
refactor: move debug's hostname into vhost
buchdag Nov 3, 2024
fbf3e2f
docs: complete debug endpoint docs
buchdag Nov 3, 2024
523112d
build: bump nginxproxy/docker-gen from 0.14.2-debian to 0.14.3-debian
dependabot[bot] Nov 4, 2024
80474e3
Merge pull request #2536 from nginx-proxy/dependabot/docker/nginxprox…
buchdag Nov 4, 2024
a79445f
Merge pull request #2534 from nginx-proxy/refactor-globals
buchdag Nov 4, 2024
fdb7310
fix: do not render regexp hostname in debug endpoint response
buchdag Nov 4, 2024
9ca7d26
Merge pull request #2537 from nginx-proxy/debug-endpoint-regexp
buchdag Nov 4, 2024
d4d6567
Test for DISABLE_ACCESS_LOGS
SchoNie Nov 5, 2024
d7acd93
Merge pull request #2538 from SchoNie/test-access-log-disabled
buchdag Nov 5, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ jobs:

- name: Build and push the image
id: docker_build
uses: docker/build-push-action@v5
uses: docker/build-push-action@v6
with:
context: .
file: Dockerfile.${{ matrix.base }}
Expand Down
15 changes: 10 additions & 5 deletions Dockerfile.alpine
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
FROM nginxproxy/docker-gen:0.11.1 AS docker-gen
FROM docker.io/nginxproxy/docker-gen:0.14.3 AS docker-gen

FROM nginxproxy/forego:0.18.1 AS forego
FROM docker.io/nginxproxy/forego:0.18.2 AS forego

# Build the final image
FROM nginx:1.25.3-alpine
FROM docker.io/library/nginx:1.27.2-alpine

ARG NGINX_PROXY_VERSION
# Add DOCKER_GEN_VERSION environment variable because
Expand All @@ -17,8 +17,13 @@ ENV NGINX_PROXY_VERSION=${NGINX_PROXY_VERSION} \
RUN apk add --no-cache --virtual .run-deps bash openssl

# Configure Nginx
RUN sed -i 's/worker_connections 1024/worker_connections 10240/' /etc/nginx/nginx.conf \
&& mkdir -p '/etc/nginx/dhparam'
RUN echo -e "\ninclude /etc/nginx/toplevel.conf.d/*.conf;" >> /etc/nginx/nginx.conf \
&& sed -i 's/worker_connections.*;$/worker_connections 10240;/' /etc/nginx/nginx.conf \
&& sed -i -e '/^\}$/{s//\}\nworker_rlimit_nofile 20480;/;:a' -e '$!N;$!ba' -e '}' /etc/nginx/nginx.conf \
&& mkdir -p '/etc/nginx/toplevel.conf.d' \
&& mkdir -p '/etc/nginx/dhparam' \
&& mkdir -p '/etc/nginx/certs' \
&& mkdir -p '/usr/share/nginx/html/errors'

# Install Forego + docker-gen
COPY --from=forego /usr/local/bin/forego /usr/local/bin/forego
Expand Down
15 changes: 10 additions & 5 deletions Dockerfile.debian
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
FROM nginxproxy/docker-gen:0.11.1-debian AS docker-gen
FROM docker.io/nginxproxy/docker-gen:0.14.3-debian AS docker-gen

FROM nginxproxy/forego:0.18.1-debian AS forego
FROM docker.io/nginxproxy/forego:0.18.2-debian AS forego

# Build the final image
FROM nginx:1.25.3
FROM docker.io/library/nginx:1.27.2

ARG NGINX_PROXY_VERSION
# Add DOCKER_GEN_VERSION environment variable because
Expand All @@ -14,8 +14,13 @@ ENV NGINX_PROXY_VERSION=${NGINX_PROXY_VERSION} \
DOCKER_HOST=unix:///tmp/docker.sock

# Configure Nginx
RUN sed -i 's/worker_connections 1024/worker_connections 10240/' /etc/nginx/nginx.conf \
&& mkdir -p '/etc/nginx/dhparam'
RUN echo "\ninclude /etc/nginx/toplevel.conf.d/*.conf;" >> /etc/nginx/nginx.conf \
&& sed -i 's/worker_connections.*;$/worker_connections 10240;/' /etc/nginx/nginx.conf \
&& sed -i -e '/^\}$/{s//\}\nworker_rlimit_nofile 20480;/;:a' -e '$!N;$!ba' -e '}' /etc/nginx/nginx.conf \
&& mkdir -p '/etc/nginx/toplevel.conf.d' \
&& mkdir -p '/etc/nginx/dhparam' \
&& mkdir -p '/etc/nginx/certs' \
&& mkdir -p '/usr/share/nginx/html/errors'

# Install Forego + docker-gen
COPY --from=forego /usr/local/bin/forego /usr/local/bin/forego
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
[![Test](https://github.com/nginx-proxy/nginx-proxy/actions/workflows/test.yml/badge.svg)](https://github.com/nginx-proxy/nginx-proxy/actions/workflows/test.yml)
[![GitHub release](https://img.shields.io/github/v/release/nginx-proxy/nginx-proxy)](https://github.com/nginx-proxy/nginx-proxy/releases)
![nginx 1.25.3](https://img.shields.io/badge/nginx-1.25.3-brightgreen.svg)
[![nginx 1.27.2](https://img.shields.io/badge/nginx-1.27.2-brightgreen.svg?logo=nginx)](https://nginx.org/en/CHANGES)
[![Docker Image Size](https://img.shields.io/docker/image-size/nginxproxy/nginx-proxy?sort=semver)](https://hub.docker.com/r/nginxproxy/nginx-proxy "Click to view the image on Docker Hub")
[![Docker stars](https://img.shields.io/docker/stars/nginxproxy/nginx-proxy.svg)](https://hub.docker.com/r/nginxproxy/nginx-proxy 'DockerHub')
[![Docker pulls](https://img.shields.io/docker/pulls/nginxproxy/nginx-proxy.svg)](https://hub.docker.com/r/nginxproxy/nginx-proxy 'DockerHub')

[![Docker stars](https://img.shields.io/docker/stars/nginxproxy/nginx-proxy.svg)](https://hub.docker.com/r/nginxproxy/nginx-proxy "DockerHub")
[![Docker pulls](https://img.shields.io/docker/pulls/nginxproxy/nginx-proxy.svg)](https://hub.docker.com/r/nginxproxy/nginx-proxy "DockerHub")

nginx-proxy sets up a container running nginx and [docker-gen](https://github.com/nginx-proxy/docker-gen). docker-gen generates reverse proxy configs for nginx and reloads nginx when containers are started and stopped.

Expand All @@ -19,7 +18,7 @@ docker run --detach \
--name nginx-proxy \
--publish 80:80 \
--volume /var/run/docker.sock:/tmp/docker.sock:ro \
nginxproxy/nginx-proxy:1.4
nginxproxy/nginx-proxy:1.6
```

Then start any containers (here an nginx container) you want proxied with an env var `VIRTUAL_HOST=subdomain.yourdomain.com`
Expand All @@ -34,6 +33,7 @@ docker run --detach \
Provided your DNS is setup to resolve `foo.bar.com` to the host running nginx-proxy, a request to `http://foo.bar.com` will then be routed to a container with the `VIRTUAL_HOST` env var set to `foo.bar.com` (in this case, the **your-proxied-app** container).

The containers being proxied must :

- [expose](https://docs.docker.com/engine/reference/run/#expose-incoming-ports) the port to be proxied, either by using the `EXPOSE` directive in their `Dockerfile` or by using the `--expose` flag to `docker run` or `docker create`.
- share at least one Docker network with the nginx-proxy container: by default, if you don't pass the `--net` flag when your nginx-proxy container is created, it will only be attached to the default bridge network. This means that it will not be able to connect to containers on networks other than bridge.

Expand All @@ -48,22 +48,22 @@ The nginx-proxy images are available in two flavors.
This image is based on the nginx:mainline image, itself based on the debian slim image.

```console
docker pull nginxproxy/nginx-proxy:1.4
docker pull nginxproxy/nginx-proxy:1.6
```

#### Alpine based version (`-alpine` suffix)

This image is based on the nginx:alpine image.

```console
docker pull nginxproxy/nginx-proxy:1.4-alpine
docker pull nginxproxy/nginx-proxy:1.6-alpine
```

#### :warning: a note on `latest` and `alpine`:

It is not recommended to use the `latest` (`nginxproxy/nginx-proxy`, `nginxproxy/nginx-proxy:latest`) or `alpine` (`nginxproxy/nginx-proxy:alpine`) tag for production setups.

Those tags points to the latest commit in the `main` branch. They do not carry any promise of stability, and using them will probably put your nginx-proxy setup at risk of experiencing uncontrolled updates to non backward compatible versions (or versions with breaking changes). You should always specify the version you want to use explicitly to ensure your setup doesn't break when the image is updated.
[Those tags point](https://hub.docker.com/r/nginxproxy/nginx-proxy/tags) to the latest commit in the `main` branch. They do not carry any promise of stability, and using them will probably put your nginx-proxy setup at risk of experiencing uncontrolled updates to non backward compatible versions (or versions with breaking changes). You should always specify the version you want to use explicitly to ensure your setup doesn't break when the image is updated.

### Additional documentation

Expand Down
3 changes: 3 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ services:
volumes:
- /var/run/docker.sock:/tmp/docker.sock:ro

# if you want to proxy based on host ports, you'll want to use the host network
# network_mode: "host"

whoami:
image: jwilder/whoami
environment:
Expand Down
Loading