/
How to Run CleanMyOrg in IIS Mode

How to Run CleanMyOrg in IIS Mode

Running IIS mode is a configuration option that allows the CleanMyOrg to be accessed via a standard web URL, rather than the default 8000 port, which provides a more streamlined and secure deployment. This setup is ideal for organizations looking to host CleanMyOrg behind a reverse proxy with support for enterprise authentication methods like ArcGIS logins or managed roles. Further context on reverse proxies can be located here. Setting this configuration allows for your CleanMyOrg setup to run on domain.com/cleanmyorg instead of domain.com:8000.

In this guide, you’ll learn how to correctly setup your CleanMyOrg files, install the required IIS modules, configure the application in Internet Information Services Manager (IIS), and enable reverse proxy routing.

Step-by-Step Guide

  1. Unzip CleanMyOrg
    You can unzip to C:\CleanMyOrg or any location you wish. Since the files that will be served client-side reside in the CleanMyOrg\html directory, it may be best to keep the folder out of the default inetpub\wwwroot directory and set the webpage up as an application item.

  2. Install MongoDB-windows-*.exe if needed. The .exe file is located in the following directory:

Your CleanMyOrg root directory/installs

  1. Install Required IIS Modules
    In the C:\CleanMyOrg/installs/IISstandalone folder, there are two files - rewrite_amd64_en-US.msi and requestRouter_amd64.msi. These IIS modules must be installed in the order just listed for CleanMyOrg to work properly. They are used by the application to create a reverse-proxy to forward requests through IIS to the server application.

    1. Make sure you have Websocket Protocol installed for IIS. If you need to install Websocket Protocol, click here.

  2. Install & Start Windows Service as noted in the CleanMyOrg standard installation.

  3. In Microsoft Internet Information Services (IIS): Under your machine name -> Sites -> Default Web Site, right click to open Add Application (located in Connections or left-panel in IIS)

    1. Specify the name cleanmyorg as the Alias

    2. Make the Physical Path C:\CleanMyOrg\html or wherever you have unzipped CleanMyOrg. Make sure the html directory is added.

    3. This will access CleanMyOrg from yourdomain.com/cleanmyorg or localhost/cleanmyorg

image-20250811-152619.png
Application Setup in IIS (must right-click Default Web Site)

  1. IIS: Enable Application Request Router proxy

    1. Under connections, click on the server entry under the start page 

    2. In the center panel under the IIS section, double click on the Application Request Routing icon, so that your domain, <domain>/cleanmyorg/api, properly reroutes to the http://127.0.0.1:8000.

      image-20250811-153142.png
      Application Request Routing in IIS

    3. Click the enable proxy checkbox in the center panel, then on the right panel click the apply button.

image-20250811-152119.png
Enabling Proxy in Application Request Routing

 

  1. In C:\CleanMyOrg\html\config\config.json, set "iisMode": true,

  2. You can now open a browser to (https://yourdomain.com/cleanmyorg) and use the application.

  3. Since this URL will be available over the web and not on a specific port, we recommend you set up useArcGISAuth.enabled = true or use Managed Roles to access CleanMyOrg as noted here: How to Enable ArcGIS Login and Create Managed Roles in Backup My Org

Note: The referenced article is geared towards Backup My Org, but the same instructions will apply for Clean My Org.

 

Related Topics

How to Run BackupMyOrg in IIS Mode