Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/armenfilipetyan/express-session-rethinkdb
RethinkDB session store for Express 4.x
https://github.com/armenfilipetyan/express-session-rethinkdb
Last synced: 24 days ago
JSON representation
RethinkDB session store for Express 4.x
- Host: GitHub
- URL: https://github.com/armenfilipetyan/express-session-rethinkdb
- Owner: armenfilipetyan
- License: mit
- Created: 2014-10-29T17:13:52.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-11-22T09:20:48.000Z (about 8 years ago)
- Last Synced: 2024-11-09T12:43:45.864Z (about 1 month ago)
- Language: JavaScript
- Size: 36.1 KB
- Stars: 25
- Watchers: 1
- Forks: 12
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-rethinkdb - RethinkDB session store for Express 4
README
# Express Session RethinkDB
RethinkDB session store for Express 4.x
## Installation
```
npm install express-session-rethinkdb --save
```
## Getting started
Note that you must already have Express Session already installed (`npm install express-session --save`). Also this specific package uses `rethinkdbdash` driver which has more advanced features.
*See [rethinkdbdash](https://github.com/neumino/rethinkdbdash)*
```javascript
var express = require('express');
var cookie = require('cookie-parser');
var session = require('express-session');
var RDBStore = require('express-session-rethinkdb')(session);
var app = express();
var rdbStore = new RDBStore({
connectOptions: {
servers: [
{ host: '192.168.0.100', port: 28015 },
{ host: '192.168.0.101', port: 28015 },
{ host: '192.168.0.102', port: 28015 }
],
db: 'test',
discovery: false,
pool: false,
buffer: 50,
max: 1000,
timeout: 20,
timeoutError: 1000
},
table: 'session',
sessionTimeout: 86400000,
flushInterval: 60000,
debug: false
});
app.use(cookie());
app.use(session({
key: 'sid',
secret: 'my5uperSEC537(key)!',
cookie: { maxAge: 860000 },
store: rdbStore
}));
// the rest of your server code..
```
###With rethinkdbdash connection
```javascript
var express = require('express');
var cookie = require('cookie-parser');
var session = require('express-session');
var RDBStore = require('express-session-rethinkdb')(session);
var rethinkdb = require('rethinkdbdash');
var r = new rethinkdb({db: "test"}) //normal rethinkdbdash connection can be used across your project
var app = express();
var rdbStore = new RDBStore({
connection: r,
table: 'session',
sessionTimeout: 86400000,
flushInterval: 60000,
debug: false
});
app.use(cookie());
app.use(session({
key: 'sid',
secret: 'my5uperSEC537(key)!',
cookie: { maxAge: 860000 },
store: rdbStore
}));
// the rest of your server code..
```
###With Thinky
```javascript
var express = require('express');
var cookie = require('cookie-parser');
var session = require('express-session');
var RDBStore = require('express-session-rethinkdb')(session);
var thinky = require('thinky')({db: "test"});
var app = express();
var rdbStore = new RDBStore({
connection: thinky.r,
table: 'session',
sessionTimeout: 86400000,
flushInterval: 60000,
debug: false
});
app.use(cookie());
app.use(session({
key: 'sid',
secret: 'my5uperSEC537(key)!',
cookie: { maxAge: 860000 },
store: rdbStore
}));
// the rest of your server code..
```
##Constructor options
###connection
rethinkdbdash connection instance.
*See [RethinkDB's doc](http://www.rethinkdb.com/api/javascript/#connect)*
*Also see [rethinkdbdash](https://github.com/neumino/rethinkdbdash)*
###connectOptions
Options for connecting to the database server. (if connection is set connectOptions will be ignored)
*See [RethinkDB's doc](http://www.rethinkdb.com/api/javascript/#connect)*
*Also see [rethinkdbdash](https://github.com/neumino/rethinkdbdash)*
###table
Name of the table in which session data will be stored.
`Default: 'session'`
###sessionTimeout
If you do not set ```cookie.maxAge``` in ```session``` middleware, sessions will last until the user closes their browser.
However we cannot keep the session data infinitely (for size and security reasons).
In this case, this setting defines the maximum length of a session, even if the user does not close their browser.
`Default: 86400000` *1 day*
###flushInterval
RethinkDB does not yet provide an expiration function ( like ```SETEX``` for Redis ), so we have to remove the old expired sessions from the database intermittently. This is the time interval in milliseconds between flushing of expired sessions.
`Default: 60000` *60 seconds*
###debug
If debug is enabled, this middleware will start using console.log() to print debug type messages for session get, set, and destroy. These are currently mostly geared toward the memory caching. It takes a ```true``` or ```false``` value. `Default: false`
## Attribution
*Inspired by TJ Holowaychuk's [Connect Redis](https://github.com/visionmedia/connect-redis)*
*Inspired by guillaumervls [Connect RethinkDB](https://github.com/guillaumervls/connect-rethinkdb)*
##License
The MIT License (MIT)
Copyright (c) 2014-2015 Armen Filipetyan
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.