Consistently use -Dserver.port or -Dport or -Dhttp.port for Okapi HTTP port
Description
Environment
None
Potential Workaround
None
blocks
Checklist
hideTestRail: Results
Activity
Show:
David Crossley March 5, 2025 at 6:40 AM
Another Slack discussion arose on #development 2025-03-04, and surrounding threads.
Julian Ladisch March 4, 2025 at 9:15 PM
Spring Boot based modules (FOLIO Spring way; Grails) also look at the SERVER_PORT environment variable: https://docs.spring.io/spring-boot/how-to/webserver.html#howto.webserver.change-port
David Crossley February 8, 2022 at 2:15 AM
When something is decided then need to clarify https://github.com/folio-org/okapi/blob/master/doc/guide.md#compiling-and-running and perhaps an FAQ at dev.f.o
There is a recent Slack discussion (#development 2022-02-05) about new Spring modules using a new option "server.port".
Details
Details
Assignee
Unassigned
UnassignedReporter
Julian Ladisch
Julian LadischLabels
Priority
TBDSprint
Development Team
Core: Platform
TestRail: Cases
Open TestRail: Cases
TestRail: Runs
Open TestRail: Runs
Created November 17, 2020 at 1:05 PM
Updated March 5, 2025 at 6:40 AM
TestRail: Cases
TestRail: Runs
RMB has been using -Dhttp.port to define which port to listen on. Most back-end modules use RMB.
Spring based modules use -Dserver.port.
Other modules use -Dport.
When deploying using Okapi this is not relevant because the "launchDescriptor" in the ModuleDescriptor use the %p placeholder.
However, for other deploy methods like Debian packages https://github.com/drexljo/folio-projects such a configuration option is needed.
This Jira is to decide whether we
let each module decide which option to use (-Dserver.port or -Dhttp.port or -Dport or any other)
suggest that all modules should support at least -Dserver.port
suggest that all modules should support at least -Dport
suggest that all modules should support at least -Dhttp.port
A GitHub search finds
about 35000 hits for -Dserver.port https://github.com/search?q=%22-Dserver.port%22&type=code
about 23000 hits for -Dport https://github.com/search?q=%22-Dport%22&type=code
about 7000 hits for -Dhttp.port https://github.com/search?q=%22-Dhttp.port%22&type=code
Some modules do not get HTTP requests from Okapi but requests in a different protocol, for example edge-sip2. This is not HTTP and http.port might be a misleading name.