Windows GUI Manager & Installer for OmniRoute

[Banajitpathak]

Hi @diegosouzapw,

I've created a lightweight Windows GUI manager and installer wrapper for OmniRoute to help Windows users easily install, start, stop, and update the server using a PowerShell GUI.

You can find the repository here: https://github.com/Banajitpathak/omniroute_installer

I have released it under the MIT License and included full attribution to your core project. If you think this would be useful to other Windows users, feel free to link it, or let me know if you have any suggestions or feedback!

Thanks for the great core application!

[zs819]

Thx a lot, I think this is very useful for windows user.

I just got some issue:

01:06:49 - Welcome to the OmniRoute Dashboard!
01:08:28 - Starting Installation Wizard...
01:08:28 - Git is found, skipping installation.
01:08:28 - Node.js is found, skipping installation.
01:08:28 - NPM is found, skipping installation.
01:08:28 - Cloning OmniRoute repository...
01:08:28 - Cloning into 'C:\omniroute'...
01:08:48 - error: RPC failed; curl 56 schannel: server closed abruptly (missing close_notify)
01:08:48 - error: 1996 bytes of body are still expected
01:08:48 - fetch-pack: unexpected disconnect while reading sideband packet
01:08:48 - fatal: early EOF
01:08:48 - fatal: fetch-pack: invalid index-pack output
01:08:48 - Applying Windows-specific build fixes to cloned repository...
01:08:48 - Starting OmniRoute server... (Running Minimized to prevent crashes)
01:08:48 - Silencing Windows Firewall... (Please click 'Yes' if prompted)
01:08:50 - Server is starting...
01:08:53 - Opening Dashboard in your web browser...
01:10:00 - Starting Installation Wizard...
01:10:00 - Git is found, skipping installation.
01:10:00 - Node.js is found, skipping installation.
01:10:00 - NPM is found, skipping installation.
01:10:00 - Cloning OmniRoute repository...
01:10:00 - Cloning into 'C:\omniroute'...
01:10:15 - error: RPC failed; curl 56 schannel: server closed abruptly (missing close_notify)
01:10:15 - error: 3057 bytes of body are still expected
01:10:15 - fetch-pack: unexpected disconnect while reading sideband packet
01:10:15 - fatal: early EOF
01:10:15 - fatal: fetch-pack: invalid index-pack output
01:10:15 - Applying Windows-specific build fixes to cloned repository...
01:10:15 - Starting OmniRoute server... (Running Minimized to prevent crashes)
01:10:15 - Server is starting...
01:10:19 - Opening Dashboard in your web browser...

[zs819]

Thx for your tool, it's too hard for windows user, either wsl or windows native, many warning many failure during install or update, the command "npm install -g omniroute" doesn't work, i use agent to code a install shell, then it's done, but got too hard to update to ver 47, failed.

~$ npm install -g omniroute
npm warn ERESOLVE overriding peer dependency
npm warn While resolving: @emoji-mart/react@1.1.1
npm warn Found: react@19.2.7
npm warn node_modules/omniroute/node_modules/react
npm warn react@"19.2.7" from omniroute@3.8.47
npm warn node_modules/omniroute
npm warn omniroute@"" from the root project
npm warn 59 more (@dnd-kit/core, react-dom, @dnd-kit/sortable, ...)
npm warn
npm warn Could not resolve dependency:
npm warn peer react@"^16.8 || ^17 || ^18" from @emoji-mart/react@1.1.1
npm warn node_modules/omniroute/node_modules/@emoji-mart/react
npm warn @emoji-mart/react@"^1.1.1" from @lobehub/ui@5.20.2
npm warn node_modules/omniroute/node_modules/@lobehub/ui
npm warn
npm warn Conflicting peer dependency: react@18.3.1
npm warn node_modules/react
npm warn peer react@"^16.8 || ^17 || ^18" from @emoji-mart/react@1.1.1
npm warn node_modules/omniroute/node_modules/@emoji-mart/react
npm warn @emoji-mart/react@"^1.1.1" from @lobehub/ui@5.20.2
npm warn node_modules/omniroute/node_modules/@lobehub/ui
npm warn ERESOLVE overriding peer dependency
npm warn While resolving: marked-terminal@7.3.0
npm warn Found: marked@18.0.6
npm warn node_modules/omniroute/node_modules/marked
npm warn marked@"^18.0.4" from omniroute@3.8.47
npm warn node_modules/omniroute
npm warn omniroute@"" from the root project
npm warn
npm warn Could not resolve dependency:
npm warn peer marked@">=1 <16" from marked-terminal@7.3.0
npm warn node_modules/omniroute/node_modules/marked-terminal
npm warn marked-terminal@"^7.3.0" from omniroute@3.8.47
npm warn node_modules/omniroute
npm warn
npm warn Conflicting peer dependency: marked@15.0.12
npm warn node_modules/marked
npm warn peer marked@">=1 <16" from marked-terminal@7.3.0
npm warn node_modules/omniroute/node_modules/marked-terminal
npm warn marked-terminal@"^7.3.0" from omniroute@3.8.47
npm warn node_modules/omniroute
npm warn deprecated intersection-observer@0.12.2: The Intersection Observer polyfill is no longer needed and can safely be removed. Intersection Observer has been Baseline since 2019.
npm warn deprecated shiki-stream@0.1.5: shiki-stream is now @shikijs/stream, please migrate by renaming the package
npm warn deprecated boolean@3.2.0: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.
⠏

[Banajitpathak]

"Hi! Thanks for the feedback and for using the tool. Windows installation and updates can indeed be tricky due to how dependencies and build locks are managed.

