Updating Orbix
Each release of Orbix is listed in Changelog with the files it touches. Download the new version from your account downloads page at the store or marketplace where you purchased Orbix.
Recommended workflow
- Keep your project under version control (Git or similar) before changing anything.
- Extract the new version into a separate folder; never overwrite your project with it.
- Compare the new version with the version you started from (a folder diff tool such as WinMerge, Meld or
Beyond Compare, or
git diff --no-index old/ new/). Since your own code lives in your pages, page models, services, configuration and CSS files, most updates come down to a few files. - Copy what you need:
src/Orbix/packages/foundry-ui/(the design system) can usually be replaced as a whole.ClientApp/css/orbix/,ClientApp/js/core/,Infrastructure/andPages/Shared/hold the template code: merge the changes into your copies if you edited them.- New pages: copy the Razor pages, their entries in
PageRoutes.cs, their menu entries and their keys inLocales/*.json.
- Run
npm ci,npm run build(insrc/Orbix) anddotnet test.
Updating .NET and the dependencies
Orbix targets .NET 10 (LTS) and references no NuGet package in the web app. Apply the monthly .NET servicing
updates by installing the latest 10.0 SDK and runtime; for a future major version, change TargetFramework in
Directory.Build.props, update global.json and follow Microsoft's migration guide. Test packages update with
dotnet list package --outdated and dotnet add package; npm packages with npm update, followed by
npm run build and the tests.
Keeping customizations easy to update
- Add new styles in your own CSS files instead of editing the Orbix ones.
- Set the theme defaults in
initTheme()(see Theming) instead of editing tokens. - Add translation keys with your own prefix (
app.*) so new Orbix keys never collide with yours. - Put your services and page models in your own folders; keep
Infrastructure/as shipped where you can.