Skip to content

How to use Etherpad Lite with Redis

John McLear edited this page Feb 1, 2021 · 6 revisions

How to use Etherpad Lite with Redis

  1. Install redis on your server, make sure it stores data persistent.
  2. Edit settings.json in your Etherpad Lite root folder and change the database settings.
"dbType" : "redis",
"dbSettings" : {
    "host"        : "localhost",
    "port"        : 6379, // Adjust port if you have multiple instances of redis.
    "database"    : 0, // You should choose a database id that is not already used.
                      // If you run redis only for etherpad you can leave this as 0.
    "client_options": {
      "password": "<very secure redis password>"

  1. Run etherpad lite


  • If you get Error: Cannot find module 'redis' you need to run npm install redis or npm install hiredis redis in the directory src.

  • If you get Error: Callback was already called, you may find help with this issue or by configuring the database with this format:

  "dbType": "${DB_TYPE:redis}",
  "dbSettings": {
    "port":     "${DB_PORT:redis://:PASSWORD@HOST:PORT}"



For Developers

How to's

Set up

Advanced steps

Integrating Etherpad in your web app

for Developers

Clone this wiki locally