Clean My Org Installation Guide

Owned by Kenny Tran
Last updated: Oct 24, 2024
3 min read

This guide is for installing Clean My Org on your local machine and web servers.

NOTE: Keep in mind that this install guide represents the minimum steps needed in an ideal environment with no variables or complications to overcome. It is not meant to serve as a comprehensive solution to any and all installation workflows and environments. Enterprise expertise is still essential for handling this installation. 

If you are unsure about whether this product can be installed on your infrastructure, please contact us to request a technical meeting to discuss installation. We do sell Professional Services Installation Packages as an additional option to the purchase of the product license. This professional services package is required for support directly related to the installation and configuration of the product onto an Organization's ArcGIS Enterprise Infrastructure.

Instructions

Installation Requirements

  • Windows 64 bit machine

    • Windows Server 2016 or higher or Windows 10 or higher personal computers

  • MongoDB Installation

  • .NET Framework 4.6 or higher

Install for Local Machines

  1. Unzip the CleanMyOrg-x.x.zip archive into the desired directory. Be sure your windows file path is less than 256 characters when extracting our products otherwise there may be failures when unzipping the files.

  2. In the unzipped /installs folder, install MongoDB:

    • Be sure to keep the checkbox to allow MongoDB to be run as a service.

    • You can uncheck the install option for installing MongoDB Compass (if desired)

  3. Once MongoDB has been installed, you can go to the config/nodeconfig.json file to change any server settings before running. Here you can change settings for:

    • The port that will be used

    • Using HTTP or HTTPS

    • MongoDB Settings

    • Whether or not login credentials will be used

    • Default admin email

    • Level of server logs

    • Log size max

    • Whether resolution options will be allowed from the app

  4. CleanMyOrg is ready to run. In the main unzipped folder, click on cleanmyorg.exe. This will launch the CleanMyOrg server application. Closing the app or shutting down your computer during a scan will cause the scan to fail. In order to use the ‘Scheduled Scan’ functionality, Clean My Org must always run in the background. 

  5. Once the app is running in the background, open a web browser and type http://localhost:8000 into your browser address bar.

    This will start the CleanMyOrg client interface. From here, you can set up Mail Settings by clicking the cog in the top right. You can also set up your Identities for scanning on the Manage Identities page.

    (NOTE: For convenience, there is also a cmolocal.bat file that can be run in the same directory. This will start the CleanMyOrg.exe server, then open a Chrome browser to http://localhost:8000. This file can be copied as a shortcut and placed on your desktop.)

 

Install for Web Server

  1. Unzip the CleanMyOrg-x.x.zip archive into the desired directory. Be sure your windows file path is less than 256 characters when extracting our products otherwise there may be failures when unzipping the files.

  2. In the unzipped /installs folder, install MongoDB

    • Be sure to keep the checkbox to allow MongoDB to be run as a service

    • You can uncheck the install option for installing MongoDB Compass (if desired)

  3. Once MongoDB has been installed, you can go to the config/nodeconfig.json file to change any server settings before running. Here you can change settings for:

    • The port that will be used

    • Using HTTP or HTTPS

    • MongoDB Settings

    • Whether or not login credentials will be used

    • Default admin email

    • Level of server logs

    • Log size max

    • Whether resolution options will be allowed from the app

  4. Set up CleanMyOrg as a service.

    1. Open a Command Console by going to the Windows start menu search “run” (system) and type “cmd” into the input box.

    2. Navigate to the installs directory of CleanMyOrg by typing this into the command console:

      cd \D your_CMO_directory_location\installs (EXAMPLE: cd \D C:\CleanMyOrg\installs)

    3. Then type in: nssm install "CleanMyOrg Server"

    4. After the nssm service installer has opened, click on the box next to Application Path and navigate to the CleanMyOrg base folder and click on cleanmyorg.exe

    5. If you are using IWA Authentication for an identity:

      1. Click on the Log on tab and select the This Account option.

      2. Use the account and password that will have administrator privileges to your organization.

    6. Once you are finished making changes, click the Install Service button.

      1. As a note, the service can later be removed by running: nssm remove "CleanMyOrg Server"

  5. To make CleanMyOrg available outside of this machine, you will need to open up TCP port 8000 in your router settings.

  6. Once the app is running in the background, open a web browser and type http://yourwebsitedomain:8000

This will start the CleanMyOrg client interface. From here you can set up Mail Settings by clicking the cog in the top right, and set up your Identities for scanning on the Manage Identities page. For more information on this, see Setting Up Email Options In Clean My Org or Backup My Org.

Related articles

Providing Your ArcGIS Enterprise Details for Admin Tools

Backup My Org Installation Guide (Local Install)

Backup My Org Installation Guide (Web Server)

Regarding Clean My Org Running On Non-Server Computers

Clean My Org Installation Guide (Web Server)