# Change the Clarity LIMS Hostname

The core Clarity LIMS product includes the **rename\_claritylims\_hostname.sh** script, which allows you to change the hostname to which Clarity LIMS responds.

### Prerequisites & considerations <a href="#claritylimsv6.2changingthebasespaceclaritylimshostname-prerequisites-and-considerations" id="claritylimsv6.2changingthebasespaceclaritylimshostname-prerequisites-and-considerations"></a>

#### Prerequisites <a href="#claritylimsv6.2changingthebasespaceclaritylimshostname-prerequisites" id="claritylimsv6.2changingthebasespaceclaritylimshostname-prerequisites"></a>

* Clarity LIMS must be fully installed and configured. If it is not, the script instructs you to complete the installation.
* The script stops all Clarity LIMS services. Make sure that all automation jobs are complete.
* If you are not using a wild card SSL Certificate, purchase a certificate for the new hostname.
* Update the hostname returned by the operating system to match the new name. Refer to [#pre-script-steps](#pre-script-steps "mention") for more information.
* Running the renaming script requires **root** access.

#### Considerations <a href="#claritylimsv6.2changingthebasespaceclaritylimshostname-considerations" id="claritylimsv6.2changingthebasespaceclaritylimshostname-considerations"></a>

* The script does not update the Automation Worker installation. After you have completed the renaming steps, you must reconfigure all local and remote Automation Workers.
* You might need to reconfigure additional services, such as the Reporting and Sequencing services.

{% hint style="info" %}
We recommend that you back up the database before performing the following renaming steps.
{% endhint %}

### Settings changed

The following table lists the settings changed by the `rename_claritylims_hostname.sh` script.

| Property           | Global             | Description                                               | Location                                                                            |
| ------------------ | ------------------ | --------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| namingProviderHost | Yes                | Configures appropriate endpoint for the Automation Worker | <p>/opt/gls/clarity/tomcat/current/lib/<br>activity-management-ui-config.groovy</p> |
| api.uri            | Per tenant setting | Base URI used by integrations for API calls               | Property Table                                                                      |
| ftp.host           | Per tenant setting | Location of FTP host for this tenant\*                    | Property Table                                                                      |
| ServerName         | Per tenant setting | Server name reference in lookup database                  | Lookup Database                                                                     |

\*The ftp.host is only updated if it matches the previous IP address/hostname. This intended behavior accounts for the scenario in which the ftp host is on a different server.

### Changing the LIMS hostname

#### Pre-script steps

1. Change the internal hostname

   Before running the **rename\_claritylims\_hostname.sh** script, change the internal hostname for the instance - that is, /etc/hosts and related areas. There is no need to change any other LIMS-related components.

   The new internal hostname will be used in the renaming process.

   * To verify the internal hostname, use the following command:

     ```
     hostname -f
     ```

     **NOT**E: If the hostname command does not return the correct new name, consult with your IT department to correct the name.
2. Verify SSL Certificate path:

   The script may prompt you for the SSL Certificate path. Be sure to have that ready.

#### Running the script

1. Use the following command to change to the **root** user:

   ```
   sudo su -
   ```
2. Navigate to the **/opt/gls/clarity/config** directory.
3. Run the rename\_claritylims\_hostname.sh script:bash rename\_claritylims\_hostname.sh
4. If prompted for your SSL Certificate path, enter this information.
5. The script prompts you to confirm that you have changed the internal hostname.
   * If you enter **no**, you will be prompted to manually change the hostname (output shown below).

     ```
     [root@qalocal config]# bash rename_claritylims_hostname.sh
     Does your internal hostname match the new Clarity server hostname?: n
     Please change your internal hostname to match the hostname you are passing to this script to ensure Clarity can connect to it.
      Do not change any Clarity related components.
     ```
   * If you enter **yes**, the script proceeds to modify Clarity LIMS-related components to use the new hostname.
6. When the renaming is complete, the script prompts you to restart Clarity LIMS by running the run\_clarity.sh script:

   ```
   /opt/gls/clarity/bin/run_clarity.sh start
   ```
7. When all Clarity LIMS services have restarted, make sure that the hostname has been changed successfully. Complete the following steps:
   * Connect to all system components.
   * Log in and test the LIMS user interface in your web browser.