Desktop Server Mode
Run the embedded API server from the Gauzy Desktop app.
Overviewโ
Gauzy Desktop can run in Server Mode, which embeds a fully functional NestJS API server alongside the Electron desktop app. This is useful for:
- Standalone deployments without a separate server
- Small team setups
- Offline-first environments
Enabling Server Modeโ
- Open Desktop Settings
- Toggle Server Mode โ ON
- Configure:
- Port (default: 5620)
- Database type (SQLite or PostgreSQL)
- Auto-start on boot
- Click Start Server
Server Configurationโ
| Setting | Default | Description |
|---|---|---|
| Port | 5620 | API server port |
| DB Type | SQLite | Database backend |
| DB Path | ~/.gauzy/ | Database file location |
| Auto-start | Off | Start server on app launch |
| Background | Yes | Run in system tray |
Architectureโ
Accessing the APIโ
Once running, the API is available at:
http://localhost:5620/api
Limitationsโ
- SQLite only supports single-user concurrent access
- No Redis support in embedded mode
- Performance limited by desktop hardware
Related Pagesโ
- Desktop Overview โ desktop app guide
- Desktop Builds โ building from source