Before you begin
- A chosen product path from the Getting Started guide
Requirements for Orchestris Chat
| Device | Published package | What to check |
|---|---|---|
| Windows x64 | Setup installer (.exe) | The minimum Windows version shown for the current artifact. |
| macOS Apple Silicon (arm64) | Installer package (.pkg) | The minimum macOS version shown for the current artifact; Intel Macs are not the current target. |
| Linux x64 | Debian package (.deb) or RPM package (.rpm) | The distribution requirements and package format shown on /download. |
- Device
- Windows x64
- Published package
- Setup installer (.exe)
- What to check
- The minimum Windows version shown for the current artifact.
- Device
- macOS Apple Silicon (arm64)
- Published package
- Installer package (.pkg)
- What to check
- The minimum macOS version shown for the current artifact; Intel Macs are not the current target.
- Device
- Linux x64
- Published package
- Debian package (.deb) or RPM package (.rpm)
- What to check
- The distribution requirements and package format shown on /download.
- Keep Chat's application-data directory on a local, writable filesystem and preserve it during upgrades.
- For direct-provider use, the device must reach that provider endpoint. The provider credential is stored through the operating system's protected credential storage.
- For server use, the device must reach the server's public HTTP(S) origin. Use trusted HTTPS except for same-machine local setup.
- Check that the installed Chat window opens and that Settings → API Providers and Servers are available.
Requirements for Community Edition
| Install path | Host and lifecycle | Persistent state |
|---|---|---|
| Windows native | Windows x64. A per-user tray application starts and stops the server; no Windows service is installed. | The complete %LOCALAPPDATA%\Orchestris directory. |
| macOS native | Apple Silicon (arm64), macOS 13.5 or newer. The installing user operates API and Admin through the graphical Orchestris menu-bar app. | The complete ~/Library/Application Support/Orchestris directory. |
| Linux native | Linux x64 with systemd and the supported DEB or RPM path shown on /download. | /etc/orchestris together with the complete /var/lib/orchestris directory. |
| Docker | Linux x64/amd64 with Docker Engine. Use the current image tag or immutable digest from /download. | The complete named /data volume. |
- Install path
- Windows native
- Host and lifecycle
- Windows x64. A per-user tray application starts and stops the server; no Windows service is installed.
- Persistent state
- The complete %LOCALAPPDATA%\Orchestris directory.
- Install path
- macOS native
- Host and lifecycle
- Apple Silicon (arm64), macOS 13.5 or newer. The installing user operates API and Admin through the graphical Orchestris menu-bar app.
- Persistent state
- The complete ~/Library/Application Support/Orchestris directory.
- Install path
- Linux native
- Host and lifecycle
- Linux x64 with systemd and the supported DEB or RPM path shown on /download.
- Persistent state
- /etc/orchestris together with the complete /var/lib/orchestris directory.
- Install path
- Docker
- Host and lifecycle
- Linux x64/amd64 with Docker Engine. Use the current image tag or immutable digest from /download.
- Persistent state
- The complete named /data volume.
- For same-machine evaluation, keep the default loopback address and port 8080.
- For another device, choose one stable client-visible origin, configure the required firewall rule, and use trusted HTTPS.
- The server must reach each configured model or search provider.
- Hosted Chat is served at /app/ on the server origin.
- Community Edition includes release-matched Admin at http://127.0.0.1:3000 by default. It is a separate origin from hosted Chat at /app/; use trusted HTTPS rather than remote plaintext for administration from another device.
Requirements for Private Deployment
The delivery bundle and deployment handoff define the supported server package, architecture, topology, and capacity plan. Do not substitute the Community Edition image or infer a licensed topology from the public download list.
- Single-node deployments use SQLite or PostgreSQL only as approved by the delivery plan.
- Multi-node deployments require PostgreSQL plus the Redis-backed coordination named in the delivery plan; never share one SQLite file between nodes.
- A licensed self-hosted server must reach the Orchestris licensing portal over HTTPS and each configured provider endpoint.
- Prepare the public origin, trusted TLS, database, backup target, monitoring, and secret manager assigned in the handoff.
- Back up the database and the matching encryption, hashing, synchronization, deployment, and authentication keys as one recoverable generation.
Validate capacity for your workload
There is no single CPU or memory number that represents every deployment. Concurrent users, prompt size, files and search, retention, reports, database choice, and provider latency all change the result.
- For a desktop install, verify the published operating-system requirement and leave enough local space for the conversations and files that remain on that device.
- For Community Edition, test sign-in, representative prompts, files, search, and the expected number of concurrent users on the intended host.
- For Private Deployment, use the capacity plan and load test supplied for the agreed topology.
- Monitor storage growth, request latency, provider errors, and database health before increasing rollout.