Cayosoft Administrator Web Portal configuration

Overview

Cayosoft Administrator features a Web Portal, a powerful tool to manage objects in your environment and enable self-service. This article covers steps to set up a Web Portal instance in your environment.

Possible configurations

Refer to the following configuration options:

• A single Web Portal in a standalone Cayosoft Administrator environment.

  • A standalone server hosts the Web Portal.

• A single Web Portal in a replication scheme.

  • A single server hosts the Web Portal.

• Multiple Web Portals in a replication scheme.

  • Two or more servers in the replication scheme host multiple Web Portal instances to distribute the load.

    NOTE: You can implement a load balancer to distribute traffic between Web Portals, if needed.

General provisions

• When you install Cayosoft Administrator on your server, the roles and features required to host a Web Portal are installed automatically. Refer to the list of installed items:

  • Web Server (IIS) role.

  • .NET Framework 4.8 features.

• After you install Cayosoft Administrator and perform the initial setup, a Web Portal is automatically enabled on the server. By default, each Cayosoft Administrator instance has a dedicated Web Portal instance.

• The default Web Portal URL is https://*FQDN*/CayosoftWebAdmin/QuickSearch. If the URL has been changed, look up the URL in Configuration > Web Portal > Web Portal Settings in the Cayosoft Administrator console.

Access the portal

Accessing the portal locally

1. On the server where Cayosoft Administrator is installed, start a web browser and enter the following address: http://localhost/cayosoftwebadmin/.

2. Enter your Active Directory credentials in the login screen and click Sign In.

3. Confirm that the Virtual Admin Units (e.g., Active Directory, My Organization, and Self- Service) are displayed in the left pane.

Accessing the portal from different devices

0. Verify the Web Portal URL. You can look up the current URL in the Cayosoft Administrator console in Configuration > Web Portal > Web Portal Settings > Server Settings. The default URL follows the provided structure:

   https://*FQDN*/cayosoftwebadmin/

   Specify the Cayosoft Administrator server FQDN in place of the *FQDN* placeholder.

1. Start a web browser and enter the URL.

2. Enter your Active Directory credentials in the login screen and click Sign In.

3. Confirm that the Virtual Admin Units (e.g., Active Directory, My Organization, and Self- Service) are displayed in the left pane.

Replace Web Portal certificate

IMPORTANT: An SSL certificate is required by the CayosoftWeb Portal to protect traffic between a client browser and the Web Portal. It is recommended to use a valid certificate from a known certificate authority (CA) in a production environment.

Every Web Portal deployment comes with a self-signed certificate issued by Cayosoft Administrator. Refer to the following steps to replace the certificate:

1. Press Win+R and type inetmgr. Click OK to start IIS.

   Alternatively, open Microsoft Server Manager > Tools > Internet Information Services (IIS) Manager.

2. Navigate to Server > Sites > Default Web Site.

3. In the Actions pane, click Bindings.

4. Highlight the https entry and click Edit.

   NOTE: If no https entry exists, click Add, and switch the type to https. Proceed with the instructions.

5. In the SSL certificate dropdown, select a new certificate. Click OK to save changes.

Require SSL for Web Portal

1. In IIS, navigate to Server > Sites > Default Web Site > CayosoftWebAdmin.

2. Double-click SSL Settings.

3. Click Require SSL and click Apply in the Actions pane.

Sign-in settings and customizations

For additional information, refer to the following article: Web Portal settings.

Troubleshooting

• If you encounter an IIS error in the Web Portal after a recent installation\update, you can use the Cayosoft Web Portal Registration tool to update the IIS configuration and troubleshoot the Web Portal setup. The Cayosoft Web Config tool is located in the Start menu under the Cayo Software folder.

  Run the tool and complete the wizard; review the output. The tool generates logs in C:\ProgramData\Cayo Software\AdminAssistant\Logs for you to submit to the support team in a ticket.

Notes

• Earlier versions of Cayosoft Administrator required the use of Cayosoft Web Portal Registration tool to deploy a Web Portal. Newer versions automatically deploy an instance of Web Portal and do not require the use of additional tools.

• You can use the Web Portal Registration tool to update the IIS configuration and troubleshoot the Web Portal setup in the event of an error.

Change history