Webinista WreadIt

Webinista WreadIt https://wreadit.webinista.com

A WordPress plugin for creating audio versions of your posts using Amazon Polly.

Current version: v1.2.0 See all releases.

You can also view, edit, or download the source code from GitHub.

License

Webinista WreadIt is licensed under the terms of the GNU General Public License, version 3. Some of its dependencies use the MIT 2.0 and Apache 2.0 licenses.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

Prerequisites

This plugin assumes that you are familiar with Amazon Web Services and that you have an account. You will need:

• An Amazon Simple Storage Service (S3) bucket.
• An IAM user with full access to Polly and read/write access to the S3 bucket.
• A key ID and Secret Access Key for the IAM user.

Development

You can also build this plugin from source. This requires having Node, PHP, and Composer available on your system.

1. Clone the GitHub repo https://github.com/webinista/webinista-wreadit
2. From webinista-wreadit directory, run the following commands:
   1. npm install to install the JavaScript dependencies for the front-end.
   2. composer install to install PHP dependencies. You may also need to install the php-scoper plugin using composer bin php-scoper require --dev humbug/php-scoper.
   3. Run the build-wreadit-aws3.sh script. This script downloads the latest version of the AWS SDK for PHP, extracts the relevant interfaces and common files, and scopes it to the project’s name space.
3. Use npm run build to generate the front-end plugin files.
4. Upload the webinista-wreadit directory to /wp-content/plugins/.

Activate the plugin and add your credentials before using.

External services

This plugin connects to Amazon Polly, and Amazon S3. Clicking the Generate Audio Version button sends the following data to Amazon Polly:

• The title and text of the blog post.
• The slug of the blog post.
• The display name of the post’s author. (Manage using the Display name publicly as setting on the Edit User screen.)
• Your AWS Key ID.
• Your Secret Access Key.
• The name of your S3 bucket.

Read Amazon’s Polly FAQs,
general Data Privacy FAQs, and AWS Privacy Notice to understand how Amazon uses your data. Read the AWS Customer Agreement and AWS Service Terms to understand your rights and obligations with regard to Amazon’s services.

Amazon Polly requires your Key ID and Secret Access Key in order to authenticate the request. Amazon Polly saves the generated audio file to your S3 bucket.

Webinista WreadIt uses S3’s virtual hosting. URLs for audio files use the pattern shown below, unless you’ve set a custom domain.

https://<bucket name>.s3.<region code>.amazonaws.com/<your optional prefix/><file name>

For example, if your bucket name is myblogsaudio, your bucket region is us-east-2, and you’ve set a media/ prefix, your audio URLs will begin with https://myblogsaudio.s3.us-east-2.amazonaws.com/media/.

File names begin with the slug of each blog post. Amazon Polly also appends a unique identifier to the name.

Audio files must be publicly readable to be available to your listeners.