[GH-ISSUE #47] [feature request]enhanced server object capabilities for easier access and modification of nginx configuration

kerem commented

2026-02-28 01:20:32 +03:00

Owner

Originally created by @mofantor on GitHub (Apr 22, 2024).
Original GitHub issue: https://github.com/tufanbarisyildirim/gonginx/issues/47

propose to enhance the server object by adding new attributes and methods that will simplify the access and modification of its listening configuration, location details, and other pertinent settings. The following are potential enhancements and features that could be incorporated：

// get server by servername
server := conf.GetBlock(*.config.HTTP).GetServerByServerName("example.com")

// get all listening ports for the server
listenPorts := server.GetListenPorts()

// change the first listen port configuration to 8080
server.Listens[0].SetListenPort(8080)

// retrieve all location configurations for the server
locations := server.GetLocations()

Please consider implementing these functionalities to streamline working with complex server configurations and encourage more robust and dynamic management of Nginx setup through this library.

Let's discuss the feasibility and potential implementation details for these enhancements under this issue thread.

Originally created by @mofantor on GitHub (Apr 22, 2024). Original GitHub issue: https://github.com/tufanbarisyildirim/gonginx/issues/47 propose to enhance the server object by adding new attributes and methods that will simplify the access and modification of its listening configuration, location details, and other pertinent settings. The following are potential enhancements and features that could be incorporated： ```go // get server by servername server := conf.GetBlock(*.config.HTTP).GetServerByServerName("example.com") // get all listening ports for the server listenPorts := server.GetListenPorts() // change the first listen port configuration to 8080 server.Listens[0].SetListenPort(8080) // retrieve all location configurations for the server locations := server.GetLocations() ``` Please consider implementing these functionalities to streamline working with complex server configurations and encourage more robust and dynamic management of Nginx setup through this library. Let's discuss the feasibility and potential implementation details for these enhancements under this issue thread.

kerem

2026-02-28 01:20:32 +03:00

closed this issue
added the
enhancement
label

kerem commented

2026-02-28 01:20:33 +03:00

Author

Owner

@tufanbarisyildirim commented on GitHub (Jun 8, 2024):

sounds good, would you like to take this?

@tufanbarisyildirim commented on GitHub (Jun 8, 2024): sounds good, would you like to take this?

kerem commented

2026-02-28 01:20:33 +03:00

Author

Owner

@mofantor commented on GitHub (Jun 11, 2024):

I would like to develop these features. Some of the features have already been implemented in the project I am working on. After the completion of the subsequent work, I will submit a Pull Request.

@mofantor commented on GitHub (Jun 11, 2024): I would like to develop these features. Some of the features have already been implemented in the project I am working on. After the completion of the subsequent work, I will submit a Pull Request.

kerem commented

2026-02-28 01:20:33 +03:00

Author

Owner

@tufanbarisyildirim commented on GitHub (Jun 11, 2024):

awesome! looking forward to it!

@tufanbarisyildirim commented on GitHub (Jun 11, 2024): awesome! looking forward to it!

kerem commented

2026-02-28 01:20:33 +03:00

Author

Owner

@tufanbarisyildirim commented on GitHub (Feb 20, 2026):

Thanks for the feature proposal. I’m interested in implementing this, but I need to confirm API shape/scope before coding.

GetServerByServerName("example.com"): should this return the first matching server or all matching servers?
For listen parsing, should GetListenPorts() include only numeric TCP ports, or also unix sockets / host:port forms / flags (e.g. listen 127.0.0.1:8080 ssl)?
Do you want a new typed Listen model (like your server.Listens[0].SetListenPort(8080) example), or would method-based APIs on Server be acceptable (GetListenPorts, SetListenPort helpers)?
For locations, should GetLocations() return only direct child location blocks, or include nested locations recursively?

Once you confirm these, I can open a focused PR.

@tufanbarisyildirim commented on GitHub (Feb 20, 2026): Thanks for the feature proposal. I’m interested in implementing this, but I need to confirm API shape/scope before coding. 1. `GetServerByServerName("example.com")`: should this return the first matching server or all matching servers? 2. For listen parsing, should `GetListenPorts()` include only numeric TCP ports, or also unix sockets / host:port forms / flags (e.g. `listen 127.0.0.1:8080 ssl`)? 3. Do you want a new typed `Listen` model (like your `server.Listens[0].SetListenPort(8080)` example), or would method-based APIs on `Server` be acceptable (`GetListenPorts`, `SetListenPort` helpers)? 4. For locations, should `GetLocations()` return only direct child `location` blocks, or include nested locations recursively? Once you confirm these, I can open a focused PR.

kerem commented

2026-02-28 01:20:33 +03:00

Author

Owner

@tufanbarisyildirim commented on GitHub (Feb 20, 2026):

Quick follow-up to unblock implementation: if this sounds good, I can proceed with these defaults in a PR:

GetServerByServerName(name string) *Server: return first match (nil if none)
GetListenPorts() []int: return only numeric TCP ports (ignore unix sockets/non-numeric forms)
No new Listen struct initially; add method-based helpers on Server
GetLocations() []*Location: return direct child location blocks only

Please confirm or adjust these 4 points.

@tufanbarisyildirim commented on GitHub (Feb 20, 2026): Quick follow-up to unblock implementation: if this sounds good, I can proceed with these defaults in a PR: 1. `GetServerByServerName(name string) *Server`: return first match (nil if none) 2. `GetListenPorts() []int`: return only numeric TCP ports (ignore unix sockets/non-numeric forms) 3. No new `Listen` struct initially; add method-based helpers on `Server` 4. `GetLocations() []*Location`: return direct child `location` blocks only Please confirm or adjust these 4 points.

kerem commented

2026-02-28 01:20:33 +03:00

Author

Owner

@tufanbarisyildirim commented on GitHub (Feb 20, 2026):

Can I proceed with the 4 defaults in my previous comment and open a PR? A simple "yes" (or 👍) is enough, and I’ll implement exactly that scope.

@tufanbarisyildirim commented on GitHub (Feb 20, 2026): Can I proceed with the 4 defaults in my previous comment and open a PR? A simple "yes" (or 👍) is enough, and I’ll implement exactly that scope.

kerem commented

2026-02-28 01:20:33 +03:00

Author

Owner

@tufanbarisyildirim commented on GitHub (Feb 20, 2026):

Checking in on ownership to unblock this: are you still planning to submit the PR you mentioned? If not, I can implement this with the default API scope described above and open a PR.

@tufanbarisyildirim commented on GitHub (Feb 20, 2026): Checking in on ownership to unblock this: are you still planning to submit the PR you mentioned? If not, I can implement this with the default API scope described above and open a PR.

kerem commented

2026-02-28 01:20:33 +03:00

Author

Owner

@tufanbarisyildirim commented on GitHub (Feb 20, 2026):

Final scope confirmation question to unblock this:

If there is no objection, can I proceed with the default minimal API set below?

HTTP.GetServerByServerName(name string) *Server (first match, nil if none)
Server.GetListenPorts() []int (numeric TCP ports only)
Server.GetLocations() []*Location (direct child locations only)

If you want different behavior, please list exact method signatures and rules and I’ll follow that instead.

@tufanbarisyildirim commented on GitHub (Feb 20, 2026): Final scope confirmation question to unblock this: If there is no objection, can I proceed with the default minimal API set below? - `HTTP.GetServerByServerName(name string) *Server` (first match, nil if none) - `Server.GetListenPorts() []int` (numeric TCP ports only) - `Server.GetLocations() []*Location` (direct child locations only) If you want different behavior, please list exact method signatures and rules and I’ll follow that instead.

kerem commented

2026-02-28 01:20:33 +03:00

Author

Owner

@tufanbarisyildirim commented on GitHub (Feb 20, 2026):

Owner decision and implementation is now in #78.

Chosen scope:

HTTP.GetServerByServerName(serverName string) *Server (first match)
Server.GetLocations() []*Location (direct child locations)
Server.GetListenPorts() []int (numeric ports)
Server.SetListenPort(index int, port int) error

This keeps API additions small and stable while directly covering the requested workflows (lookup, inspect, and mutate server listen/location configuration).

@tufanbarisyildirim commented on GitHub (Feb 20, 2026): Owner decision and implementation is now in #78. Chosen scope: - `HTTP.GetServerByServerName(serverName string) *Server` (first match) - `Server.GetLocations() []*Location` (direct child locations) - `Server.GetListenPorts() []int` (numeric ports) - `Server.SetListenPort(index int, port int) error` This keeps API additions small and stable while directly covering the requested workflows (lookup, inspect, and mutate server listen/location configuration).

kerem referenced this issue

2026-02-28 01:20:41 +03:00

[PR #21] [CLOSED] support parse set_by_lua_block $var {} #46

kerem referenced this issue

2026-02-28 01:20:46 +03:00

[PR #68] [MERGED] enhance: lua code parse and format dump #69

Rows
Columns

[GH-ISSUE #47] [feature request]enhanced server object capabilities for easier access and modification of nginx configuration #20