Before you begin
- A supported x64 Windows computer
- The current Community Edition Windows installer from /download
- An organization name, administrator email, and password for first setup
- Permission to add a firewall rule if the server will accept LAN connections
Download and verify the installer
- 1
Choose the Windows server package
Open /download and select the Windows x64 EXE under Server Community Edition. Chat desktop downloads are a different product.
- 2
Compare its SHA-256
Open PowerShell in the folder containing the downloaded EXE. Use Get-FileHash and compare the complete value with the SHA-256 shown for that exact filename on /download.
- 3
Check the publisher signature
Use Get-AuthenticodeSignature and confirm that the release installer has a valid Orchestris publisher signature before running it.
$installer = Get-ChildItem ".\Orchestris-Setup-*-windows-x64.exe" |
Sort-Object LastWriteTime -Descending |
Select-Object -First 1
if (-not $installer) { throw "Community Edition installer not found in this folder." }
Get-FileHash -Algorithm SHA256 $installer.FullName
Get-AuthenticodeSignature $installer.FullName | Format-List Status,SignerCertificateInstall and create the first administrator
- 1
Run the installer as your Windows user
Double-click the downloaded EXE and follow the setup wizard. The package is a per-user installation under %LOCALAPPDATA% and does not install a Windows service. Read the first wizard page: it reports Fresh installation, Complete pending setup, Upgrade existing installation, or Recovery required before making changes.
- 2
Create the workspace
For a fresh or interrupted first setup, enter the organization name, administrator email, and password. The password is used for one-time initialization and is not written to orchestris.env. An upgrade preserves the established organization, credentials, ports, configuration, and database instead of asking for replacements.
- 3
Choose network access
Keep This computer only for 127.0.0.1 access, or intentionally choose LAN/custom access, a port, and the public API origin clients will use. The default is http://localhost:8080.
- 4
Finish and start
The installer checks the selected addresses and ports, initializes SQLite, and offers to start the tray-managed API and Admin pair. Optional sign-in autostart launches the tray for this user.
Start, stop, and verify Community Edition
Open Orchestris from the Start Menu to launch the tray. It supervises the API and bundled Admin together and provides Open Orchestris, Open Admin UI, Status, Start Server, Restart Server, Stop Server, and Exit Orchestris. The package does not install a Windows service.
$health = Invoke-WebRequest http://127.0.0.1:8080/health
$chat = Invoke-WebRequest http://127.0.0.1:8080/app/
$admin = Invoke-WebRequest http://127.0.0.1:3000/api/health/ready
"Health: $($health.StatusCode)"
"Hosted Chat: $($chat.StatusCode)"
"Admin: $($admin.StatusCode)"All three checks should print status 200. Open Orchestris launches hosted Chat at /app/ on the Server origin; Open Admin UI launches the distinct configured Admin origin. If a check fails, open Status and inspect the listed component logs.
Know what to back up
| Purpose | Location |
|---|---|
| Installed application | %LOCALAPPDATA%\Programs\Orchestris |
| Secret-bearing configuration | %LOCALAPPDATA%\Orchestris\orchestris.env |
| SQLite database | %LOCALAPPDATA%\Orchestris\orchestris.db |
| API and Admin logs | %LOCALAPPDATA%\Orchestris\logs\orchestris-api.*.log and orchestris-admin.*.log |
| Automatic upgrade backups | %LOCALAPPDATA%\Orchestris\backups\upgrade-<timestamp> |
- Purpose
- Installed application
- Location
- %LOCALAPPDATA%\Programs\Orchestris
- Purpose
- Secret-bearing configuration
- Location
- %LOCALAPPDATA%\Orchestris\orchestris.env
- Purpose
- SQLite database
- Location
- %LOCALAPPDATA%\Orchestris\orchestris.db
- Purpose
- API and Admin logs
- Location
- %LOCALAPPDATA%\Orchestris\logs\orchestris-api.*.log and orchestris-admin.*.log
- Purpose
- Automatic upgrade backups
- Location
- %LOCALAPPDATA%\Orchestris\backups\upgrade-<timestamp>
Change network configuration deliberately
Loopback access needs no inbound firewall exposure. LAN or reverse-proxy access requires a reviewed bind address, the actual HTTP(S) public API origin, and any required Windows Firewall rule. The installer checks whether it can bind the selected address and port but does not create a firewall rule.
$install = "$env:LOCALAPPDATA\Programs\Orchestris"
$state = "$env:LOCALAPPDATA\Orchestris"
& "$install\run-orchestris.ps1" -InstallDir $install -StateDir $state `
-EnvFile "$state\orchestris.env" -ConfigCheckAfter changing Server settings—or the Admin host, port, public origin, and trusted-proxy settings as one consistent group—run the configuration check and restart the complete application from the tray. Plain HTTP Admin must remain loopback-only; remote Admin requires HTTPS and explicit proxy trust.
Upgrade or remove Windows Community Edition
- 1
Create a complete independent backup
Stop the server from the tray, then copy the entire %LOCALAPPDATA%\Orchestris directory to protected backup storage. Verify that the backup contains orchestris.env, orchestris.db, and any WAL/SHM files before upgrading.
- 2
Upgrade in place
Download and verify the newer EXE, then run it as the same Windows user. Setup stops only the installed Orchestris tray, Admin, and API processes before replacing the release unit.
- 3
Treat the installer snapshot as best-effort
Setup attempts to copy the environment, database, WAL, and SHM files into a timestamped directory and retains the latest five automatic snapshots. Individual copies can fail or the snapshot can be skipped, and it does not include the complete state directory. It is not a substitute for the independent stopped-state backup.
- 4
Verify after upgrade
Start the tray, check Status and its logs, then verify /health, /app/, and Admin readiness before changing providers or inviting users.
- 5
Uninstall the application
Use Uninstall Orchestris from the Start Menu or Windows Installed Apps. Uninstall stops the tray, Admin, and API and removes installer-owned application files.
- 6
Decide whether to retain data
Uninstall intentionally preserves %LOCALAPPDATA%\Orchestris. Remove that state manually only after verifying a backup and deciding that the database, secrets, logs, and upgrade backups are no longer needed.