Installation
Installation Requirements
- Windows 64 bit machine
- .NET Framework 4.6 or higher
Instructions for Local Install
- Unzip the BackupMyOrg-x.x.zip archive into the desired directory
- 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 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
Please see the Config File Values section below for more information on each item.
- 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 backup will cause the backup to fail. In order to use the ‘Scheduled Backup’ functionality, Backup My Org must always run in the background. See Step 4 of Instructions for Web Server Install below for instructions on setting up the application up to 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 for operations on the Manage Identities page.
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.
Instructions for Web Server Install
- Unzip the BackupMyOrg-x.x.zip archive into the desired directory
- 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 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
Please see the Config File Values section below for more information on each item.
- Now, we will set up BackupMyOrg as a service.
- Open a Command Console by going to start -> run and typing “cmd”
- Go to the installs directory of BackupMyOrg by typing:
cd \D your_BMO_directory_location\installs
i.e. cd \D C:\BackupMyOrg\installs - Type: 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.
NOTE: The service can later be removed by running:
nssm remove
“BackupMyOrg Server” confirm
- 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
This will start the BackupMyOrg client interface. From here you can set up Mail Settings by clicking the cog in the top right, and set up your Identities for operations on the Manage Identities page.