fix: backport unraid/webgui#2269 rc.nginx update #1436
Conversation
WalkthroughThe changes introduce a new shell function and update configuration handling in the Unraid nginx service script, replacing legacy remote access checks with a modular approach that reads from updated config files. Supporting TypeScript code is added to automate patching this script for older Unraid versions, ensuring compatibility and improved reliability. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant RcNginxModification
participant rc.nginx (Shell Script)
participant api_utils.sh
participant connect.json
User->>RcNginxModification: Initiate patch process
RcNginxModification->>rc.nginx (Shell Script): Apply patch (if Unraid <7.2.0)
rc.nginx (Shell Script)->>api_utils.sh: Source utility functions
rc.nginx (Shell Script)->>connect.json: Parse config using jq
rc.nginx (Shell Script)->>rc.nginx (Shell Script): call check_remote_access()
rc.nginx (Shell Script)->>rc.nginx (Shell Script): build_ssl() uses new logic
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (10)
✅ Files skipped from review due to trivial changes (6)
🚧 Files skipped from review as they are similar to previous changes (1)
🧰 Additional context used📓 Path-based instructions (3)`api/**/*`: Use pnpm ONLY for package management. Always run scripts from api/pa...
📄 Source: CodeRabbit Inference Engine (CLAUDE.md) List of files the instruction was applied to:
`api/src/unraid-api/**/*`: Prefer adding new files to the NestJS repo located at api/src/unraid-api/ instead of the legacy code.
📄 Source: CodeRabbit Inference Engine (CLAUDE.md) List of files the instruction was applied to:
`api/src/unraid-api/**/*`: Prefer adding new files to the nest repo located at api/src/unraid-api/ instead of the legacy code.
📄 Source: CodeRabbit Inference Engine (.cursor/rules/api-rules.mdc) List of files the instruction was applied to:
🔇 Additional comments (9)
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
api/src/unraid-api/unraid-file-modifier/modifications/patches/rc-nginx.patch(1 hunks)api/src/unraid-api/unraid-file-modifier/modifications/rc-nginx.modification.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
`api/**/*`: Use pnpm ONLY for package management. Always run scripts from api/pa...
api/**/*: Use pnpm ONLY for package management.
Always run scripts from api/package.json unless requested.
Test suite is VITEST, do not use jest.
Run tests with: pnpm --filter ./api test.
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
api/src/unraid-api/unraid-file-modifier/modifications/patches/rc-nginx.patchapi/src/unraid-api/unraid-file-modifier/modifications/rc-nginx.modification.ts
`api/src/unraid-api/**/*`: Prefer adding new files to the NestJS repo located at api/src/unraid-api/ instead of the legacy code.
api/src/unraid-api/**/*: Prefer adding new files to the NestJS repo located at api/src/unraid-api/ instead of the legacy code.
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
api/src/unraid-api/unraid-file-modifier/modifications/patches/rc-nginx.patchapi/src/unraid-api/unraid-file-modifier/modifications/rc-nginx.modification.ts
`api/src/unraid-api/**/*`: Prefer adding new files to the nest repo located at api/src/unraid-api/ instead of the legacy code.
api/src/unraid-api/**/*: Prefer adding new files to the nest repo located at api/src/unraid-api/ instead of the legacy code.
📄 Source: CodeRabbit Inference Engine (.cursor/rules/api-rules.mdc)
List of files the instruction was applied to:
api/src/unraid-api/unraid-file-modifier/modifications/patches/rc-nginx.patchapi/src/unraid-api/unraid-file-modifier/modifications/rc-nginx.modification.ts
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: Test API
- GitHub Check: Build API
- GitHub Check: Build Web App
- GitHub Check: Build Unraid UI Library (Webcomponent Version)
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (10)
api/src/unraid-api/unraid-file-modifier/modifications/patches/rc-nginx.patch (4)
10-11: Configuration path updates are well-structured.The replacement of the legacy
MYSERVERSvariable withCONNECT_CONFIGandAPI_UTILSproperly points to the new configuration structure and utility scripts.
19-34: Robust remote access checking implementation.The new
check_remote_access()function provides a much cleaner and more reliable approach compared to the old grep-based method. The function properly:
- Validates file existence and tool availability
- Uses structured JSON parsing with
jq- Implements proper error handling with null checks
- Returns appropriate exit codes
44-44: Simplified condition logic improves maintainability.Replacing the complex grep-based condition with a simple function call significantly improves code readability and maintainability.
53-53: Shell syntax improvements follow best practices.Quoting the array key expansions
"${!NET_FQDN[@]}"and"${!NET_FQDN6[@]}"prevents potential word splitting issues and follows shell scripting best practices.Also applies to: 57-57
api/src/unraid-api/unraid-file-modifier/modifications/rc-nginx.modification.ts (6)
1-7: Clean imports and proper framework integration.The imports are well-organized and the class properly extends the FileModification framework.
28-34: Proper validation and error handling.The file existence check and content validation with meaningful error messages ensure the patch is applied to the correct target.
36-40: Variable replacement matches patch specification.The replacement of
MYSERVERSwithCONNECT_CONFIGandAPI_UTILSexactly matches the patch file.
42-62: Function insertion implementation is accurate.The
check_remote_accessfunction insertion matches the patch file exactly, including proper indentation and logic flow.
64-67: Condition replacement correctly implemented.The replacement of the complex grep condition with the function call matches the patch specification.
77-90: Version checking logic is well-implemented.The version checking correctly ensures the patch is only applied to Unraid versions < 7.2.0 with clear reasoning for both application and skipping scenarios.
api/src/unraid-api/unraid-file-modifier/modifications/rc-nginx.modification.ts
Show resolved
Hide resolved
| @@ -0,0 +1,60 @@ | |||
| Index: /etc/rc.d/rc.nginx | |||
There was a problem hiding this comment.
How does this file work will the diffing in this apply the changes?
There was a problem hiding this comment.
yup exactly, using the FileModifier functionality
Out of the box, File modification works like:
- check if the FileModification
shouldApply. If yes, continue. - check for a "pre-generated" patch using the
idof the FileModification (rc-nginx.patchin this case). - if a pre-gen'd patch is found, try applying it. if it fails, or if a pre-gen'd patch doesn't exist, create a patch via
generatePatch. - If the patch from
generatePatchfails, fail the file modification (i.e. no-op & log a warning)
So essentially, instead of directly modifying the file, we generate and apply a patch as an intermediate step.
this makes it easier to do rollbacks because we can revert a patch instead of defining additional custom logic for every modification.
|
This plugin has been deployed to Cloudflare R2 and is available for testing. |
🤖 I have created a release *beep* *boop* --- ## [4.9.0](v4.8.0...v4.9.0) (2025-07-08) ### Features * add graphql resource for API plugins ([#1420](#1420)) ([642a220](642a220)) * add management page for API keys ([#1408](#1408)) ([0788756](0788756)) * add rclone ([#1362](#1362)) ([5517e75](5517e75)) * API key management ([#1407](#1407)) ([d37dc3b](d37dc3b)) * api plugin management via CLI ([#1416](#1416)) ([3dcbfbe](3dcbfbe)) * build out docker components ([#1427](#1427)) ([711cc9a](711cc9a)) * docker and info resolver issues ([#1423](#1423)) ([9901039](9901039)) * fix shading in UPC to be less severe ([#1438](#1438)) ([b7c2407](b7c2407)) * info resolver cleanup ([#1425](#1425)) ([1b279bb](1b279bb)) * initial codeql setup ([#1390](#1390)) ([2ade7eb](2ade7eb)) * initialize claude code in codebse ([#1418](#1418)) ([b6c4ee6](b6c4ee6)) * move api key fetching to use api key service ([#1439](#1439)) ([86bea56](86bea56)) * move to cron v4 ([#1428](#1428)) ([b8035c2](b8035c2)) * move to iframe for changelog ([#1388](#1388)) ([fcd6fbc](fcd6fbc)) * native slackware package ([#1381](#1381)) ([4f63b4c](4f63b4c)) * send active unraid theme to docs ([#1400](#1400)) ([f71943b](f71943b)) * slightly better watch mode ([#1398](#1398)) ([881f1e0](881f1e0)) * upgrade nuxt-custom-elements ([#1461](#1461)) ([345e83b](345e83b)) * use bigint instead of long ([#1403](#1403)) ([574d572](574d572)) ### Bug Fixes * activation indicator removed ([5edfd82](5edfd82)) * alignment of settings on ManagementAccess settings page ([#1421](#1421)) ([70c790f](70c790f)) * allow rclone to fail to initialize ([#1453](#1453)) ([7c6f02a](7c6f02a)) * always download 7.1 versioned files for patching ([edc0d15](edc0d15)) * api `pnpm type-check` ([#1442](#1442)) ([3122bdb](3122bdb)) * **api:** connect config `email` validation ([#1454](#1454)) ([b9a1b9b](b9a1b9b)) * backport unraid/webgui[#2269](https://github.com/unraid/api/issues/2269) rc.nginx update ([#1436](#1436)) ([a7ef06e](a7ef06e)) * bigint ([e54d27a](e54d27a)) * config migration from `myservers.cfg` ([#1440](#1440)) ([c4c9984](c4c9984)) * **connect:** fatal race-condition in websocket disposal ([#1462](#1462)) ([0ec0de9](0ec0de9)) * **connect:** mothership connection ([#1464](#1464)) ([7be8bc8](7be8bc8)) * console hidden ([9b85e00](9b85e00)) * debounce is too long ([#1426](#1426)) ([f12d231](f12d231)) * delete legacy connect keys and ensure description ([22fe91c](22fe91c)) * **deps:** pin dependencies ([#1465](#1465)) ([ba75a40](ba75a40)) * **deps:** pin dependencies ([#1470](#1470)) ([412b329](412b329)) * **deps:** storybook v9 ([#1476](#1476)) ([45bb49b](45bb49b)) * **deps:** update all non-major dependencies ([#1366](#1366)) ([291ee47](291ee47)) * **deps:** update all non-major dependencies ([#1379](#1379)) ([8f70326](8f70326)) * **deps:** update all non-major dependencies ([#1389](#1389)) ([cb43f95](cb43f95)) * **deps:** update all non-major dependencies ([#1399](#1399)) ([68df344](68df344)) * **deps:** update dependency @types/diff to v8 ([#1393](#1393)) ([00da27d](00da27d)) * **deps:** update dependency cache-manager to v7 ([#1413](#1413)) ([9492c2a](9492c2a)) * **deps:** update dependency commander to v14 ([#1394](#1394)) ([106ea09](106ea09)) * **deps:** update dependency diff to v8 ([#1386](#1386)) ([e580f64](e580f64)) * **deps:** update dependency dotenv to v17 ([#1474](#1474)) ([d613bfa](d613bfa)) * **deps:** update dependency lucide-vue-next to ^0.509.0 ([#1383](#1383)) ([469333a](469333a)) * **deps:** update dependency marked to v16 ([#1444](#1444)) ([453a5b2](453a5b2)) * **deps:** update dependency shadcn-vue to v2 ([#1302](#1302)) ([26ecf77](26ecf77)) * **deps:** update dependency vue-sonner to v2 ([#1401](#1401)) ([53ca414](53ca414)) * disable file changes on Unraid 7.2 ([#1382](#1382)) ([02de89d](02de89d)) * do not start API with doinst.sh ([7d88b33](7d88b33)) * do not uninstall fully on 7.2 ([#1484](#1484)) ([2263881](2263881)) * drop console with terser ([a87d455](a87d455)) * error logs from `cloud` query when connect is not installed ([#1450](#1450)) ([719f460](719f460)) * flash backup integration with Unraid Connect config ([#1448](#1448)) ([038c582](038c582)) * header padding regression ([#1477](#1477)) ([e791cc6](e791cc6)) * incorrect state merging in redux store ([#1437](#1437)) ([17b7428](17b7428)) * lanip copy button not present ([#1459](#1459)) ([a280786](a280786)) * move to bigint scalar ([b625227](b625227)) * node_modules dir removed on plugin update ([#1406](#1406)) ([7b005cb](7b005cb)) * omit Connect actions in UPC when plugin is not installed ([#1417](#1417)) ([8c8a527](8c8a527)) * parsing of `ssoEnabled` in state.php ([#1455](#1455)) ([f542c8e](f542c8e)) * pin ranges ([#1460](#1460)) ([f88400e](f88400e)) * pr plugin promotion workflow ([#1456](#1456)) ([13bd9bb](13bd9bb)) * proper fallback if missing paths config modules ([7067e9e](7067e9e)) * rc.unraid-api now cleans up older dependencies ([#1404](#1404)) ([83076bb](83076bb)) * remote access lifecycle during boot & shutdown ([#1422](#1422)) ([7bc583b](7bc583b)) * sign out correctly on error ([#1452](#1452)) ([d08fc94](d08fc94)) * simplify usb listing ([#1402](#1402)) ([5355115](5355115)) * theme issues when sent from graph ([#1424](#1424)) ([75ad838](75ad838)) * **ui:** notifications positioning regression ([#1445](#1445)) ([f73e5e0](f73e5e0)) * use some instead of every for connect detection ([9ce2fee](9ce2fee)) ### Reverts * revert package.json dependency updates from commit 711cc9a for api and packages/* ([94420e4](94420e4)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Summary by CodeRabbit