hansjone/netx
1
0
Fork 0
mirror of https://github.com/hansjone/netx.git synced 2026-10-08 22:20:58 +08:00
Code Issues Projects Releases 1 Packages Wiki Activity Actions 4
netx/packaging/README.md
oliver 477ec4b120 Add Windows packaging with bundled UI and dual-mode PostgreSQL. 
Ship installable releases via zip/Inno Setup with optional bundled Postgres, API-hosted SPA, manual update path, and CI workflow for future tag builds.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-06 22:52:03 +08:00

3.2 KiB
Raw Blame History

NetX Windows packaging

Linux is unchanged: keep using your own PostgreSQL and NETX_DATABASE_URL with scripts/start_netx.sh. Nothing under this folder is required on Linux.

This directory builds a Windows deliverable with:

  • Optional bundled portable PostgreSQL or external existing Postgres
  • API-hosted UI (web/dist) — no separate Vite process for end users
  • Program / data split so upgrades do not wipe the database
  • Manual update script + auto-update manifest contract (fetch not implemented yet)

What users get

Artifact How
NetX-x.y.z-win64.zip build_release.ps1
NetX-Setup-x.y.z.exe Compile installer/netx.iss with Inno Setup after staging

Build (developer machine)

Prerequisites: Python 3.11+, Node 20+, PowerShell, network (to download PG binaries once).

cd netx
# Optional: download portable Postgres into packaging\postgres\pgsql
powershell -ExecutionPolicy Bypass -File .\packaging\download_postgres.ps1

# Build web + stage + zip (-CreateVenv ships a ready .venv; large)
powershell -ExecutionPolicy Bypass -File .\packaging\build_release.ps1 -CreateVenv

Output:

  • packaging/release/netx-win64/ — stage tree
  • packaging/release/NetX-<ver>-win64.zip

Inno Setup:

ISCC.exe packaging\installer\netx.iss

Override version in the .iss or edit #define MyAppVersion.

End-user install

Setup.exe

  1. Run NetX-Setup-x.y.z.exe (admin).
  2. Files → %ProgramFiles%\NetX\ (program root).
  3. Data → %ProgramData%\NetX\ (.env, pgdata, spool, secrets).
  4. Optional post-install task runs setup_first_run.ps1 (choose bundled vs external DB).
  5. Start menu: Start NetX / Stop NetX / Open NetX UI.

Zip (portable)

  1. Unpack anywhere.
  2. Marker .portable → data root is sibling NetXData\.
  3. Target needs Python 3.11+ on PATH unless the zip was built with -CreateVenv.
  4. Run:
.\packaging\setup_first_run.ps1
.\packaging\start_netx_app.ps1

Database modes

Mode Behavior
bundled Start portable PG on 127.0.0.1:15432, data in data-root pgdata\
external Do not start PG; use NETX_DATABASE_URL (same as today / Linux)
unset Treated as external

Existing Windows deploys that only set NETX_DATABASE_URL keep working: never set NETX_DB_MODE=bundled unless you want the portable engine.

Manual update

.\packaging\update_netx.ps1 -PackagePath .\NetX-0.3.0-win64.zip

Stops services, replaces program folders (netx_api, web, packaging, postgres, …), keeps the data root, restarts. Schema migrations still run via Alembic on API start.

Auto-update (reserved)

See manifest.example.json. Future: set NETX_UPDATE_URL + NETX_UPDATE_CHANNEL; a checker will download the zip and call update_netx.ps1. Not implemented in this phase.

Layout reminder

Program root (replaceable)     Data root (never wiped by update)
  netx_api\  web\dist\           .env
  postgres\pgsql\                pgdata\     (bundled only)
  packaging\  scripts\           data\auth\  data\runtime\
  version.json                   backups\