Access Control List (ACL)

Every eBook is assigned an Access Control List (ACL). An Access Control List is a list of entries that defines the specific permissions granted to the eBook. The ACL defines whether the title is public, private, or restricted, and defines whether or not the eBook is searchable (true or false). The ACL also includes a list of the individual users and groups that have rights to access the title. Note that as the ACL is disabled for public and private eBooks--eBooks that are available to everyone, or not available to anyone except for the owner--effectively the only type of eBook with an ACL is a restricted eBook.

Annotation Set

In READynamic the original version of an eBook title is called the "base copy." A user with proper access rights could make a copy of an eBook PDF or ePUB file and then edit that file copy to add videos, graphcs, quizzes, and other interactive content, as well as adding tags (keywords) and comments, and editing metadata.

For example, a professor may be teaching two sections of the same introductory Botany class in two different semesters, and provide the same eBook textbook for each class.  But she may decide to create different quizzes for each class to discourage students who took the class in the previous semester from sharing notes with students in the class to follow. Or a professor may want to use the same basic reference eBook text for three different Botany classes in the same semester, but make the eBook custom for each class. The more advanced class would have more sophisticated tests, and different training videos and comments would be added to each version of the eBook.

So each of these different copied versions of the original base eBook text would have its own custom set of edits and updates. The edits and updates for each copy of the title are included in the Annotation Set for that copy of the ePUB or PDF document, and the annotation set is used to identify the copy.  So if an eBook text on basic Botany principles were to be copied three times and edited separately for three different classes, each of these copies would have its own annotation set.  And the first copy might be known as annotation set number 1, the second copy, annotation set number 2, and the third, annotation set number 3.

The base copy has an annotation set too, but it is not identified, by default.

To lend an eBook, the annotation set value must be included in the request statement. The base copy cannot be lent to other readers.

Authentication Token

A 22 character key that READynamic assigns to a user to identify that user in a secured way for all transactions. The Authentication Token must be provided in most API calls, and is stored in a cookie on the local device. See Authenticating Users.

cURL (Client for URLs)

A command line tool used for transferring files between various Internet protocols and using the URL syntax.

Digital Rights Management (DRM)

An industry standard technology designed to protect electronic content, such as eBooks, music files, and videos, from unauthorized distribution.

Docker container

A Linux open source tool that allows developers to build containers to distribute software products. A container is a package that provides everything needed to install the software product automatically, including the code, system tools, a file system, and libraries. The Docker container can also be configured to limit the amount of system resources taken by the container when it installs a product, such as restricting the amount of processor capacity or memory needed. A Docker container can significantly reduce the number of steps and points of failure in a complex software installation.


A collection of users who are collectively granted access to an eBook or set of eBooks. A common example of a group in READynamic would be a college or university class.

JavaScript Object Notation (JSON)

An open standard file format that relies on easily readable English text, and it is used as an alternative to XML.

Learning Management System (LMS)

A software platform used by schools, colleges, and businesses to manage and deliver digital educational materials to students, track test scores and training programs, and provide record keeping and reports. Examples include Moodle, Canvas, Cornerstone, Edmodo, and Blackboard.

Learning Tools Interoperability (LTI)

An interface created by the IMS Global Learning Consortium to allow an application to communicate with a Learning Management System. READynamic uses LTI to integrate with LMS platforms.


An open standard for authentication that is often used to allow users to log on to third party web sites with standard access accounts (such as for gMail or FaceBook) without needing to provide a password.

Single Sign-On (SSO)

An authentication service that allows a user to access multiple applications with a single user account name and password.

YML file

A simple text file that can be opened and edited in the Windows Notepad or the Mac Text Editor. YML files are used in READynamic to hold system configuration parameters and settings. The YML files used by READynamic include server_configuration_overrides.yml, ominauth_overrides.yml, and docker-compose.yml.