Skip to main content

Maintenance Mode

The maintenance mode is a special mode of operation of the Txture server. It can be enabled and disabled in a variety of ways:

  • Via the REST API. External applications can use an API Token to enable or disable the maintenance mode.
  • Automatically. Some tasks, e.g. executing Refactoring Operations, will automatically enable the maintenance mode when they run, and disable it again when they are finished.

Effects of the Maintenance Mode​

While the maintenance mode is active, Txture behaves differently from normal operation in the following ways:

  • All regular users will be logged out and will no longer be able to log in while the maintenance mode is active. They will receive a notification on the UI that maintenance mode has been activated. All users with the admin User Role will remain logged in.
  • All modifying requests on the REST interface (including those sent by Txture Web Clients) will be rejected.
  • All reading requests on the REST interface (including those sent by Txture Web Clients) will be rejected as well, unless they are performed by an admin user.
  • Requesting whether or not the maintenance mode is enabled via the REST interface is always permitted. Switching the maintenance mode off is also permitted, but only for admin users.

In short, maintenance mode switches Txture into a read-only mode for admin users, and into a no-access mode for everyone else.

Use Cases​

The maintenance mode is a great fit if:

  • You are performing major changes in the application, such as Refactoring Operations. When triggering a structure refactoring in the structure editor, maintenance mode is automatically activated on start and deactivated upon completion.
  • You want to create a backup of the Txture Home Directory.
  • You want to temporarily prevent modifications on the server without taking it offline.