Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 7ce07b3

Browse files
DylenTurnbullalessfg
DylenTurnbull
and
alessfg
committedMar 25, 2025··
docs: Update community files
Co-Authored-By: Alessandro Fael Garcia <alessfg@hotmail.com>
1 parent 7ad3697 commit 7ce07b3

15 files changed

+305
-175
lines changed
 

‎.github/CODEOWNERS

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#####################
2+
# Main global owner #
3+
#####################
4+
5+
*

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
name: 🐛 Bug report
3+
description: Create a report to help us improve
4+
labels: bug
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
11+
Before you continue filling out this report, please take a moment to check that your bug has not been [already reported on GitHub][issue search] 🙌
12+
13+
Remember to redact any sensitive information such as authentication credentials and/or license keys!
14+
15+
[issue search]: ../search?q=is%3Aissue&type=issues
16+
17+
- type: textarea
18+
id: overview
19+
attributes:
20+
label: Bug Overview
21+
description: A clear and concise overview of the bug.
22+
placeholder: When I do "X" with the NGINX unprivileged Docker image, "Y" happens instead of "Z".
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: behavior
28+
attributes:
29+
label: Expected Behavior
30+
description: A clear and concise description of what you expected to happen.
31+
placeholder: When I do "X" with the NGINX unprivileged Docker image, I expect "Z" to happen.
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: steps
37+
attributes:
38+
label: Steps to Reproduce the Bug
39+
description: Detail the series of steps required to reproduce the bug. Deploy NGINX Unprivileged Docker image, View output/logs/configuration on '...', See error.
40+
placeholder: When I run the NGINX Docker unprivileged image using [...], the image fails with an error message. If I check the terminal outputs and/or logs, I see the following error info.
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: environment
46+
attributes:
47+
label: Environment Details
48+
description: Please provide details about your environment.
49+
value: |
50+
- Version of Docker and method of installation: [e.g. Docker Desktop / Docker Server]
51+
- Version/tag of the NGINX Docker unprivileged image or specific commit: [e.g. 1.4.3/commit hash]
52+
- Target deployment platform: [e.g. OpenShift/Kubernetes/Docker Compose/local cluster/etc...]
53+
- Target OS: [e.g. RHEL 9/Ubuntu 24.04/etc...]
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: context
59+
attributes:
60+
label: Additional Context
61+
description: Add any other context about the problem here.
62+
placeholder: Feel free to add any other context/information/screenshots/etc... that you think might be relevant to this issue in here.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: 💬 Talk to the NGINX community!
5+
url: https://community.nginx.org
6+
about: A community forum for NGINX users, developers, and contributors
7+
- name: 📝 Code of Conduct
8+
url: https://www.contributor-covenant.org/version/2/1/code_of_conduct
9+
about: NGINX follows the Contributor Covenant Code of Conduct to ensure a safe and inclusive community
10+
- name: 💼 For commercial & enterprise users
11+
url: https://www.f5.com/products/nginx
12+
about: F5 offers a wide range of NGINX products for commercial & enterprise users

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: ✨ Feature request
3+
description: Suggest an idea for this project
4+
labels: enhancement
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this feature request!
10+
11+
Before you continue filling out this request, please take a moment to check that your feature has not been [already requested on GitHub][issue search] 🙌
12+
13+
**Note:** If you are seeking community support or have a question, please consider starting a new thread via [GitHub discussions][discussions] or the [NGINX Community forum][forum].
14+
15+
[issue search]: ../search?q=is%3Aissue&type=issues
16+
17+
[discussions]: ../discussions
18+
[forum]: https://community.nginx.org
19+
20+
- type: textarea
21+
id: overview
22+
attributes:
23+
label: Feature Overview
24+
description: A clear and concise description of what the feature request is.
25+
placeholder: I would like the NGINX Docker unprivileged image to be able to do "X".
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Detail any potential alternative solutions/workarounds you've used or considered.
34+
placeholder: I have done/might be able to do "X" using the NGINX Docker unprivileged image by doing "Y".
35+
36+
- type: textarea
37+
id: context
38+
attributes:
39+
label: Additional Context
40+
description: Add any other context about the problem here.
41+
placeholder: Feel free to add any other context/information/screenshots/etc... that you think might be relevant to this feature request here.

