silverstripe/dynamodb

SilverStripe DynamoDB integration.

Monday, November 20, 2017
by stojg
Repository
8 Watchers
2 Stars
34,953 Installations

PHP
3 Dependents
0 Suggesters
9 Forks
0 Open issues
18 Versions
9 % Grown

The README.md

SilverStripe DynamoDB

, _(*1)

This module enables storing SilverStripe sessions in DynamoDB., _(*2)

Requirements

SilverStripe 4.0+
PHP 5.6+

Installation

Add these custom repositories to your composer.json, _(*3)

composer require silverstripe/dynamodb

Sessions with DynamoDB

If you wish to store sessions in DynamoDB, set the required environment variables in .env:, _(*4)

// the name of the DynamoDB table to store sessions in
AWS_DYNAMODB_SESSION_TABLE=mysession

// the region that the DynamoDB table will live in (in this example here it uses Sydney)
AWS_REGION_NAME=ap-southeast-2

Once these are in place, this module will configure DynamoDB and register that as the session handler., _(*5)

Before you can actually use this, you need to create a table in which to store the sessions. Follow the instructions in the AWS SDK for PHP documentation., _(*6)

IMPORTANT: You need to set up a TTL attribute for garbage collection in your table. The module does not provide automated garbage collection abilities., _(*7)

Using DynamoDB outside of AWS

Sometimes you'll want to test that DynamoDB sessions work on your local development environment. You can make that happen by defining AWS_ACCESS_KEY and AWS_SECRET_KEY. Please don't define these constants in the environment file in EC2 instances, as credentials are automatically handled by the IAM role inside of AWS., _(*8)

// the AWS access key and secret. This is optional if you've configured an instance with an IAM role
// http://docs.aws.amazon.com/aws-sdk-php/guide/latest/credentials.html#caching-iam-role-credentials
AWS_ACCESS_KEY=my-access-key
AWS_SECRET_KEY=my-secret

Local Testing

You can simulate DynamoDB locally for easier development through DynamoDB Local., _(*9)

Set environment constants. Note that actual access keys and regions are ignored, they just need to be defined., _(*10)

AWS_DYNAMODB_SESSION_TABLE=mysession
AWS_ACCESS_KEY=my-access-key
AWS_SECRET_KEY=my-secret
AWS_DYNAMODB_ENDPOINT=http://localhost:8000
AWS_REGION_NAME=us-east-1

Download DynamoDB Local and start it - it'll be available under http://localhost:8000., _(*11)

Now use the AWS CLI Tools to interact with your local DynamoDB., _(*12)

Create table:, _(*13)

aws dynamodb create-table --table-name mysession --attribute-definitions AttributeName=id,AttributeType=S --key-schema AttributeName=id,KeyType=HASH --provisioned-throughput ReadCapacityUnits=1,WriteCapacityUnits=1 --endpoint-url http://localhost:8000

List tables:, _(*14)

aws dynamodb list-tables --endpoint-url http://localhost:8000

List all sessions:, _(*15)

aws dynamodb scan --table-name mysession --endpoint-url http://localhost:8000

Delete all sessions (use create table to reset afterwards):, _(*16)

aws dynamodb delete-table --table-name mysession --endpoint-url http://localhost:8000

Contribute

Do you want to contribute? Great, please see the CONTRIBUTING.md guide., _(*17)

License

This module is released under the BSD 3-Clause License, see license.md., _(*18)

Changelog

See the separate CHANGELOG.md, _(*19)

Code of conduct

When having discussions about this module in issues or pull request please adhere to the SilverStripe Community Code of Conduct., _(*20)

The Versions

20/11 2017

dev-master

9999999-dev

SilverStripe DynamoDB integration.

silverstripe-vendormodule dynamodb