This guide is for installing Backup My Org on local machines and web servers. If you already have Backup My Org installed, and need to update to the latest version, click HERE.
WARNING: DO NOT UPDATE MONGO DB AFTER INSTALLING BACKUP MY ORG. DOING SO WILL REMOVE REFERENCES TO ALL BACKUPS IN BACKUP MY ORG. PLEASE REFER TO Restoring the MongoDB database for GEO Jobe's ABCs of GIS DOCUMENT IF YOU PLAN TO DO THIS.
Instructions
System 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
Machine Specifications and Storage Capacity (Recommended)
Less than 10,000 items in organization:
1+ TB HD
4-core processor
16 GB RAM for optimal performance
Greater than 10,000 items in organization:
2-4+ TB HD (depending on organization size)
8-core processor
16 GB RAM for optimal performance
Install for Local Machines
Unzip the
BackupMyOrg-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.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)
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
BackupMyOrg is ready to run. In the main unzipped folder, click on
Backupmyorg.exe
. This will launch the BackupMyOrg 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 Backup’ functionality, Backup My Org must always run in the background.
Once the app is running in the background, open a web browser and type
http://localhost:8500
into your URL bar. This will start the BackupMyOrg 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 on the Manage Identities page.
(NOTE: For convenience, there is also a bmolocal.bat
file that can be run in the same directory. This will start the BackupMyOrg.exe
server, then open a Chrome browser to http://localhost:8500
. This file can be copied as a shortcut and placed on your desktop.)
Additional Notes when Installing for Local Machines
HTTP Setup
If you have an “https” connector associated with BackupMyOrg or CleanMyOrg and edited the nodeconfig.json
file detailed in Step 3, then please refer to the following guide in order to properly configure it. Running Backup My Org or Clean My Org as HTTPS
Permissions Issues with BackupMyOrg
If you have installed BackupMyOrg in your program files directory, and get this permissions issue, that means the program files needs elevated permissions, this error should not occur if installed in another directory outside program files.
Install for Web Servers
Unzip the
BackupMyOrg-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.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)
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
Set up BackupMyOrg as a service.
Open a Command Console by going to the Windows Start menu -> search “run” -> and typing “cmd”
Navigate to the installs directory of BackupMyOrg by typing this into the command console:
cd \D your_BMO_directory_location\installs (Example: cd \D C:\BackupMyOrg\installs)
Then type in:
nssm install "BackupMyOrg Server"
After the nssm service installer has opened, click on the box next to Application Path and navigate to the BackupMyOrg base folder and click on
Backupmyorg.exe
If you are using IWA Authentication for an identity:
Click on the Log On tab and select the This Account option.
Use the account and password that will have administrator privileges to your organization.
Once you are finished making changes, click the Install Service button.
As a note, the service can later be removed by running:
nssm remove "BackupMyOrg Server"
To edit the service:
nssm edit "BackupMyOrg Server"
To make BackupMyOrg available outside of this machine, you will need to open up TCP port 8500 in your router settings.
Once the app is running in the background, open a web browser and type
http://yourwebsitedomain:8500
If you have an “https” connector associated with BackupMyOrg or CleanMyOrg and edited the nodeconfig.json
file detailed in Step 3, then please reference the following guide in order to properly configure it.
This will start the BackupMyOrg client interface. From here you can set up Mail Settings by clicking the cog icon ⚙️ in the top right, and set up your Identities on the Manage Identities page. For more information on this, see Setting Up Email Options In Backup My Org.
Related Articles
📘 Best Practices for Cloning and Restoring (Backup My Org)
📘 How to Enable ArcGIS Login and Create Managed Roles in Backup My Org
📘 How To Set Up Identities In Backup My Org or Clean My Org
📘 Creating ArcGIS Enterprise App ID/Online Client ID and Configuring Redirects
📘 How to Update Backup My Org or Clean My Org from an Older Version