Here is what went wrong and how to fix it:

1. Why npm install -g omniroute failed / printed warnings
   Standard npm (version 7+) strictly checks peer dependencies. The core omniroute application uses React 19, but some nested UI packages still require React 18. This triggers peer dependency conflicts (ERESOLVE).

To fix it via npm: Run the command with the legacy peer dependency flag so npm ignores the strict check:
bash

npm install -g omniroute --legacy-peer-deps
Recommended way: Use the installer (OmniRoute_Manager.bat). It clones the repo and uses pnpm (which handles these overrides and builds the standalone production version correctly).
2. Why the update to version 47 failed
This was caused by a stale Next.js build lock file (.build/next/lock) left over in the directory, which blocked the compiler and caused the server startup to crash with a Could not find a production build error.

I have just updated the installer to automatically clear these stale build locks before compiling. If you download the latest version of the installer from the GitHub repository and run the update via the GUI, it will work smoothly now!

Also, feel free to check out the updated README.md in the GitHub repository (https://github.com/Banajitpathak/omniroute_installer) — I've added a dedicated "Troubleshooting & Tips" section explaining these exact issues to help other users facing the same problems."

Also, feel free to check out the updated README.md in the GitHub repository (https://github.com/Banajitpathak/omniroute_installer) — I've added a dedicated "Troubleshooting & Tips" section explaining these exact issues to help other users facing the same problems.

[diegosouzapw]

Hey @Banajitpathak! This is great work -- thanks for building it and for the MIT license + attribution. Windows onboarding is genuinely our weakest spot, so a GUI manager helps a lot.

Two suggestions from the maintainer side:

1. Prefer the npm tarball over git clone as the install source. The clone errors @zs819 hit (curl 56 schannel ... early EOF) are typical of fetching the full repo history over flaky connections -- the repo is large. npm install -g omniroute downloads a small prebuilt package instead, and no local build is needed. The v3.8.47 npm package was broken ([BUG] Its not opening #7065), which is probably why you went the clone route -- that is fixed in v3.8.48, so the npm path is reliable again. If you keep a clone fallback, git clone --depth 1 cuts the transfer drastically.
2. The ERESOLVE peer-dependency warnings @zs819 saw with npm are warnings only (React 19 vs a nested React 18 peer range) -- they do not fail the install.

I will keep an eye on the repo -- feel free to open issues here when the wrapper trips over something on our side (like the packaging bug above). Thanks again!

[zs819]

@diegosouzapw @Banajitpathak thx all of you, thx a lot, all repos are both very helpful for me, the main problem is crap windows, that's the point!

[Banajitpathak]

"Hey! Thanks for the excellent suggestions. I've updated the installer to:

Prioritize npm install -g omniroute --legacy-peer-deps (which resolves the React peer warnings and installs in seconds).
Fall back to a shallow Git clone (git clone --depth 1) if the NPM path fails.
Clean up the global package on uninstall via npm uninstall -g.
The updates are now pushed to the repository!"

[Banajitpathak]

Thanks for the heads-up!

I have updated the repository with a few improvements:

1. Automated Workaround: The installer now automatically handles this native-module issue. Right after a global install, update, or local fallback clone setup, the script automatically triggers a native rebuild (npm rebuild better-sqlite3 -g / pnpm rebuild better-sqlite3). This compiles the module to the correct local Node.js ABI proactively so the user doesn't hit the 500 error.
2. Added to Troubleshooting: I've also documented the manual rebuild commands in the README.md troubleshooting section just in case.
3. Non-blocking GUI & Robust Server Teardown: Refactored the long-running install/build process to be asynchronous (preventing GUI "Not Responding" hangs) and added port checks to terminate orphaned background servers before updates or exit.

Appreciate the guidance!

[diegosouzapw]

@Banajitpathak -- that was a fast turnaround, thanks. Prioritizing the npm path with --depth 1 clone as fallback and cleaning up the global package on uninstall is exactly the right shape.

One heads-up worth pulling into your troubleshooting section: the packaged Electron/portable builds from v3.8.45 through v3.8.48 have a native-module bug (#7132) where the standalone bundle loads a better-sqlite3 compiled for the wrong ABI, falls back to sql.js, and then 500s on any existing database. Fix is in PR #7123. It does not affect the plain npm install -g omniroute path once better-sqlite3 builds locally -- but if a user reports "worked on first run, Internal Server Error afterwards", that is this bug and not your installer. npm rebuild better-sqlite3 inside node_modules/omniroute/dist is the current workaround.

Keep the issues coming when the wrapper trips on something on our side.

[diegosouzapw]

@Banajitpathak -- that is exactly the right move. Wiring npm rebuild better-sqlite3 right after install/update proactively sidesteps the ABI mismatch before a user ever hits the 500, and documenting the manual command in your troubleshooting section covers the fallback. Nice turnaround.

One forward-looking note so your workaround can eventually retire: the root cause on the packaged side (#7132) is being fixed upstream in PR #7123 -- once that lands, the standalone bundle stops shipping a wrong-ABI better-sqlite3 in the first place, so the rebuild step becomes belt-and-suspenders rather than load-bearing. No action needed on your end; keeping the rebuild is harmless and still helps the plain-clone path. Appreciate you keeping the wrapper in step with our releases -- Windows onboarding is measurably better for it.

[diegosouzapw]

Fechando como inativo (stale).

Obrigado pelo trabalho e pela atualização no PR. Como esta thread ficou sem novas respostas por mais de 15 dias após a última interação do mantenedor, estou encerrando para manter a fila organizada.