- \n
- Ubuntu 18.04 server<\/li>\n
- Root privileges<\/li>\n<\/ul>\n
What we will do?<\/h2>\n
- \n
- Install Packages Dependencies<\/li>\n
- Install Nodejs<\/li>\n
- Install and Configure MySQL<\/li>\n
- Download Etherpad<\/li>\n
- Configure Etherpad<\/li>\n
- Setup Etherpad as a Service<\/li>\n
- Setup Nginx as a Reverse Proxy for Etherpad<\/li>\n
- Setup UFW Firewall<\/li>\n
- Testing<\/li>\n<\/ol>\n
Step 1 – Install Packages Dependencies<\/h2>\n
The first step we will do in this guide is to install all package dependencies for Nodejs installation.<\/p>\n
Run the apt command below.<\/p>\n
sudo apt install gzip git curl python libssl-dev pkg-config gcc g++ make build-essential -y<\/code><\/pre>\nWait for all installation.<\/p>\n
Step 2 – Install Nodejs<\/h2>\n
Etherpad requires Node.js >= 6.9, and in this step we will install Nodejs 9.11 that can be installed from the nodesource repository.<\/p>\n
Add the nodesource Nodejs repository and install the Node.js package using commands below.<\/p>\n
curl -sL https:\/\/deb.nodesource.com\/setup_9.x | sudo -E bash -After this, check the nodejs and npm commands.<\/p>\n
nodejs --versionThe Node.js v9.11 has been installed on Ubuntu 18.04 server.<\/p>\n
![\"Install](\"https:\/\/afaghhosting.net\/blog\/wp-content\/uploads\/2018\/11\/how-to-install-collaborative-real-time-editor-etherpad-on-ubuntu-18-04.png\" "\\"\\"")
<\/a><\/p>\nStep 3 – Install and Configure MySQL<\/h2>\n
In this tutorial, we will be using MySQL as the database for Etherpad.<\/p>\n
Install MySQL database server using the apt command below.<\/p>\n
sudo apt install mysql-server mysql-client<\/code><\/pre>\nAfter the installation is complete, start the mysql service and enable it to launch everytime at system boot.<\/p>\n
sudo systemctl start mysqlThe MySQL server has been installed.<\/p>\n
Next, we will configure the mysql root password and create a new database and user for our etherpad installation.<\/p>\n
To configure the MySQL root password, run the command below.<\/p>\n
mysql_secure_installation<\/code><\/pre>\nType your strong mysql root password.<\/p>\n
Now login to the mysql shell using root user.<\/p>\n
mysql -u root -p<\/code><\/pre>\nCreate a new database named ‘etherpad_db’ and user ‘hakase’, and run mysql queries below.<\/p>\n
create database etherpad_db;MySQL database for etherpad installation has been created.<\/p>\n
![\"Install](\"https:\/\/afaghhosting.net\/blog\/wp-content\/uploads\/2018\/11\/how-to-install-collaborative-real-time-editor-etherpad-on-ubuntu-18-04-1.png\" "\\"\\"")
<\/a><\/p>\nStep 4 – Download Etherpad<\/h2>\n
In this step, we will create a new user and download the etherpad source code.<\/p>\n
Create a new user named ‘etherpad’ and login to the user.<\/p>\n
useradd -m -s \/bin\/bash etherpadNow clone the etherpad repository.<\/p>\n
git clone git:\/\/github.com\/ether\/etherpad-lite.git<\/code><\/pre>\nGo to the ‘etherpad-lite\/’ directory and run the bash script to start etherpad.<\/p>\n
cd etherpad-lite\/You will get the result as below.<\/p>\n
![\"Download](\"https:\/\/afaghhosting.net\/blog\/wp-content\/uploads\/2018\/11\/how-to-install-collaborative-real-time-editor-etherpad-on-ubuntu-18-04-2.png\" "\\"\\"")
<\/a><\/p>\nOpen your web browser and type the server IP address with port ‘9001’.<\/p>\n
http:\/\/192.168.33.10:9001\/<\/strong><\/em><\/p>\n
And you will see the etherpad home page.<\/p>\n
![\"Access](\"https:\/\/afaghhosting.net\/blog\/wp-content\/uploads\/2018\/11\/how-to-install-collaborative-real-time-editor-etherpad-on-ubuntu-18-04-3.png\" "\\"\\"")
<\/a><\/p>\nBack to your terminal and press ‘Ctrl+c’ to exit from the application.<\/p>\n
Step 5 – Configure Etherpad<\/h2>\n
In this step, we will do the basic configuration of etherpad collaborative editor.<\/p>\n
Login to the etherpad user and go to the ‘etherpad-lite’ directory.<\/p>\n
su - etherpadEdit the configuration ‘settings.json’ using vim editor<\/a>.<\/p>\n
vim settings.json<\/code><\/pre>\nChange the ip address to ‘127.0.0.1’ or localhost, because we will run the etherpad on Nginx reverse proxy.<\/p>\n
\u00a0 \"ip\": \"127.0.0.1\",Now disable the default dirty database by adding the comment ‘\/* …. *\/’, and paste the MySQL database configuration.<\/p>\n
\u00a0\u00a0 \/*MySQL database configuration.<\/p>\n
\u00a0 \"dbType\" : \"mysql\",![\"Etherpad](\"https:\/\/afaghhosting.net\/blog\/wp-content\/uploads\/2018\/11\/how-to-install-collaborative-real-time-editor-etherpad-on-ubuntu-18-04-4.png\" "\\"\\"")
<\/a><\/p>\nNext, we will enable the admin user by removing the comment from those lines and change the password value with a new password.<\/p>\n
\u00a0 \"users\": {![\"Configure](\"https:\/\/afaghhosting.net\/blog\/wp-content\/uploads\/2018\/11\/how-to-install-collaborative-real-time-editor-etherpad-on-ubuntu-18-04-5.png\" "\\"\\"")
<\/a><\/p>\nSave and exit.<\/p>\n
The basic etherpad configuration has been completed.<\/p>\n
Step 6 – Setup Etherpad as a service<\/h2>\n
Now we will run etherpad as a systemd service on our ubuntu system.<\/p>\n
Go to the ‘\/etc\/systemd\/system’ directory and create a new service file named ‘etherpad.service’.<\/p>\n
cd \/etc\/systemd\/system\/Paste configurations below.<\/p>\n
[Unit][Service]
[Install]
Save and exit.<\/p>\n
Reload the systemd service lists.<\/p>\n
sudo systemctl daemon-reload<\/code><\/pre>\nStart the etherpad service and enable it to launch every time at system boot.<\/p>\n
sudo systemctl start etherpadAnd the ether is up and running as a service on localhost ip with the default port 9001.<\/p>\n
![\"Run](\"https:\/\/afaghhosting.net\/blog\/wp-content\/uploads\/2018\/11\/how-to-install-collaborative-real-time-editor-etherpad-on-ubuntu-18-04-6.png\" "\\"\\"")
<\/a><\/p>\nCheck the service using commands below.<\/p>\n
sudo systemctl status etherpadStep 7 – Install and Configure Nginx as a Reverse proxy<\/h2>\n
In this step, we will install and configure Nginx web server as a reverse proxy for etherpad service.<\/p>\n
Install the nginx web server using apt command below.<\/p>\n
sudo apt install nginx -y<\/code><\/pre>\nAfter the installation is complete, go to the ‘\/etc\/nginx\/sites-available’ directory and create a new virtual host ‘etherpad’.<\/p>\n
cd \/etc\/nginx\/sites-available\/Paste configurations below.<\/p>\n
server {# we're in the http context here
server {
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 access_log\u00a0 \/var\/log\/nginx\/eplite.access.log;
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ssl\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 on;
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ssl_session_timeout\u00a0 5m;<\/p>
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 location \/ {
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }
Save and exit.<\/p>\n
Note:<\/strong><\/p>\n
- \n
- Make sure you change the path of the SSL with your own ssl certificates.<\/li>\n
- Change the etherpad domain ‘pad.hakase.io’ with your own domain name.<\/li>\n<\/ul>\n
Now activate the etherpad virtual host and test the configuration.<\/p>\n
ln -s \/etc\/nginx\/sites-available\/etherpad \/etc\/nginx\/sites-enabled\/Make sure there is no error, then start the nginx service and enable it to launch everytime at system boot.<\/p>\n
sudo systemctl restart nginx![\"Etherpad](\"https:\/\/afaghhosting.net\/blog\/wp-content\/uploads\/2018\/11\/how-to-install-collaborative-real-time-editor-etherpad-on-ubuntu-18-04-7.png\" "\\"\\"")
<\/a><\/p>\nThe Nginx installation and configuration as etherpad reverse proxy has been completed successfully.<\/p>\n
Step 8 – Setup UFW Firewall<\/h2>\n
For the firewall setup, we just want to open the SSH, HTTP, and HTTPS port services.<\/p>\n
Run ufw commands below.<\/p>\n
sudo fuw allow sshThen enable the ufw firewall.<\/p>\n
sudo ufw enable<\/code><\/pre>\nAnd the ufw firewall configuration has been completed.<\/p>\n
Step 9 – Testing<\/h2>\n
Open your web browser and type the etherpad domain name, mine is:\u00a0http:\/\/pad.hakase.io\/<\/strong><\/em><\/p>\n
Now you will be redirected to the HTTS secure connection.<\/p>\n
![\"Access](\"https:\/\/afaghhosting.net\/blog\/wp-content\/uploads\/2018\/11\/how-to-install-collaborative-real-time-editor-etherpad-on-ubuntu-18-04-8.png\" "\\"\\"")
<\/a><\/p>\nCreate a new pad by typing the pad name on the box and click the ‘OK’ button.<\/p>\n
And you will get the Etherpad editor as below.<\/p>\n
![\"Etherpad](\"https:\/\/afaghhosting.net\/blog\/wp-content\/uploads\/2018\/11\/how-to-install-collaborative-real-time-editor-etherpad-on-ubuntu-18-04-9.png\" "\\"\\"")
<\/a><\/p>\nNext, open the etherpad admin URL. Mine is\u00a0https:\/\/pad.hakase.io\/admin\/<\/strong><\/em><\/p>\n
You will be asked the admin username and password. Type your own user and password, then click the Signin button.<\/p>\n
![\"Etherpad](\"https:\/\/afaghhosting.net\/blog\/wp-content\/uploads\/2018\/11\/how-to-install-collaborative-real-time-editor-etherpad-on-ubuntu-18-04-10.png\" "\\"\\"")
<\/a><\/p>\nAnd you will get the default Etherpad admin page below.<\/p>\n
– Etherpad settings.json Configuration<\/strong><\/p>\n
![\"Install](\"https:\/\/www.howtoforge.com\/images\/how_to_install_collaborative_real_time_editor_etherpad_on_ubuntu_1804\/big\/11.png\" "\\"\\"")
<\/a><\/p>\n