Applicability: CaraOne install on macOS Clients


Prerequisites:  The client must be able to ping the AI Node to be on the same network, WAN, VPN, etc.  The CaraOne AI Node and clients need ports 8080 and 9091 open.  Changing these ports is possible with a server-side port setting.  If using Premiere the client also needs port 3000 open.  It is required the client has the proxy and thumbnail folders mounted in addition to the high-resolution storage locations.


Installation

Get the latest macOS (or Windows) download link from support, which is valid with your CaraOne support contract.  Run the dmg and first tell the macOS to run the unsigned CaraOne installer.  Open System Preferences and click "Open Anyway".




Click Next


Choose the default location


If this is a Premiere workstation check the box for integration


click next to create a desktop icon


Installer should finish so you can continue on with client configuration


CaraOne will be in the Applications folder and you can place it in your dock as a shortcut


Configuration

To continue using the Client GUI for configuration, follow the client GUI configuration


For manual configuration, locate the macOS client config file with "go to folder".  Once in the com.ObviousFuture.CaraOne folder, you find and edit caraone.json.


Pro Tip: After you have tested CaraOne for a given team, you can copy a .json file from your working macOS client and put it on new machines to complete installations quicker.  If the .json exists already on the new one you are deploying, you can either delete the existing .json file or just rename it to something else.


Changes:

Working from the top down, change these lines to match your specific team setup.  If you have only one team you will only need to edit and distribute one version of the json file to all clients.  Repeat for each unique team in your environment.


 

     "UserID": "",
     "EncodeBackendURI": "http://:9091",
     "ProxyPath": "",
     "ThumbnailPath": "",
     "ThumbnailPathDocuments": "",
     "ServerPath": "",
     "LocalPath": ""

Check the json via a checker for example: https://jsonlint.com/.


Example JSON:

Check the bolded lines in the below example.  Set the UserID appropriately.  Set your URL's to the correct IP address of your CaraOne server.  Ensure the Proxy and Thumbnail path are set correctly as CaraOne needs access to the proxies and thumbnails the server creates.  Set the "LocalPath" to the high res location so that the action button of the CaraOne can point to the high res.


{
  "FileVersion": {
    "Major": 0,
    "Minor": 1,
    "Build": 0
  },
  "Server": {
    "UserID": "scalelogic1",
    "EncodeBackendURI": "http://10.0.1.15:9091",
    "ProxyPath": "/Volumes/proxy/scalelogic1_proxy",
    "ThumbnailPath": "/Volumes/proxy/scalelogic1_thumbnails",
    "ThumbnailPathDocuments": "/Volumes/proxy/scalelogic1_docimg",
    "MediaPath": "/Volumes/MyDir/",
    "IndexingTimeout": 2.0
  },
  "Auth": {
    "Username": "",
    "Email": "",
    "Password": ""
  },
  "BehaviourSettings": {
    "AutoplayOnThumbClick": true,
    "AutoFocusSliceOnLoad": true,
    "UIScale": 1.2,
    "ScrollSensitivity": 1.0
  },
  "VideoPlayerSettings": {
    "SkipTime": 0.1,
    "SkipTimeFast": 5.0
  },
  "PathTranslationSettings": {
    "Tuples": [
      {
        "ServerPath": "/mnt/flash/media/video/Scale Logic",
        "LocalPath": "/Volumes/Scale Logic"
      }
    ]
  },
  "LogVerbosity": "Normal"
}


Test the client by launching and searching for something.  If all is working you will see thumbnails and proxy files.  You can copy this CaraOne.json to other clients once you have a working client system.