 |
|---|
The UST should be installed on a VM or stable server if possible - the platforms listed below are supported. The tool can be installed on an existing server (AUSST for example), but and islolated solution is recommended for long term stability and maintainability. The tool should be hosted within your network's firewall, and should be able to reach your Active Directory DC's, or other identity source. Follow the directions below to get started with installing the UST.
| Platform | Installer |
|---|---|
 |
Windows: Use the msi based windows installer for a streamlined setup process |
    |
Linux: Follow the directions below to install on any supported platform via the python install script. |
Configuration of the UST is beyond the scope of this page - please visit the links below for more information.
| Description | Location |
|---|---|
| Overview of UST | https://spark.adobe.com/page/E3hSsLq3G1iVz/ |
| UST Official Repository | https://github.com/adobe-apiplatform/user-sync.py |
| Setup and Success Guide | https://adobe-apiplatform.github.io/user-sync.py/en/success-guide/ |
| UST Setup Walkthrough | https://helpx.adobe.com/enterprise/using/user-sync.html |
You can also download the Adobe.IO UMAPI certgen tool (windows only) independently here if you only need to update your cert/keypair. This is included as a part of the full installation as well.
The MSI installer provides the best experience and can handle python installation automatically. However, you may also run the python installer script on Windows for a streamlined setup. Note: you must already have python 2.7 or 3.6 installed and on your path. From an administrator level powershell, execute the following string:
((New-Object System.Net.WebClient).DownloadString('https://git.io/fhpuG')) | python
The following will install User Sync and related packages on all of the above platforms. Execute the command on bash shell:
curl -s -L https://git.io/fhpuG | sudo python -
Or, if python is not the correct alias on your system, you might get the error: "curl: (23) Failed writing body"
Please use the python alias corresponding to the version you wish to run UST with. E.g., on Ubuntu 18:
curl -s -L https://git.io/fhpuG | sudo python3 -
Python 2.7 or 3.6 must be pre-installed to use the sync tool - and the install process will exit if this older versions are used!
run-user-sync.sh: Runs UST in live mode with options --users mapped --process-groups
run-user-sync-test.sh: Runs UST in test mode with options --users mapped --process-groups
sslCertGen.sh: Generates a certificate-key pair for use with the UMAPI integration. Places private.key and certificate.crt in the primary
install directory.
examples Directory of example configuration files for reference.
The installer will also create a log file (ust_install.log) in the working directory at the debug level automatically.
-d, --debug
Show debug logging
-fs, --force-sudo
Overrides the sudo requirement - Warning, if the shell asks for user input such as sudo password, the installer will hang indefinitely!