You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/security_report.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
---
2
2
name: Security report
3
3
about: Create a security report to help us improve
4
-
title: ''
5
-
labels: ''
6
-
assignees: ''
4
+
title: ""
5
+
labels: ""
6
+
assignees: ""
7
7
---
8
8
### Describe the bug
9
9
@@ -24,4 +24,4 @@ Steps to reproduce the behavior:
24
24
25
25
### Additional context
26
26
27
-
Does this security vulnerability relate to one of the NGINX libraries specified in the [`SECURITY`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/.github/SECURITY.md) doc?
27
+
Does this security vulnerability relate to one of the NGINX libraries specified in the [`SECURITY`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/SECURITY.md) doc?
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@ Describe the use case and detail of the change. If this PR addresses an issue on
4
4
5
5
### Checklist
6
6
7
-
Before creating a PR, run through this checklist and mark each as complete.
7
+
Before creating a PR, run through this checklist and mark each as complete:
8
8
9
-
-[ ] I have read the [`CONTRIBUTING`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/CONTRIBUTING.md) document.
10
-
-[ ] I have tested that the NGINX Unprivileged Docker images build correctly on all supported platforms (check out the [`README`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/README.md) for more details).
11
-
-[ ] I have deployed the NGINX Unprivileged Docker images on an unprivileged environment and checked that they run correctly.
9
+
-[ ] I have read the [`CONTRIBUTING`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/CONTRIBUTING.md) document
10
+
-[ ] I have run `./update.sh` and ensured all entrypoint/Dockerfile template changes have been applied to the relevant image entrypoint scripts & Dockerfiles
11
+
-[ ] I have tested that the NGINX Unprivileged Docker images build and run correctly on all supported architectures on an unprivileged environment (check out the [`README`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/README.md) for more details)
12
12
-[ ] I have updated any relevant documentation ([`README`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/README.md))
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ To report a bug, open an issue on GitHub with the label `bug` using the availabl
34
34
35
35
### Report a Security vulnerability
36
36
37
-
To report a secuirty vulnerability, open an issue on GitHub with the label `security` using the available security report issue template. Please ensure the security vulnerability directly impacts one of the NGINX dependencies listed in the [`SECURITY`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/.github/SECURITY.md) doc. Other security vulnerabilities should be addressed by the weekly Monday night build and as such will be promptly closed.
37
+
To report a security vulnerability, open an issue on GitHub with the label `security` using the available security report issue template. Please ensure the security vulnerability directly impacts one of the NGINX dependencies listed in the [`SECURITY`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/.github/SECURITY.md) doc. Other security vulnerabilities should be addressed by the weekly Monday night build and as such will be promptly closed.
38
38
39
39
### Suggest a Feature or Enhancement
40
40
@@ -54,7 +54,7 @@ Note: if you'd like to implement a new feature, please consider creating a featu
54
54
Given this repository is a mirror image of the upstream [Docker NGINX image](https://github.com/nginxinc/docker-nginx), only two types of PRs will be considered:
55
55
56
56
1. PRs that incorporate changes made to upstream images (e.g. there's a new NGINX release).
57
-
2. PRs that add a critical feature or a nice-to-have enhancement for running these images on an unprivileged environment (e.g. allowing users specify the UID/GUI of the image user).
57
+
2. PRs that add a critical feature or a nice-to-have enhancement for running these images on an unprivileged environment (e.g. allowing users specify to the UID/GID of the image user).
Copy file name to clipboardExpand all lines: README.md
+16-5Lines changed: 16 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,14 @@
1
1
[](https://www.repostatus.org/#active)
This repo contains a series of Dockerfiles to create an NGINX Docker image that runs NGINX as a non root, unprivileged user. Notable differences with respect to the official NGINX Docker image include:
6
7
7
-
* The default NGINX listen port is now `8080` instead of `80` (this is no longer necessary as of Docker `20.03` but it's still required in other container runtimes).
8
-
* The default NGINX user directive in `/etc/nginx/nginx.conf` has been removed.
9
-
* The default NGINX PID has been moved from `/var/run/nginx.pid` to `/tmp/nginx.pid`.
10
-
* Change `*_temp_path` variables to `/tmp/*`.
8
+
* The default NGINX listen port is now `8080` instead of `80` (this is no longer necessary as of Docker `20.03` but it's still required in other container runtimes)
9
+
* The default NGINX user directive in `/etc/nginx/nginx.conf` has been removed
10
+
* The default NGINX PID has been moved from `/var/run/nginx.pid` to `/tmp/nginx.pid`
11
+
* Change `*_temp_path` variables to `/tmp/*`
11
12
12
13
New images are built and pushed to on a weekly basis (every Monday night).
13
14
@@ -25,10 +26,20 @@ You can find built images in the following registries:
Most images are built for the `amd64`, `arm32v5` (for Debian), `arm32v6` (for Alpine), `arm32v7`, `arm64v8`, `i386`, `mips64le` (for Debian), `ppc64le` and `s390x` architectures.
31
32
32
33
## Common Issues
33
34
34
35
* If you override the default `nginx.conf` file you may receive the message `nginx: [emerg] open() "/var/run/nginx.pid" failed (13: Permission denied)`, in this case you have to add the line `pid /tmp/nginx.pid` into your config.
36
+
37
+
## Contributing
38
+
39
+
Please see the [contributing guide](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
40
+
41
+
## License
42
+
43
+
[Apache License, Version 2.0](https://github.com/nginxinc/ansible-role-nginx/blob/main/LICENSE)
We advise users to run or update to the most recent release of the NGINX Docker Unprivileged image. Older versions of the NGINX Docker Unprivileged image may not have all enhancements and/or bug fixes applied to them.
6
+
7
+
## Reporting a Vulnerability
8
+
9
+
### Docker NGINX Unprivileged Image
10
+
11
+
If you find a security vulnerability that directly affects a direct NGINX library dependency we encourage you open an issue detailing the security vulnerability.
12
+
13
+
For reference, the direct NGINX library dependencies are:
14
+
15
+
- For Debian:
16
+
-`libc6`
17
+
-`libcrypt1`
18
+
-`libpcre2`
19
+
-`libssl`
20
+
-`zlib1g`
21
+
22
+
- For Alpine Linux:
23
+
-`libc`
24
+
-`libcrypto`
25
+
-`libpcre2`
26
+
-`libssl`
27
+
-`libz`
28
+
29
+
***Note: Only vulnerabilities related to direct NGINX library dependencies will be considered. Other security vulnerabilities should be addressed by the weekly Monday night build and as such will be promptly closed.***
30
+
31
+
### Codebase
32
+
33
+
If you find a security vulnerability that affects the codebase, we encourage you to report it to the F5 Security Incident Response Team (F5 SIRT):
34
+
35
+
- If you’re an F5 customer with an active support contract, please contact [F5 Technical Support](https://www.f5.com/services/support).
36
+
- If you aren’t an F5 customer, please report any potential or current instances of security vulnerabilities with any F5 product to the F5 Security Incident Response Team at <[email protected]>.
37
+
38
+
For more information visit [https://www.f5.com/services/support/report-a-vulnerability](https://www.f5.com/services/support/report-a-vulnerability).
We use GitHub for tracking bugs and feature requests related to all the Docker NGINX images (including all variants and container registries).
6
+
7
+
Don't know how something in this project works? Curious if this project can achieve your desired functionality? Please open an issue on GitHub with the label `question`.
8
+
9
+
## NGINX Specific Questions and/or Issues
10
+
11
+
This isn't the right place to get support for NGINX specific questions, but the following resources are available below. Thanks for your understanding!
12
+
13
+
### Community Slack
14
+
15
+
We have a community [Slack](https://nginxcommunity.slack.com/)!
16
+
17
+
If you are not a member, click [here](https://community.nginx.org/joinslack) to sign up (and let us know if the link does not seem to be working!)
18
+
19
+
Once you join, check out the `#beginner-questions` and `nginx-users` channels :)
20
+
21
+
### Documentation
22
+
23
+
For a comprehensive list of all NGINX directives, check out <https://nginx.org>.
24
+
25
+
For a comprehensive list of admin and deployment guides for all NGINX products, check out <https://docs.nginx.com>.
26
+
27
+
### Mailing List
28
+
29
+
Want to get in touch with the NGINX development team directly? Try using the relevant mailing list found at <https://mailman.nginx.org/mailman3/lists/>!
30
+
31
+
## Contributing
32
+
33
+
Please see the [contributing guide](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
34
+
35
+
## Commercial Support
36
+
37
+
Commercial support for this project may be available. Please get in touch with [NGINX sales](https://www.nginx.com/contact-sales/) or check your contract details for more info!
0 commit comments