From 031cdd738aff89705b66ba9d06449c03bff4bacd Mon Sep 17 00:00:00 2001 From: PangeaCake Date: Wed, 7 Jan 2015 14:24:50 -0800 Subject: [PATCH] Add postgres information to README.md --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e3acf6c..4715bf6 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ Where `path` represents where you want the files stored ### Redis -To use redis storage you must install the redis package in npm +To use redis storage you must install the `redis` package in npm `npm install redis` @@ -106,6 +106,28 @@ Once you've done that, your config section should look like: } ``` +### Postgres + +To use postgres storage you must install the `pg` package in npm + +`npm install pg` + +Once you've done that, your config section should look like: + +``` json +{ + "type": "postgres", + "connectionUrl": "postgres://user:password@host:5432/database +} +``` + +You can also just set the environment variable for `DATABASE_URL` to your database connection url. + +Lastly, you will have to manually add a table to your postgres database: + +`create table entries (id serial primary key, key varchar(255) not null, value text not null, expiration int, unique(key));` + + You can also set an `expire` option to the number of seconds to expire keys in. This is off by default, but will constantly kick back expirations on each view or post.