Initializing the UI

3.1+

Quick Start

Before using the UI, it is critical that you set a password. The password is set by running the following command on the ecs-sync VM:

sudo htpasswd /etc/httpd/.htpasswd admin

This will set the password for the admin user. By default, the UI uses Apache's built-in BASIC authentication implementation (encrypted over TLS), but you can alternatively configure authentication yourself to whatever mechanism Apache supports, by editing the /etc/httpd/conf.d/ecs-sync.conf file.

To quickly start using the ecs-sync UI, load the home page in a browser (https://{vm_ip}). Login using the credentials you set above. On first login, you may see an error about a missing configuration and be brought to the Config tab.

Configuration Tab

On first login, you may see an error about a missing configuration. If this is the first time you've loaded the UI on this VM, you will need to click Save & Write Configuration to Storage. That's it! The UI is now ready to use.

NOTE: If you are redeploying an ecs-sync VM that was using an ECS bucket for config storage, you will need to provide the endpoint and credentials, then Read the config to restore the previous configuration and history.

Configure SMTP Server for Alerts

NOTE: Alerts only apply to scheduled sync jobs. If you are not using the scheduler, no alerts will be sent.
NOTE: If you are working on a PS migration, please make use of xDoctor's reporting features.

To configure alerts, you must set an alert email in the configuration, and edit the following lines of the /opt/emc/ecs-sync/application-production.yml file:

grails:
    mail:
        host: localhost
        port: 25
#        username: 'foo'
#        password: 'bar'
#        props: [
#            "mail.smtp.auth": true,
#            "mail.smtp.socketFactory.port": 465,
#            "mail.smtp.socketFactory.class": 'javax.net.ssl.SSLSocketFactory',
#            "mail.smtp.socketFactory.fallback": false
#        ]

Change the host and port values to match your SMTP server. You might also need to uncomment and set other lines if the server requires authentication and/or SSL.