Skip to main content

Desktop Server

The Desktop Server bundles the Gauzy API inside an Electron application for self-hosted deployments.

Purpose​

Run the entire Gauzy backend locally without Docker or separate server infrastructure. Ideal for:

  • Small teams wanting a local deployment
  • Demo and evaluation purposes
  • Air-gapped environments
  • Development and testing

Architecture​

Desktop Server (Electron)
β”œβ”€β”€ Main Process
β”‚   β”œβ”€β”€ Embedded NestJS API Server
β”‚   β”œβ”€β”€ SQLite/PostgreSQL Connection
β”‚   β”œβ”€β”€ Tray Icon
β”‚   └── Server Status Monitor
β”‚
└── Renderer Process
    β”œβ”€β”€ Server Configuration UI
    β”œβ”€β”€ Database Settings
    β”œβ”€β”€ Port Configuration
    └── Log Viewer

Features​

  • Embedded API β€” full NestJS API runs inside the Electron app
  • Database management β€” configure SQLite or PostgreSQL connection
  • Port configuration β€” set API server port
  • Auto-start β€” start server on system boot
  • Log viewer β€” view API logs in real-time
  • Status monitor β€” server health and uptime

Configuration​

SettingDefaultDescription
API Port3000Server port
DatabaseSQLiteDatabase type
Auto-startOffStart on boot
Log levelInfoLogging verbosity

Usage​

  1. Download and install Desktop Server
  2. Launch the application
  3. Configure database connection
  4. Click Start Server
  5. Access the webapp at http://localhost:4200
  6. Desktop Timer connects to http://localhost:3000