[PR #5333] feat(access-list): add optional note field to access list clients #4176

New issue

Open

opened 2026-02-26 08:33:23 +03:00 by kerem · 0 comments

kerem commented

2026-02-26 08:33:23 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/NginxProxyManager/nginx-proxy-manager/pull/5333
Author: @TheMazeIsAmazing
Created: 2/20/2026
Status: 🔄 Open

Base: develop ← Head: develop

📝 Commits (1)

213e995 feat(access-list): add optional note field to access list clients and widen modal

📊 Changes

11 files changed (+88 additions, -9 deletions)

View changed files

📝 backend/internal/access-list.js (+2 -0)
📝 backend/lib/utils.js (+12 -4)
➕ backend/migrations/20260220111310_access_list_client_note.js (+36 -0)
📝 backend/schema/common.json (+13 -2)
📝 backend/schema/paths/nginx/access-lists/listID/put.json (+2 -1)
📝 backend/schema/paths/nginx/access-lists/post.json (+3 -1)
📝 frontend/src/App.css (+4 -0)
📝 frontend/src/api/backend/models.ts (+1 -0)
📝 frontend/src/components/Form/AccessClientFields.tsx (+10 -0)
📝 frontend/src/locale/src/en.json (+3 -0)
📝 frontend/src/modals/AccessListModal.tsx (+2 -1)

📄 Description

Based on my earlier Feature Request, nr. 5277, I thought I might take a jab at it myself.

This PR introduces an optional “note” field for access list client rules to improve clarity when managing multiple IP entries. It allows users to annotate each rule (e.g. “Home”, “Office”, “VPN”) without affecting nginx behaviour.

Backend changes:

Added optional note property to access list client schema.
Updated access list create/update endpoints to accept and persist note.
Kept note fully optional and backwards-compatible with existing data.
Ensured the nginx render filter outputs the note as a comment when present, preserving valid nginx syntax. Example image:

Frontend changes:

Extended AccessListClient type with note?: string.
Added a note input field in the Access List modal (Rules tab).
Included note in API payload only when non-empty.
Added i18n placeholder text for the new field.
Widened the Access List modal to improve layout and usability with the additional column.

If something is broken, or needs to be fixed, let me know. Thanks for your time!

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/NginxProxyManager/nginx-proxy-manager/pull/5333 **Author:** [@TheMazeIsAmazing](https://github.com/TheMazeIsAmazing) **Created:** 2/20/2026 **Status:** 🔄 Open **Base:** `develop` ← **Head:** `develop` --- ### 📝 Commits (1) - [`213e995`](https://github.com/NginxProxyManager/nginx-proxy-manager/commit/213e9954d602ed5db59efa0ebf12f06944f748c4) feat(access-list): add optional note field to access list clients and widen modal ### 📊 Changes **11 files changed** (+88 additions, -9 deletions) <details> <summary>View changed files</summary> 📝 `backend/internal/access-list.js` (+2 -0) 📝 `backend/lib/utils.js` (+12 -4) ➕ `backend/migrations/20260220111310_access_list_client_note.js` (+36 -0) 📝 `backend/schema/common.json` (+13 -2) 📝 `backend/schema/paths/nginx/access-lists/listID/put.json` (+2 -1) 📝 `backend/schema/paths/nginx/access-lists/post.json` (+3 -1) 📝 `frontend/src/App.css` (+4 -0) 📝 `frontend/src/api/backend/models.ts` (+1 -0) 📝 `frontend/src/components/Form/AccessClientFields.tsx` (+10 -0) 📝 `frontend/src/locale/src/en.json` (+3 -0) 📝 `frontend/src/modals/AccessListModal.tsx` (+2 -1) </details> ### 📄 Description Based on my earlier Feature Request, [nr. 5277](https://github.com/NginxProxyManager/nginx-proxy-manager/issues/5277), I thought I might take a jab at it myself. This PR introduces an optional “note” field for access list client rules to improve clarity when managing multiple IP entries. It allows users to annotate each rule (e.g. “Home”, “Office”, “VPN”) without affecting nginx behaviour. Backend changes: * Added optional `note` property to access list client schema. * Updated access list create/update endpoints to accept and persist `note`. * Kept `note` fully optional and backwards-compatible with existing data. * Ensured the nginx render filter outputs the note as a comment when present, preserving valid nginx syntax. Example image: <img width="445" height="455" alt="image" src="https://github.com/user-attachments/assets/42336485-02fb-4d8b-9451-3d09164a7d1d" /> Frontend changes: * Extended `AccessListClient` type with `note?: string`. * Added a note input field in the Access List modal (Rules tab). * Included `note` in API payload only when non-empty. * Added i18n placeholder text for the new field. * Widened the Access List modal to improve layout and usability with the additional column. If something is broken, or needs to be fixed, let me know. Thanks for your time! --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

kerem added the

pull-request

label

2026-02-26 08:33:23 +03:00

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/nginx-proxy-manager-NginxProxyManager#4176

No description provided.

Rows
Columns