Run documentation without MailGen
Use an Architecture checkout and running Docker to read setup without the full application. You do not need a root .env, host Node.js/Python, Kafka, database, shared proxy, or application setup. Use Bash on Linux/macOS. Start Docker Desktop on macOS or obtain Docker Engine access on Linux.
Install MailGen on a new machine
Install MailGen on a new macOS or Debian machine, then sign in and open a connected mailbox. This guide uses unified Docker Compose. BFF serves the browser workspace. Account handles login. Backend workers and .NET services process mailbox data.
Configure Google Cloud for your deployment
Prepare Google Cloud for a MailGen deployment with personal Gmail or approved Workspace access. This guide produces separate OAuth client credentials and optional authenticated push routing.
Prepare a separate test environment
Use the separate test environment when an explicitly requested check needs fresh storage instead of the normal local databases. It can remain prepared for later work. It does not start automatically or schedule tests.
Configure application login
Configure the Account service before users follow first login. Application login proves identity. Mailbox connection and provider access remain separate.
Complexity custom runtime
Deploy native Complexity views with COMPLEXITYCUSTOMRUNTIME_ENABLED=0 unless the target host passes the custom-runtime containment checks. The root Compose configuration defaults to 0.
Install generated UI support
Generated UI rendering is part of the BFF. Complexity handles generation and history. There is no required separate renderer service or hosted Gateway.
Microsoft Graph setup
Prepare Microsoft Graph application access before importing or synchronizing a Microsoft mailbox. This guide covers MailGen's backend application identity. Configure interactive sign-in separately through account login setup.
Use selected remote infrastructure
partialRemote connects selected background infrastructure to remote services. Application processes and the primary stores remain on your machine. Complete first installation for a new host. Do not repeat first setup to change an existing endpoint.
Update a pinned application source
A pinned-source deployment does not automatically use working-checkout edits. Select the correct reviewed release and rebuild the affected service from it. Read source selection.
Development and production execution
Development execution watches application source. Production execution uses compiled output. These modes are separate from local or remote infrastructure placement.