‎.github/ISSUE_TEMPLATE/security_report.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

‎.github/scorecard.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
annotations:
3+
- checks:
4+
- fuzzing
5+
- sast
6+
reasons:
7+
- reason: not-applicable

‎.github/workflows/f5_cla.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: F5 CLA
3+
on:
4+
issue_comment:
5+
types: [created]
6+
pull_request_target:
7+
types: [opened, closed, synchronize]
8+
permissions: read-all
9+
jobs:
10+
f5-cla:
11+
name: F5 CLA
12+
runs-on: ubuntu-24.04
13+
permissions:
14+
actions: write
15+
pull-requests: write
16+
statuses: write
17+
steps:
18+
- name: Run F5 Contributor License Agreement (CLA) assistant
19+
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have hereby read the F5 CLA and agree to its terms') || github.event_name == 'pull_request_target'
20+
uses: contributor-assistant/github-action@ca4a40a7d1004f18d9960b404b97e5f30a505a08 # v2.6.1
21+
with:
22+
# Any pull request targeting the following branch will trigger a CLA check.
23+
# NOTE: You might need to edit this value to 'master'.
24+
branch: main
25+
# Path to the CLA document.
26+
path-to-document: https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md
27+
# Custom CLA messages.
28+
custom-notsigned-prcomment: '🎉 Thank you for your contribution! It appears you have not yet signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md), which is required for your changes to be incorporated into an F5 Open Source Software (OSS) project. Please kindly read the [F5 CLA](https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md) and reply on a new comment with the following text to agree:'
29+
custom-pr-sign-comment: 'I have hereby read the F5 CLA and agree to its terms'
30+
custom-allsigned-prcomment: '✅ All required contributors have signed the F5 CLA for this PR. Thank you!'
31+
# Remote repository storing CLA signatures.
32+
remote-organization-name: f5
33+
remote-repository-name: f5-cla-data
34+
path-to-signatures: signatures/signatures.json
35+
# Comma separated list of usernames for maintainers or any other individuals who should not be prompted for a CLA.
36+
# NOTE: You will want to edit the usernames to suit your project needs.
37+
allowlist: bot*
38+
# Do not lock PRs after a merge.
39+
lock-pullrequest-aftermerge: false
40+
env:
41+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
42+
PERSONAL_ACCESS_TOKEN: ${{ secrets.F5_CLA_TOKEN }}

‎.github/workflows/ossf_scorecard.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
# This workflow uses actions that are not certified by GitHub. They are provided by a third-party and are governed by separate terms of service, privacy policy, and support documentation.
3+
name: OSSF Scorecard
4+
on:
5+
# For Branch-Protection check. Only the default branch is supported. See https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection.
6+
branch_protection_rule:
7+
# To guarantee Maintained check is occasionally updated. See https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained.
8+
schedule:
9+
- cron: "0 0 * * 1"
10+
push:
11+
branches: [main]
12+
workflow_dispatch:
13+
# Declare default permissions as read only.
14+
permissions: read-all
15+
jobs:
16+
analysis:
17+
name: Scorecard analysis
18+
runs-on: ubuntu-24.04
19+
# Delete the conditional below if you are using the OSSF Scorecard on a private repository.
20+
if: ${{ github.event.repository.private == false }}
21+
permissions:
22+
# Needed if using Code Scanning alerts.
23+
security-events: write
24+
# Needed for GitHub OIDC token if publish_results is true.
25+
id-token: write
26+
steps:
27+
- name: Check out the codebase
28+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
29+
with:
30+
persist-credentials: false
31+
32+
- name: Run analysis
33+
uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1
34+
with:
35+
results_file: results.sarif
36+
results_format: sarif
37+
# Publish the results for public repositories to enable scorecard badges. For more details, see https://github.com/ossf/scorecard-action#publishing-results.
38+
publish_results: true
39+
40+
# Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF format to the repository Actions tab.
41+
- name: Upload artifact
42+
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
43+
with:
44+
name: SARIF file
45+
path: results.sarif
46+
retention-days: 5
47+
48+
# Upload the results to GitHub's code scanning dashboard.
49+
- name: Upload SARIF results to code scanning
50+
uses: github/codeql-action/upload-sarif@5f8171a638ada777af81d42b55959a643bb29017 # v3.28.12
51+
with:
52+
sarif_file: results.sarif

