Monolith Desktop Setup

There are a couple of steps to setup Monolith Desktop.

Initial Installation

To download Monolith Desktop, go to the System section of the settings page and download the appropriate installer for you operating system (Windows or MacOS)

After installing Monolith Desktop and running it for the first time, you will be presented with an "API Mode" selection screen.

This screen allows you to connect Monolith Desktop to your Monolith Tenant, whether it is in the Cloud or On-premises:

Cloud Customers

For cloud hosted Monolith Tenants/Customers - keep the default selection as "Cloud". The region is defaulted to US/North America, but if you are a UK customer, change the region to "United Kingdom" and select submit.

This option ensures that Monolith Desktop will connect to the correct Monolith Server for your cloud deployment or region.

Additional Cloud regions may be added in the future.

On-Premises Customers

For on premises customers - change the "API Mode" to "On-Premises". This mode allows Monolith to connect to an on-premises Monolith server that is running within your organization and network.

When you select the On-Premises option, you then need to enter your Monolith Server's API endpoint. This will typically be the IP address of your Monolith server, or a custom domain if you have one setup in your network.

The API endpoint must meet the following formats:

https://{monolith-server-ip-address}/api
https://{custom-monolith-domain}/api
Examples:
https://192.168.1.22/api
https://monolith.myorg.com/api

If Monolith Desktop can successfully reach the Monolith server, you will see a green check mark populate and the Monolith Login screen will load.

Reset Monolith Connection Settings

To reset Monolith's API connection settings, click the "Reset Monolith" button located on the Monolith Login screen. This will return you to the API mode selection.

Last updated