Transcribe Documentation

Documentation


Product Details Changelog FAQs

Installation & Upgrading

NOTE: If you are upgrading from the EE2 version to EE3+, click here to read important migration instructions.

EE3+ Installation

Download and extract the Transcribe zip file from your Account page on EEHarbor.com and then follow these steps:

  1. Copy /transcribe/ to /system/user/addons/ (or wherever you keep your third-party add-ons)
  2. Copy /themes/transcribe/ to /themes/user/transcribe/
  3. Install the add-on package from Add-On Manager » Third Party Add-Ons
  4. Click on "Transcribe" in the Third Party Add-ons listing to go into Transcribe
  5. Click on "License" from the left sidebar and enter your license key (see the License Key note below).
  6. Follow the rest of the instructions in the Getting Started documentation

EE2 Installation

Once you've downloaded and extracted Transcribe for ExpressionEngine, copy the 'system/expressionengine/third_party/transcribe' directory into the 'system/expressionengine/third_party/transcribe' directory of your ExpressionEngine installation.

Next, log into your ExpressionEngine control panel and install the module and the extension from the 'Modules' section.

Upgrading Transcribe

  1. Follow the installation instructions for your EE version (i.e. copy files to add-on location)
  2. Run the module updater:
    • For EE3+: In Add-On Manager » Third Party Add-Ons, click "Update to X" button
    • For EE2: In the Add-ons » Modules section, click the "Run Module Updates" button in the upper right
  3. Enter your License Key into the License section of the add-on (see the License Key note below).
  4. If you are unable to use the new exp:transcribe:entries tag, you can use the temporary legacy parsing fallback config option (note: this will be removed in Transcribe 4).

Migrating Transcribe from EE2 to EE3+

If you are using the Transcribe Fieldtype in your EE2 site, you MUST uninstall just the fieldtype before migrating Transcribe to EE3+.

If you have already migrated to EE3+ and did not uninstall the fieldtype, you will have to delete the Transcribe fieldtype row from your database's `exp_fieldtypes` table manually.

License Keys

You must have a valid license key to use Transcribe on a production website.

A valid license requires you to add your Production Domain and Staging Domain (if you have one) in the license details on your Account page on EEHarbor.com.

Failure to enter a valid license key will cause the add-on to cease to function on a production website.

You do not need to enter your local development domains unless you are using a non-standard TLD (like .zombie or something).


Support

Having problems setting up and/or using Transcribe? Support is offered from 10am to 4pm EST weekdays. Send us an email at help@eeharbor.com and we will respond as quickly as we can.