‎CODE_OF_CONDUCT.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,19 @@ We pledge to act and interact in ways that contribute to an open, welcoming, div
1010

1111
Examples of behavior that contributes to a positive environment for our community include:
1212

13-
- Demonstrating empathy and kindness toward other people
14-
- Being respectful of differing opinions, viewpoints, and experiences
15-
- Giving and gracefully accepting constructive feedback
16-
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17-
- Focusing on what is best not just for us as individuals, but for the overall community
13+
- Demonstrating empathy and kindness toward other people.
14+
- Being respectful of differing opinions, viewpoints, and experiences.
15+
- Giving and gracefully accepting constructive feedback.
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience.
17+
- Focusing on what is best not just for us as individuals, but for the overall community.
1818

1919
Examples of unacceptable behavior include:
2020

21-
- The use of sexualized language or imagery, and sexual attention or advances of
22-
any kind
23-
- Trolling, insulting or derogatory comments, and personal or political attacks
24-
- Public or private harassment
25-
- Publishing others' private information, such as a physical or email address, without their explicit permission
26-
- Other conduct which could reasonably be considered inappropriate in a professional setting
21+
- The use of sexualized language or imagery, and sexual attention or advances of any kind.
22+
- Trolling, insulting or derogatory comments, and personal or political attacks.
23+
- Public or private harassment.
24+
- Publishing others' private information, such as a physical or email address, without their explicit permission.
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting.
2726

2827
## Enforcement Responsibilities
2928

‎CONTRIBUTING.md

Lines changed: 33 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,59 @@
11
# Contributing Guidelines
22

3-
The following is a set of guidelines for contributing to the Docker Unprivileged NGINX image. We really appreciate that you are considering contributing!
3+
The following is a set of guidelines for contributing to the NGINX Docker unprivileged image. We really appreciate that you are considering contributing!
44

55
#### Table Of Contents
66

