AhsayOBM workaround to support Synology DSM 7

Article ID

5060

Product Version

AhsayCBS: 8.7, 9.1.0.0 - 9.5.2.x

Operating System

Synology DSM 7

Description

This Know-How article will discuss the steps to perform to support Synology DSM 7. 

For customers currently running minimum v8.7.0.0 (base), we have a workaround that allows your users running Synology DSM 7 to install AhsayOBM.

This workaround applies to base release (with or without newer hotfix). If your AhsayCBS is lower than this base version, you will need to first upgrade to v8 or v9. The AhsayCBS installer is available for download from the Ahsay Free trial/download page.

For branded CBS or branded Sub Admin sites, you must first complete Rebuild Client before proceeding.
How to tell if you have this base version?

Login to your AhsayCBS Admin Web Console, click on License, then scroll down to check the Product Version.

You can also check in your AhsayCBS Installation Directory, check the "version.txt" file, should be v8.7.0.0 or above.

If I upgrade my AhsayCBS to a newer release, do I need to redo these procedures?
Yes. If you upgrade v8.7.0.0 to a new AhsayCBS release, you will need to repeat these procedures for the latest SPK file version.
Do I need to redo these procedures if I upgrade to AhsayCBS v9?
Yes. And repeat the same anytime you upgrade AhsayCBS again. You cannot reuse an older custom SPK after you upgrade to a higher AhsayCBS version.
My client agents are branded, do I need to repeat these procedures for each branding?
Yes. After you Rebuild Client per sub-admin, you will need to repeat these steps. If you later re-Rebuild again, the SPK will again need to be modified according to below instructions.

Pre-Requisites to prepare the workaround:

  • AhsayCBS meets minimum base version

  • Rebuild Client completed for branded sites

  • Your PC has:

    • 7z / 7zip
    • Text editor
  • The ".SPK" file format is a Synology Package.
  • Modify the AhsayOBM SPK installer file at your own risk. We recommend you retain an unmodified copy of the SPK file before continuing.
  • Modification to the AhsayOBM SPK file will only apply to Synology running DSM 7. For older DSM, continue to download SPK from the AhsayCBS Download page.
  • Modified AhsayOBM SPK for DSM 7 is not a replacement for your AhsayCBS's standard Synology download when you must be compatible with older DSM. If older DSM runs the modified SPK, they will fail installation.
  • If you have Sub Admin (reseller) with custom branding, these steps will need to be repeated using the AhsayOBM SPK download from each Sub Admin's AhsayCBS Download page.

Solution

Workaround steps to be completed by AhsayCBS Admin:

  1. Download and save the AhsayOBM Synology SPK file from your AhsayCBS to your local PC.
  2. Open the file using 7z application by "Open archive" function.
  3. Copy the INFO file from the SPK file to your local disk.
  4. Delete the INFO file from the SPK file using the 7z application.

  5. Using a text editor, open the INFO file.

    1. At the end of the file, add the following line:

      os_min_ver="7.0-40000"

    2. Copy the text value of "package" and edit the line "dsmuidir".

      Find the line package="AhsayOBM" and copy the text which is AhsayOBM

      Find the line dsmuidir="ui" and edit to dsmuidir="%package%:obm/wui" (where %package% is replaced with the text value from the package line)

      Example: dsmuidir="AhsayOBM:obm/wui"

    3. Save the file.
  6. Drag the updated INFO file from the local disk to the 7z window (SPK file).

  7. Download and unzip the privilege file from https://download.ahsay.com/support/30215/AhsayCBS9DSM7privilege.zip.

  8. Still in the 7z window, open the conf folder then drag to add the privilege fie from the local disk to the SPK file.
  9. Close the modified SPK file. (Save changes if prompted)
  10. As the AhsayCBS Admin, you will need to distribute the modified SPK to your DSM 7 users.

    Not recommended to overwrite either %AhsayCBSHOME%/download/ or %AhsayCBSHOME%/system/cbs/Installers/{dir}/

    Optional Steps:

    If you will redistribute the modified SPK and need a way for your users to manually download the modified SPK, you can consider the following:

    1. Save the modified SPK (example filename: obm9-dsm7.spk) to your AhsayCBS path: %AhsayCBSHOME%\webapps\ROOT\obm9-dsm7.spk

      Default path in Windows is C:\Program Files\AhsayCBS\webapps\ROOT\obm9-dsm7.spk

      Default path in Linux is /usr/local/cbs/webapps\ROOT\obm9-dsm7.spk

      When upgrading to future AhsayCBS base version, you need to remove this file from circulation as it would be deemed outdated. Generate a new SPK with the newer base version.

      For CBS sites with several branded Sub Admin, you need to save as unique filenames.

    2. Inform your users to download it from https://yourAhsayCBS.domain.com/obm9-dsm7.spk.
    3. After download, they can follow normal installation procedures.

DSM 7 User:

  1. Transfer the modified SPK to your machine that will access the DSM console.

    Example download from https://yourAhsayCBS.domain.com/obm9-dsm7.spk

  2. Install the application with the updated SPK, follow normal installation procedures.

    Modified SPK cannot be used on older DSM. Install will fail.
  3. Run application and perform desired actions, such as backup and restore.

Addendum - Insufficient Permissions

When performing Backup or Restore, "Insufficient Permissions" might be encountered. For share folders, grant read (for backup) and write (for restore) permission to application. For more information, please refer to AhsayOBM v8.5.4.x on Synology DSM 7 - Insufficient Permission

.