Page tree
Skip to end of metadata
Go to start of metadata

When deploying a new release, the configuration transfer utility enables an administrator to copy all the SIdora Configuration changes from the development server to the target environment.  

Prerequisites

  1. User account with the administrator role for the config transfer page access in both the source and destination Workbench instances.

Step-by-step guide

  1. Log in as the administrator on the Workbench where you want to copy the SIdora configuration files from. (The source workbench)
  2. Go to Sidora Configuration -> Config Transfer (Link available towards the bottom of the page in Administrative Links section).  Or alternatively, you can go to the following URL in the web browser (https://<workbench_hostname>/admin/sidora/config_transfer)

  3. Back up the current configuration by clicking on the Download Current Config link at the top of the configuration transfer page.

  4. Download the config file and save to a local drive.  This is the config file that you want to upload to the destination Workbench instance and apply the configuration.
  5. Now, log into the destination workbench environment as an administrator where you want to apply the SIdora workbench configuration.
  6. Go to Sidora Configuration -> Config Transfer (Link available towards the bottom of the page in Administrative Links section).  Or alternatively, you can go to the following URL in the web browser (https://<workbench_hostname>/admin/sidora/config_transfer)
  7. Back up the current configuration by clicking on the Download Current Config link at the top of the configuration transfer page.
  8. Download the config file and save to a local drive.  This is your back up configuration file for the destination workbench before applying the changes in case something happens and you need to roll back.
  9. Check Dry Run (this will tell you what is going to change, but does not actually change until you uncheck dry run and re-do the Import and Apply Config)

  10. Click on the Browse button under Config File file uploader and choose the JSON config file from the source workbench instance. (STEP 3) Sample JSON Config File

  11. Add the servers listing setting names to the "Ignore these settings if in the import file" text area with the line break per each name so the config transfer does not override the localizations already made on this specific server



    Review the listing and add the following setting names as necessary:
    1. si_exhibition_website_location
    2. osd_proxy_resolver_url
    3. islandora_base_url
    4. osd_proxy_pid_prefix
    5. sidora_codebook_parser_url
    6. sidora_dataTables_location
    7. sidora_js_lib_location_jstree
    8. sidora_js_lib_location_plupload
    9. sidora_pdf_js_location
    10. si_exhibition_website_location
  12. Once the proper config file is uploaded and selected, click on the Import And Apply Config File button.  If error messages are shown, contact the SIdora developers.

  13. If everything looks good, re-import config file, uncheck the Dry Run check-box and click on the Import And Apply Config File button to apply the changes.

 

Running the Configuration Transfer utility brings over SIdora configuration changes, islandora settings (excluding audio and video settings), forms and form associations

2 Comments

  1. Review with Bobby.

  2. From last update you no longer have to reupload after doing a dry run.  Now there is a link to click to run with the config used to do the dry run.