Skip to content

feat(access-list): add optional note field to access list clients#5333

Open
TheMazeIsAmazing wants to merge 4 commits intoNginxProxyManager:developfrom
TheMazeIsAmazing:develop
Open

feat(access-list): add optional note field to access list clients#5333
TheMazeIsAmazing wants to merge 4 commits intoNginxProxyManager:developfrom
TheMazeIsAmazing:develop

Conversation

@TheMazeIsAmazing
Copy link

@TheMazeIsAmazing TheMazeIsAmazing commented Feb 20, 2026

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:
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!

… widen modal

- Add optional note property to access list clients in backend model and schema
- Extend OpenAPI schemas (common + access-list endpoints) to support note
- Created necessary migration to add the note row to access_list_client table
- Persist note in access_list_client inserts/updates
- Render note in nginx config as inline comment for access rules (when present)
- Extend frontend AccessListClient model with optional note
- Add note input field to Access List modal (Rules tab)
- Only include note in payload when non-empty
- Add i18n placeholder for note field
- Increase Access List modal width for improved usability
@TheMazeIsAmazing TheMazeIsAmazing changed the base branch from develop to v3-abandoned February 24, 2026 21:49
@TheMazeIsAmazing TheMazeIsAmazing changed the base branch from v3-abandoned to develop February 24, 2026 21:49
@nginxproxymanagerci
Copy link

Docker Image for build 5 is available on DockerHub:

nginxproxymanager/nginx-proxy-manager-dev:pr-5333

Note

Ensure you backup your NPM instance before testing this image! Especially if there are database changes.
This is a different docker image namespace than the official image.

Warning

Changes and additions to DNS Providers require verification by at least 2 members of the community!

@TheMazeIsAmazing
Copy link
Author

Update 27 feb. 2026: Just added localizations for all available languages in the develop branch!
I've also tested the docker image, and all functionality seems to work as expected, so it's ready for review @jc21 !

Thanks in advance for your feedback and time 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant