Unison:Installation Instructions: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older editNewer edit →
No edit summary
No edit summary
Line 6: Line 6:
{{CustomTOC}}
{{CustomTOC}}


This document provides steps on how to install Unison for the first time.
This document will guide you through the process of installing Unison on an Ubuntu server.
 
A video tutorial can be found here: https://vimeo.com/375022309


==Minimum System Requirements==
==Minimum System Requirements==
*Ubuntu 20.04
*Ubuntu 20.04
*8GB RAM
*32GB RAM
*500GB disk space
*2TB disk space
*4 CPU Cores
*16 CPU Cores
*User with Root or Sudo permissions
 
==Pre-Install==
Melissa will provide clients with a downloadable zip file that contains all of the files needed to install Unison. It is recommended to have a method of extracting the zip file’s contents. In this example, we will use the “unzip” utility. You can install this by running “sudo apt-get install unzip”.
 
==System Access Requirements==
In order for the install to perform its activities it will need internet access and connections to various servers. Along with the standard apt repository it also needs access to:
*http://ppa.launchpad.net/ansible/ansible/ubuntu (to install Ansible)
*https://baltocdn.com/helm/stable/debian/ (to install Helm)
*ucr.melissadata.net (to install Melissa Software)
*docker.io (to install various supporting packages needed)
*ghcr.io (to install Keda autoscaling)
*docker.elastic.co (to install Docker)
*k8s.gcr.io (for NFS mounts)
*public.ecr.aws (to install Redis)
*quay.io (for Argo administration)
*pkgs.k8s.io (for Kubernetes install)
*download.opensuse.org  (for older CRIO builds)


==Steps==
==Installation Steps==
#Unzip the Unison Tar file with the command <code>sudo tar –xvzf [file-name.tar.gz]</code>
#Copy the Unison zip file to somewhere convenient on your server. I am using the home directory for the currently logged in user.
#:*(The file is provided via download link)
#Unzip the Unison zip File.
#Navigate to the Unison folder: <code>cd unison</code>
##Ex: <code>unzip UNISONCLOUD-20231207-1236.zip</code>
#Run the '''Install.sh''' file: <code>sudo ./install.sh</code>
#Navigate to the extracted directory.
#During the install process a prompt will appear to ask you if any ports need to be configured before install. If no ports need to be configured, select '''Continue with install''' and it will use default ports.
##Ex: <code>cd UNISONCLOUD-20231207-1236</code>
#:[[File:Unison_IU_1-Continue.png|link=|600px]]
#Run the install.sh script with sudo permissions.
#Next, you will be prompted to choose '''Backup Options'''.
##Ex: <code>sudo ./install.sh</code>
#:[[File:Unison_IU_2-BackupOptions.png|link=|600px]]
#:[[File:UNI_Install_001.png|link=]]
##If <code>No Backups</code> is selected, click <code>Continue with Install</code> on the next screen.
#Enter the password for the current user with sudo permissions.
#:[[File:Unison_IU_3-InstallContiue.png|link=|600px]]
#:[[File:UNI_Install_002.png|link=]]
#Once the install is complete a URL will display where the Unison dashboard can be accessed and setup.
#(Optional) By default Unison uses port 38083, if you wish you can change it now by typing <code>y</code> and hitting enter. Otherwise type <code>n</code> to keep the default value.
#:[[File:Unison_IU_4-CompleteURL.png|link=|700px]]
#:[[File:UNI_Install_003.png|link=]]
#From the Unison Dashboard click <code>Get Started</code> to complete the setup.
#Wait for Installation of Ansible to complete.
#:[[File:Unison_IU_5-Welcome.png|link=|400px]]
#:[[File:UNI_Install_004.png|link=]]
##Enter a '''License Key''' (This key is provided after the Unison Service is purchased.)
#(Optional) You can specify a pickup directory for automated file runs by typing <code>y</code> and hitting enter. Otherwise type <code>n</code> if you are not planning on using automated runs.
##Enter a support email
#:[[File:UNI_Install_005.png|link=]]
##Enter a new '''Base URL''' if needed.
#(Optional) You can add additional machines to the cluster if you wish by typing <code>y</code> and hitting enter. Otherwise type <code>n</code> if you are only using one machine.
#:[[File:Unison_IU_6-BaseURL.png|link=|400px]]
#:[[File:UNI_Install_006.png|link=]]
#The installation is complete when you see the instructions to head to the browser.
#:[[File:UNI_Install_007.png|link=]]
#Navigate to the link provided in step #10 and click the “Get Started” button to complete the setup.
#:[[File:UNI_Install_008.png|link=]]
#Enter a '''License Key''' (This key is provided after the Unison Service is purchased.)
#Enter a support email.
#Enter a new '''Base URL''' if needed.
#:[[File:UNI_Install_009.png|link=]]
#Next, Setup an '''Admin Account'''.
#Next, Setup an '''Admin Account'''.
#:[[File:Unison_IU_7-AdminAccount.png|link=|300px]]
#:[[File:UNI_Install_010.png|link=]]
#'''Login''' with the account created.
#'''Login''' with the account created.
#:[[File:Unison_IU_8-Login.png|link=|300px]]
#:[[File:UNI_Install_011.png|link=]]
#Setup the Time Zone.
#Check all services are up with kubectl get pods.
#:[[File:Unison_IU_9-TimeZone.png|link=|500px]]
##<code>sudo kubectl get pods</code>
 
#:[[File:UNI_Install_012.png|link=]]
 
==Verification==
Once Unison Service is up and running the data and services can be verified with steps below.
 
#Check all services are up
#:Command: <code>sudo docker service ls</code>
#:[[File:Unison_IU_10-CheckCommand.png|link=|1000px]]




[[Category:Unison by Melissa]]
[[Category:Unison by Melissa]]

Revision as of 00:47, 8 March 2024

← Unison by Melissa

Unison by Melissa Navigation
Introduction
Installation Instructions
Software Update Instructions
Address Object Tutorial
Software Rollback Tutorial
LDAP Settings
Platform
Admin Vs Users
Dashboard
Projects
Jobs
Files
Logs
Administration
Services
US Address Verification
Global Address Verification
Email Verification
Matching
Name Parsing
Phone Verification
Profiler
Result Codes
Result Code Use
Unison by Melissa Result Codes



This document will guide you through the process of installing Unison on an Ubuntu server.

Minimum System Requirements

  • Ubuntu 20.04
  • 32GB RAM
  • 2TB disk space
  • 16 CPU Cores
  • User with Root or Sudo permissions

Pre-Install

Melissa will provide clients with a downloadable zip file that contains all of the files needed to install Unison. It is recommended to have a method of extracting the zip file’s contents. In this example, we will use the “unzip” utility. You can install this by running “sudo apt-get install unzip”.

System Access Requirements

In order for the install to perform its activities it will need internet access and connections to various servers. Along with the standard apt repository it also needs access to:

  • http://ppa.launchpad.net/ansible/ansible/ubuntu (to install Ansible)
  • https://baltocdn.com/helm/stable/debian/ (to install Helm)
  • ucr.melissadata.net (to install Melissa Software)
  • docker.io (to install various supporting packages needed)
  • ghcr.io (to install Keda autoscaling)
  • docker.elastic.co (to install Docker)
  • k8s.gcr.io (for NFS mounts)
  • public.ecr.aws (to install Redis)
  • quay.io (for Argo administration)
  • pkgs.k8s.io (for Kubernetes install)
  • download.opensuse.org (for older CRIO builds)

Installation Steps

  1. Copy the Unison zip file to somewhere convenient on your server. I am using the home directory for the currently logged in user.
  2. Unzip the Unison zip File.
    1. Ex: unzip UNISONCLOUD-20231207-1236.zip
  3. Navigate to the extracted directory.
    1. Ex: cd UNISONCLOUD-20231207-1236
  4. Run the install.sh script with sudo permissions.
    1. Ex: sudo ./install.sh
  5. Enter the password for the current user with sudo permissions.
  6. (Optional) By default Unison uses port 38083, if you wish you can change it now by typing y and hitting enter. Otherwise type n to keep the default value.
  7. Wait for Installation of Ansible to complete.
  8. (Optional) You can specify a pickup directory for automated file runs by typing y and hitting enter. Otherwise type n if you are not planning on using automated runs.
  9. (Optional) You can add additional machines to the cluster if you wish by typing y and hitting enter. Otherwise type n if you are only using one machine.
  10. The installation is complete when you see the instructions to head to the browser.
  11. Navigate to the link provided in step #10 and click the “Get Started” button to complete the setup.
  12. Enter a License Key (This key is provided after the Unison Service is purchased.)
  13. Enter a support email.
  14. Enter a new Base URL if needed.
  15. Next, Setup an Admin Account.
  16. Login with the account created.
  17. Check all services are up with kubectl get pods.
    1. sudo kubectl get pods
Retrieved from "http://wiki.melissadata.com/index.php?title=Unison:Installation_Instructions&oldid=20021"