Archive.org integration

Video content from the HyperCaster (v6.1 and above) can be archived and retrieved to and from the Internet Archive (archive.org). This requires the HyperCaster Archiving license option and an account set up on Internet Archive (see below for how to set up an Internet Archive account).

Set up the Internet Archive as a Remote Server

  1. In the HyperCaster, navigate to Config → Remote Servers
  2. Click on Remote Servers
  3. Click on the Add New icon 
  4. Fill in the required fields:
    1. Server Type → Archive
    2. Server Protocol → IAS3
    3. Name → Type a name that will help you identify in HC actions menus
    4. Host → s3.us.archive.org
    5. The HyperCaster will ask you for the Username and Password of your Internet Archive account. To retrieve that information from the Internet Archive:
      1. Create and log in to your archive.org account
      2. To get an API key, go to https://archive.org/account/s3.php. Check the Generate New Keys option and click on the button.
      3. You will get an Access Key and a Secret Key
      4. Copy/Paste the Access Key into the HyperCaster Username field
      5. Copy/Paste the Secret Key into the HyperCaster Password and Password Confirm fields
      6. Save, and the Internet Archive account will display in the HyperCaster’s list of Remote Servers

Designate the Internet Archive Collection

Internet Archive users cannot create their own collections. Collections are created by Internet Archive Administrators, based on requests from users who have at least 50 videos in the archive. There are open collections to which all users have access, such as Community Media. Non-commercial PEG (Public, Education, Government) TV stations are eligible to have a collection established as a sub-collection in the Community Media Archive collection which contains archived video in sub collections from more than 600 PEG stations. The requirement of 50 videos is waived for collections established under the Community Media Archive. See below for how to get a collection established on the Community Media Archive.

  1. In the HyperCaster, navigate to Config → Internet Archive –> Collections
  2. Click on the Add New icon 
  3. Type in the Collection name
  4. In the Key field, you will need to copy the end of the Internet Archive URL for that collection. So for example, if you’ve had a collection set up by Internet archive adminstrators, your Internet Archive collection is at https://archive.org/details/yourcollectionname. In the Key field, enter yourcollectionname. If you’re uploading to the open collection for video and haven’t had a collection established by Internet Archive adminstrators, your collection would likely be https://archive.org/details/opensource_media. In the Key field, enter opensource_media
  5. Save

Configure Upload & Metadata Settings

  1. In the HyperCaster, navigate to Config → Internet Archive –> Upload Settings
  2. Bucket Prefix:  This is an optional naming prefix, which will be useful if your program name is too generic (like “town council meeting”). Each bucket (container for uploaded/derived files) on Archive.org has to be unique. When the HyperCaster uploads files to Internet Archive, the bucket name is derived from a sanitized version of the filename. This can cause issues for different users uploading content with similar names. The bucket prefix will be prepended to the bucket name on each upload. This prefix should be unique to your organization as to avoid conflicts with other organizations using similar filenames.
  3. Title Format: When uploading files to Archive.org, the HyperCaster will use one of the following formats for the files’ title on the Internet Archive: Program, Episode, or Program – Episode. The HyperCaster description field will map to Internet Archive description, and HyperCaster Categories will map to the Internet Archive Subject field, as a semicolon separated list.
  4. Save your settings.

Configure Content Settings

Archive.org assumes anything with a .mp4 extension is an mp4 that is playable in an HTML5 video player without actually checking the video file for its format. Therefore it is important that imported files update their extension to match their actual format. Enabling the “Transmux / Transcode Extension Update” Content Setting will ensure file extensions are updated in a way that don’t confuse Archive.org.

  1. In the HyperCaster, navigate to Config → Content.
  2. Check the “Transmux / Transcode Extension Update” feature on.
  3. Select an extension from the available Transmux / Transcode Extension pulldown.
  4. Save your settings.

Archive Content to the Internet Archive

  1. In the HyperCaster, navigate to the Content Tab
  2. Select one or more content records
  3. Right-click on a thumbnail to open the File Actions Menu, and select Archive
  4. Select archive.org option from the list of Remote Servers
  5. Select one or more IA Collections from the list of integrated collections
  6. Check “Delete Afterwards” if you want this item deleted from the Content Library after archiving
  7. Click “Archive”

The blue archive icon will display on the lower right of the thumbnail of the video that was just archived. You will still be able to schedule this video for playback. If you opted to delete it from the Content Library, make sure you allow enough time for the HyperCaster to retrieve the video file from the Internet Archive before it is scheduled to play out.

Archiving to the Internet Archiving works effectively like Archiving to a NAS, other than the fact that Collections must be configured and selected, and Internet Archive is cloud-based. All archiving features supported when using Networked Attached storage (FTP, Samba) are supported. Please see the Archiving instructions in the HyperCaster User Manual for more information.

If a video is archived on both the Internet Archive and another Archive, retrieval will attempt to retrieve from a non-Internet Archive location first, assuming that will generally be a faster file transfer.

Edit on Internet Archive

Once the video has transferred to the Internet Archive, a new link “Edit on Internet Archive” link will appear on the video’s Content Edit page, which takes you directly to the item’s page on archive.org. From there you can further manage and edit the metadata for archive.org viewers.

Set up an Internet Archive Account

Create an account on the Internet Archive by registering an email address.  This email should be a “real” email address where you can receive email and that you check regularly. The Internet Archive will honor requests for modification/removal of an uploaded video only if the request comes from the same email address that uploaded the video. It’s best to use a “functional” email address such as archive@your-org.org instead of a personal email. This prevents issues with employee turnover.

Get a Collection Established on the Community Media Archive

To get a collection established for your PEG organization, please email the Internet Archive Collections Service group with the following information. They will use this information to establish your collection under the Community Media Archive:

  • the title you want for your collection
  • request that your collection is to be a “sub collection” of the Community Media Archive (collection:”community_media”)
  • the email address you used to register for an archive account that should be granted admin access to the collection.
  • a descriptive text paragraph for your collection’s detail page.
  • a logo for your collection

You will receive an an email from Internet Archive when your collection has been setup. The email will contain a URL pointing to your collection.

in Content ManagementHC User Manual

Related Articles