7-
[Ask a Question](#ask-a-question)
7+
- [Getting Started](#getting-started)
8+
- [Contributing](#contributing)
9+
- [Code Guidelines](#code-guidelines)
810

9-
[Project Overview](#project-overview)
11+
## Getting Started
1012

11-
[Contributing](#contributing)
12-
13-
[Code Guidelines](#code-guidelines)
14-
15-
* [Docker NGINX Unprivileged Guidelines](#docker-nginx-unprivileged-guidelines)
16-
* [Git Guidelines](#git-guidelines)
17-
18-
[Code of Conduct](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/CODE_OF_CONDUCT.md)
19-
20-
## Ask a Question
21-
22-
Don't know how something works? Curious if the role can achieve your desired functionality? Please open an Issue on GitHub with the label `question`.
23-
24-
### Project Overview
25-
26-
* The Docker Unprivileged NGINX repository is a mirror image of the [Docker NGINX image](https://github.com/nginxinc/docker-nginx). Changes have been made in order to support running NGINX in an unprivileged environment.
27-
* New Docker Unprivileged NGINX images are built on a weekly basis using GitHub actions.
13+
Look at the upstream Docker image [how to use this image guide](https://hub.docker.com/_/nginx/) to get the NGINX Docker unprivileged image up and running.
2814

2915
## Contributing
3016

3117
### Report a Bug
3218

33-
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the issue has not already been reported.
19+
To report a bug, open an issue on GitHub with the label `bug` using the available [bug report issue form](/.github/ISSUE_TEMPLATE/bug_report.yml). Please ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using our [security policy](/SECURITY.md).**
3420

35-
### Report a Security vulnerability
21+
### Suggest a Feature or Enhancement
3622

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/SECURITY.md) doc. Other security vulnerabilities should be addressed by the weekly Monday night build and as such will be promptly closed.
23+
To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement` using the available [feature request issue form](/.github/ISSUE_TEMPLATE/feature_request.yml). Please ensure the feature or enhancement has not already been suggested.
3824

39-
### Suggest a Feature or Enhancement
25+
### Open a Pull Request (PR)
4026

41-
To suggest an enhancement, please create an issue on GitHub with the label `feature` or `enhancement` using the available feature issue template.
27+
- Fork the repo, create a branch, implement your changes, test that the corresponding Docker images can be built and run as intended, and submit a PR when your changes are **tested** and ready for review.
28+
- Fill in the [PR template](/.github/pull_request_template.md).
29+
- This repository is a mirror image of the upstream [NGINX Docker image](https://github.com/nginxinc/docker-nginx) with minor changes in order to support running NGINX in an unprivileged environment. As such only two types of PRs will be considered:
4230

43-
### Open a Pull Request
31+
1. PRs that incorporate changes made to the upstream image that have not yet been ported to this image (e.g. there's a new NGINX release).
32+
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).
4433

45-
* Fork the repo, create a branch, implement your changes, test that the corresponding Docker images can be built and run as intended, and submit a PR when your changes are **tested** and ready for review.
46-
* Fill in [our pull request template](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/.github/pull_request_template.md).
34+
**Note:** If you'd like to implement a new feature, please consider creating a [feature request issue](/.github/ISSUE_TEMPLATE/feature_request.yml) first to start a discussion about the feature.
4735

48-
Note: if you'd like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature.
36+
#### F5 Contributor License Agreement (CLA)
4937

50-
## Code Guidelines
38+
F5 requires all contributors to agree to the terms of the F5 CLA (available [here](https://github.com/f5/f5-cla/.github/blob/main/docs/f5_cla.md)) before any of their changes can be incorporated into an F5 Open Source repository (even contributions to the F5 CLA itself!).
39+
40+
If you have not yet agreed to the F5 CLA terms and submit a PR to this repository, a bot will prompt you to view and agree to the F5 CLA. You will have to agree to the F5 CLA terms through a comment in the PR before any of your changes can be merged. Your agreement signature will be safely stored by F5 and no longer be required in future PRs.
5141

52-
### Docker NGINX Unprivileged Guidelines
42+
## Code Guidelines
5343

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:
44+
### Docker Guidelines
5545

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 to the UID/GID of the image user).
46+
- Update any entrypoint scripts via the the scripts contained in the [`/entrypoint`](/entrypoint) directory.
47+
- Update any Dockerfiles via the Dockerfile templates in the root directory (e.g. [`Dockerfile-alpine.template`](/Dockerfile-alpine.template)).
48+
- Run the [`./update.sh`](/update.sh) script to apply all entrypoint/Dockerfile template changes to the relevant image entrypoints & Dockerfiles.
5849

5950
### Git Guidelines
6051

61-
* Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
62-
* Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarised in the next few points:
63-
* In the subject line, use the present tense ("Add feature" not "Added feature").
64-
* In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
65-
* Limit the subject line to 72 characters or less.
66-
* Reference issues and pull requests liberally after the subject line.
67-
* Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`).
52+
- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
53+
- If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format when writing a commit message, so that changelogs can be automatically generated.
54+
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarized in the next few points:
55+
- In the subject line, use the present tense ("Add feature" not "Added feature").
56+
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
57+
- Limit the subject line to 72 characters or less.
58+
- Reference issues and pull requests liberally after the subject line.
59+
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`).

‎README.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
1+
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/nginx/docker-nginx-unprivileged/badge)](https://securityscorecards.dev/viewer/?uri=github.com/nginx/docker-nginx-unprivileged)
12
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
2-
[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/SUPPORT.md)
3-
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/nginxinc/docker-nginx-unprivileged/main/CODE_OF_CONDUCT.md)
3+
[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](/SUPPORT.md)
4+
[![Community Forum](https://img.shields.io/badge/community-forum-009639?logo=discourse&link=https%3A%2F%2Fcommunity.nginx.org)](https://community.nginx.org)
5+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/license/apache-2-0)
6+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](/CODE_OF_CONDUCT.md)
47

58
# NGINX Unprivileged Docker Image
69

710
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](https://github.com/nginxinc/docker-nginx) image include:
811

9-
* 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)
10-
* The default NGINX user directive in `/etc/nginx/nginx.conf` has been removed
11-
* The default NGINX PID has been moved from `/var/run/nginx.pid` to `/tmp/nginx.pid`
12-
* Change `*_temp_path` variables to `/tmp/*`
12+
- 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)
13+
- The default NGINX user directive in `/etc/nginx/nginx.conf` has been removed
14+
- The default NGINX PID has been moved from `/var/run/nginx.pid` to `/tmp/nginx.pid`
15+
- Change `*_temp_path` variables to `/tmp/*`
1316

1417
New images are built and pushed to on a weekly basis (every Monday night).
1518

@@ -21,26 +24,26 @@ Check out the [docs](https://hub.docker.com/_/nginx) for the upstream Docker NGI
2124

2225
You can find pre-built images in each of the following registries:
2326

24-
* Amazon ECR - <https://gallery.ecr.aws/nginx/nginx-unprivileged>
25-
* Docker Hub - <https://hub.docker.com/r/nginxinc/nginx-unprivileged>
26-
* GitHub Container Registry - <https://github.com/nginxinc/docker-nginx-unprivileged/pkgs/container/nginx-unprivileged>
27-
* Quay - <https://quay.io/repository/nginx/nginx-unprivileged>
27+
- Amazon ECR - <https://gallery.ecr.aws/nginx/nginx-unprivileged>
28+
- Docker Hub - <https://hub.docker.com/r/nginxinc/nginx-unprivileged>
29+
- GitHub Container Registry - <https://github.com/nginxinc/docker-nginx-unprivileged/pkgs/container/nginx-unprivileged>
30+
- Quay - <https://quay.io/repository/nginx/nginx-unprivileged>
2831

2932
### Architectures
3033

3134
Most images are built for the `amd64`, `arm32v5` (for Debian), `arm32v6` (for Alpine), `arm32v7`, `arm64v8`, `i386`, `mips64le` (for Debian), `ppc64le` and `s390x` architectures.
3235

3336
## Troubleshooting Tips
3437

35-
* If you wish to use a different user ID and/or group ID when running the Docker Unprivileged image, rebuild the image using the following Docker build arguments:
38+
- If you wish to use a different user ID and/or group ID when running the Docker Unprivileged image, rebuild the image using the following Docker build arguments:
3639

3740
```bash
3841
docker build --build-arg UID=<UID> --build-arg GID=<GID> -t nginx-unprivileged .
3942
```
4043

41-
* If you override the default `nginx.conf` file you may encounter various types of error messages:
42-
* To fix `nginx: [emerg] open() "/var/run/nginx.pid" failed (13: Permission denied)`, you have to specify a valid `pid` location by adding the line `pid /tmp/nginx.pid;` at the top level of your config.
43-
* To fix `nginx: [emerg] mkdir() "/var/cache/nginx/client_temp" failed (30: Read-only file system)`, you have to specify a valid location for the various NGINX temporary paths by adding these lines within the `http` context:
44+
- If you override the default `nginx.conf` file you may encounter various types of error messages:
45+
- To fix `nginx: [emerg] open() "/var/run/nginx.pid" failed (13: Permission denied)`, you have to specify a valid `pid` location by adding the line `pid /tmp/nginx.pid;` at the top level of your config.
46+
- To fix `nginx: [emerg] mkdir() "/var/cache/nginx/client_temp" failed (30: Read-only file system)`, you have to specify a valid location for the various NGINX temporary paths by adding these lines within the `http` context:
4447

4548
```nginx
4649
http {
@@ -53,7 +56,7 @@ Most images are built for the `amd64`, `arm32v5` (for Debian), `arm32v6` (for Al
5356
}
5457
```
5558
56-
## On Reporting Issues
59+
## On Reporting Issues and Opening PRs
5760
5861
Whilst issues and PRs are welcome, please do note that:
5962
@@ -63,10 +66,10 @@ Whilst issues and PRs are welcome, please do note that:
6366
6467
## Contributing
6568
66-
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.
69+
Please see the [contributing guide](/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
6770
6871
## License
6972
70-
[Apache License, Version 2.0](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/LICENSE)
73+
[Apache License, Version 2.0](/LICENSE)
7174
72-
&copy; [F5, Inc.](https://www.f5.com/) 2018 - 2024
75+
&copy; [F5, Inc.](https://www.f5.com/) 2018 - 2025

‎SECURITY.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,20 @@
22

33
## Latest Versions
44

5-
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.
5+
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.
66

77
## Reporting a Vulnerability
88

9-
### Docker NGINX Unprivileged Image
9+
The F5 Security Incident Response Team (F5 SIRT) offers two methods to easily report potential security vulnerabilities:
1010

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.
11+
- If you’re an F5 customer with an active support contract, please contact [F5 Technical Support](https://www.f5.com/support).
12+
- If you aren’t an F5 customer, please report any potential or current instances of security vulnerabilities in any F5 product to the F5 Security Incident Response Team at <f5sirt@f5.com>.
13+
14+
For more information, please read the F5 SIRT vulnerability reporting guidelines available at [https://www.f5.com/support/report-a-vulnerability](https://www.f5.com/support/report-a-vulnerability).
15+
16+
## CVEs to be considered
17+
18+
If you find a security vulnerability that directly affects a direct NGINX library dependency we encourage you open an issue detailing the security vulnerability. ***Only vulnerabilities related to to direct NGINX library dependencies will be considered. Other security vulnerabilities will be addressed by the weekly Monday night build and as such will be ignored/promptly closed.***
1219

1320
For reference, the direct NGINX library dependencies are:
1421

@@ -25,14 +32,3 @@ For reference, the direct NGINX library dependencies are:
2532
- `libpcre2`
2633
- `libssl`
2734
- `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 <F5SIRT@f5.com>.
37-
38-
For more information visit [https://www.f5.com/services/support/report-a-vulnerability](https://www.f5.com/services/support/report-a-vulnerability).

‎SUPPORT.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,34 @@
44

55
We use GitHub for tracking bugs and feature requests related to all the Docker NGINX images (including all variants and container registries).
66

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`.
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`. Alternatively, start a GitHub discussion!
88

99
## NGINX Specific Questions and/or Issues
1010

1111
This isn't the right place to get support for NGINX specific questions, but the following resources are available below. Thanks for your understanding!
1212

13-
### Community Slack
13+
### Community Forum
1414

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 :)
15+
We have a community [forum](https://community.nginx.org/)! If you have any questions and/or issues, try checking out the [`Troubleshooting`](https://community.nginx.org/c/troubleshooting/8) and [`How do I...?`](https://community.nginx.org/c/how-do-i/9) categories. Both fellow community members and NGINXers might be able to help you! :)
2016

2117
### Documentation
2218

2319
For a comprehensive list of all NGINX directives, check out <https://nginx.org>.
2420

25-
For a comprehensive list of admin and deployment guides for all NGINX products, check out <https://docs.nginx.com>.
21+
For a comprehensive list of administration and deployment guides for all NGINX products, check out <https://docs.nginx.com>.
2622

2723
### Mailing List
2824

2925
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/>!
3026

3127
## Contributing
3228

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.
29+
Please see the [contributing guide](/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
3430

3531
## Commercial Support
3632

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!
33+
Commercial support for this project may be available. Please get in touch with [NGINX sales](https://www.f5.com/products/get-f5/) or check your contract details for more info!
34+
35+
## Community Support
36+
37+
Community support is offered on a best effort basis through either GitHub issues/PRs/discussions or through any of our active communities.

0 commit comments

Comments
 (0)
Please sign in to comment.