README

This library provides a PHP client for the Ostiary session manager.

Note: This library can be used stand-alone from an Ostiary server, or can directly interact with the Redis backend of an Ostiary server. However, doing this grants full access to the Redis backend and circumvents the access controls the Ostiary server provides.

Description

Ostiary is a simple session token manager that can be used for a variety of use cases, acting as an authenticated and authorized wrapper around a Redis store. Sessions are identified and validated using JSON Web Tokens, and scoped data buckets offer the additional ability to store session meta-data (such as username, email, timezone, etc.).

This PHP client library is used to either interface with an Ostiary server, or work stand-alone.

Installation

Install this library using the composer PHP package manager:

composer require "hackthissite/ostiaryclient"

For usage, see the documentation section below.

Documentation

• Quickstart - Overview and quickstart
• Class API - Documentation for the end-user classes of the Ostiary PHP client

Development

Navigate into the directory where you cloned the Git repository. Install dependencies using the composer PHP package manager:

composer install

Generating documentation

1. Delete the contents of the doc/api/ folder
2. Run the command: vendor/bin/phpdoc-md