Skip to content
fDeploy Documentation

Maintenance mode

From time to time you will need to perform administrative activities on your fDeploy Server, such as upgrading fDeploy or applying operating system patches. You will typically want to schedule a maintenance window where you perform these activities, and fDeploy Server helps with this by switching to Maintenance Mode.

In short, Maintenance Mode lets you safely prepare your server for maintenance — allowing existing tasks to complete, while preventing changes you didn’t expect.

Accessing maintenance settings

Navigate to Configuration → Maintenance to enable or disable Maintenance Mode. You can also provide an optional message (for example, a link to a status page or a scheduled end time) which is shown in the banner to all signed-in users.

How it works

Once fDeploy is in Maintenance Mode:

  • System Administrators can still do anything they want, just like normal.
  • All other users are prevented from making changes, including queuing new deployments or other tasks. Read-only access is preserved so users can continue to inspect the state of the system.
  • The task queue continues to be processed:
    • Tasks that were already running will run through to completion.
    • Tasks that were already queued (including scheduled deployments) will be started and run to completion.
    • System tasks (such as health checks and audit-log archival) continue to execute at their scheduled intervals. These are designed to be safe to cancel at any point in time.

Maintenance banner

While Maintenance Mode is active, a warning banner is shown at the top of every page to all signed-in users. The banner indicates who enabled Maintenance Mode, when it was enabled, and any optional message the administrator provided.

On smaller screens the banner truncates its contents; tap the banner to open a details popover with the full information.

Audit log

Enabling and disabling Maintenance Mode is recorded in the audit log as MaintenanceModeEnabled and MaintenanceModeDisabled events, including the administrator who performed the action.

Typical maintenance workflow

  1. Announce the maintenance window to your team.
  2. Enable Maintenance Mode a few minutes before you start work. Use the message field to communicate expected duration or a status page URL.
  3. Wait for any in-flight deployments to complete. You can monitor these in Tasks.
  4. Perform the maintenance activity (upgrade fDeploy, apply OS patches, restart the service, etc.).
  5. Verify that everything is working as expected.
  6. Disable Maintenance Mode.