Skip to content

Latest commit

 

History

History
84 lines (51 loc) · 3.06 KB

README.md

File metadata and controls

84 lines (51 loc) · 3.06 KB

Etherpad Deployment

Abstract

This report provides a detailed walk-through of our process to deploy an instance of Etherpad on Oracle Cloud using Docker. We discuss the steps involved from cloning the Etherpad repository, configuring it, building a personalized Docker image and creating a Docker Compose file for the Etherpad and MariaDB containers.

Table of Contents

  1. Introduction
  2. Pre-requisites
  3. Cloning the Etherpad Repository
  4. Configuration of the Etherpad
  5. Building the Docker Image
  6. Creating the Docker Compose File
  7. Deploying Etherpad on Oracle Cloud
  8. Accessing the Etherpad Instance
  9. Conclusion

Introduction

In this report, we outline the steps we took to deploy an Etherpad instance on Oracle Cloud using Docker. This is a simple Overview of the full project:

High Level Architecture Diagram

Pre-requisites

Before beginning the deployment, we ensured that the following requirements were met.

  • A Cloud Provider account

we used Oracle Cloud because it offers good free tier options.

Cloning the Etherpad Repository

After login in our VM instance, we started by cloning the Etherpad repository from Github.

git clone https://github.com/ether/etherpad-lite.git

Configuration of the Etherpad

We then modified the configuration file to suit our needs:

  1. Enable the authentication system

settings.json.docker

We added the authentication and a new user

Building the Docker Image

We built a Docker image:

docker build --tag personalized/etherpad .

Creating the Docker Compose File

Next, we created a Docker Compose file to manage our Etherpad and MariaDB containers.

docker-compose.yml

We added the official MariaDB container and the environment variables

The depends_on option in your Docker Compose specifies that the etherpad service is started after the db service.

Note: Docker Compose automatically sets up a network for each service and each one is reachable at a hostname identical to the service name. So, in this case, db is the hostname that the etherpad service uses to connect to the database.

Deploying Etherpad on Oracle Cloud

We then deployed the Etherpad instance on Oracle Cloud machine:

docker-compose up -d

Accessing the Etherpad Instance

To access the deployed Etherpad instance, navigate to the service http://129.151.251.123:9001/ in your web browser.

Conclusion

In this report, we drafted a the process to deploy a simple Etherpad instance and provided instructions on how to access it.