How to use Etherpad Lite with MySQL

Stefan edited this page Nov 23, 2016 · 15 revisions

General

Resources

For Developers

How to's

Set up

Advanced steps

Integrating Etherpad in your web app

for Developers

Clone this wiki locally
  1. Connect to mysql by opening a command prompt and typing the following: mysql -u root -p
  2. Once logged in, issue the following command to create the database: create database `etherpad-lite`;
  3. Grant permissions to a new database account. Replace <user> and <password> with your own values. grant CREATE,ALTER,SELECT,INSERT,UPDATE,DELETE on `etherpad-lite`.* to '<user>'@'localhost' identified by '<password>';
  4. Leave the mysql client exit
  5. Edit settings.json in your Etherpad Lite root folder and change the database settings (if you have a non-default port configured for MySQL you will have to add the "port" setting). It is strongly encouraged to set the option "charset" to "utf8mb4".
  6. Run etherpad lite

Example MySQL Socket Config.

"dbType" : "mysql",
"dbSettings" : {
    "user"    : "user",
    "port"    : "/var/run/mysqld/mysqld.sock",
    "password": "secret",
    "database": "database",
    "charset" : "utf8mb4"
}

Structure of table 'store'

CREATE TABLE `store` (
  `key` varchar(100) COLLATE utf8mb4_bin NOT NULL DEFAULT '',
  `value` longtext COLLATE utf8mb4_bin NOT NULL,
  PRIMARY KEY (`key`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin