connect-dynamodb is a DynamoDB session store backed by the aws-sdk
$ npm install connect-dynamodb
Rational defaults are set but can be overridden in the options object. Credentials and configuration are automatically loaded from environment variables or shared credentials but may optionally be passed through a JSON file or object. The client attribute is necessary for use with DynamoDB Local but can be left out if using DynamoDB with your AWS account. To use DynamoDB TTL, enable it on the table and select the expires
field.
- One of the following if not using environment variables or shared credentials:
AWSConfigPath
Optional path to a file containing your AWS credentials and configurationAWSConfigJSON
Optional JSON object containing your AWS credentials and configuration
client
Optional AWS DynamoDB object fromnew AWS.DynamoDB()
AWSRegion
Optional AWS region (defaults to 'us-east-1', ignored if usingAWSConfigPath
orAWSConfigJSON
)table
Optional DynamoDB server session table name (defaults to "sessions")hashKey
Optional hash key (defaults to "id")prefix
Optional key prefix (defaults to "sess")reapInterval
Legacy session expiration cleanup in milliseconds. Should instead enable DynamoDB TTL and select theexpires
field. BREAKING CHANGE from v1.0.11 to v2.0.0 for reaping sessions with changes to the format of the expires field timestamp.
var options = {
// Optional DynamoDB table name, defaults to 'sessions'
table: 'myapp-sessions',
// Optional path to AWS credentials and configuration file
// AWSConfigPath: './path/to/credentials.json',
// Optional JSON object of AWS credentials and configuration
AWSConfigJSON: {
accessKeyId: <YOUR_ACCESS_KEY_ID>,
secretAccessKey: <YOUR_SECRET_ACCESS_KEY>,
region: 'us-east-1'
},
// Optional client for alternate endpoint, such as DynamoDB Local
client: new AWS.DynamoDB({ endpoint: new AWS.Endpoint('http://localhost:8000')}),
// Optional ProvisionedThroughput params, defaults to 5
readCapacityUnits: 25,
writeCapacityUnits: 25
};
With connect
var connect = require('connect');
var DynamoDBStore = require('connect-dynamodb')(connect);
connect()
.use(connect.cookieParser())
.use(connect.session({ store: new DynamoDBStore(options), secret: 'keyboard cat'}));
With express 3
var DynamoDBStore = require('connect-dynamodb')(express);
var app = express(
express.cookieParser(),
express.session({ store: new DynamoDBStore(options), secret: 'keyboard cat'});
);
With express 4
var app = express();
var session = require('express-session');
var DynamoDBStore = require('connect-dynamodb')({session: session});
app.use(session({store: new DynamoDBStore(options), secret: 'keyboard cat'}));
If you want to run the tests locally and have the AWS environment variables setup you can run the command:
npm test
You can also run it locally by running the following two scripts in separate terminals:
docker run -it --rm \
--name=dynamodb-test \
-p 127.0.0.1:8000:8000 \
deangiberson/aws-dynamodb-local
export AWS_CONFIG_JSON='{"endpoint": "http://127.0.0.1:8000", "region": "us-east-1", "accessKeyId": "accesskey", "secretAccessKey": "secretaccesskey"}'
npm test
connect-dynamodb is licensed under the MIT license.
I made this in my spare time, so if you find it useful you can donate at my BTC address: 35dwLrmKHjCgGXyLzBSd6YaTgoXQA17Aoq
. Thank you very much!