Support Portal

Overview

This guide explains how an admin can add a new user to the CaraOne system by updating the settings.json on the CaraOne Linux server and preparing a personalized caraone.json for the user’s Windows client.

When creating the new user, please take care in making sure the new user and the existing users can not drill down and back up to another user's folder structure.

Note: If you are using CaraOne 1.3, the "faces" directory does not get auto created, but it does get created automatically in version 1.4 of CaraOne.

1. Make a backup of the existing settings.json file.

cd /opt/caraone/dist/settings
sudo cp -pr settings.json settings<date/name>.json

2. Edit the settings.json file to add the new user. (vi, vim, VisualStudio)

Please note - be very careful and double check adding new lines for commas etc. Otherwise the settings.json file will be incorrect and the system will not start.

sudo vim ./settings.json

3. Add the new username to the "users" array.

   Example: To add a user named " NewUser "

"users": [
  "InceptTech",
  "NewUser"
]

4. Add folder paths for the new user in the following sections:

• "FOLDERS_TO_WATCH"
• "FOLDERS_TO_WATCH_PRIORITY"
• "THUMBNAIL_FOLDER_PATH"
• "PROXY_FOLDER_PATH"
• "DOCIMG_PATH"
• "server_urls"
• "FACES_PATHS"

Example for "FOLDERS_TO_WATCH":

"FOLDERS_TO_WATCH": {
  "InceptTech": [
    "/mnt/flash/media/video/InceptTech"
  ],
  "NewUser": [
    "/mnt/flash/media/video/NewUser"
  ]
}

"FOLDERS_TO_WATCH_PRIORITY": {
  "InceptTech": [
    "/mnt/flash/media/video/InceptTech"
  ],
  "NewUser": [
    "/mnt/flash/media/video/NewUser"
  ]
}

"THUMBNAIL_FOLDER_PATH": {
  "InceptTech": "/mnt/flash/media/proxies/InceptTech/thumbnails/",
  "NewUser": "/mnt/flash/media/proxies/NewUser/thumbnails/"
}

"PROXY_FOLDER_PATH": {
  "InceptTech": "/mnt/flash/media/proxies/InceptTech/proxy/",
  "NewUser": "/mnt/flash/media/proxies/NewUser/proxy/"
}

"DOCIMG_PATH": {
  "InceptTech": "/mnt/flash/media/proxies/InceptTech/docimg/",
  "NewUser": "/mnt/flash/media/proxies/NewUser/docimg/"
}

"server_urls": {
  "InceptTech": "http://localhost:8080/",
  "NewUser": "http://localhost:8080/"
}

"FACES_PATHS": {
  "InceptTech": [
    "/mnt/flash/media/proxies/InceptTech/faces/"
  ],
  "NewUser": [
    "/mnt/flash/media/proxies/NewUser/faces/"
  ]
}

5. Save the file

6. Restart the Caraone server services.

Note: Restarting the services will interrupt currently logged in client users' sessions for a moment.

version 1.3

c1 stop
c1 start

version 1.4

sudo systemctl stop caraone
sudo systemctl start caraone

7. Make a backup of the caraone.json file on your client machine, or if this a new client workstation create a new file.

   a. Windows Client set-up : https://scalelogic.freshdesk.com/a/solutions/articles/62000230254

   b. Mac OS Client set-up : https://scalelogic.freshdesk.com/a/solutions/articles/62000231643

8. Give the system some time to start ingesting the content for the new user you created.  

.