8.2.21 Розгортання та налаштування Etherpad

TheHost Banner EtherPad

Etherpad — це відкритий веборієнтований текстовий редактор, який дозволяє кільком користувачам одночасно редагувати один документ у режимі реального часу. Кожному учаснику призначається свій колір, що робить відстеження змін інтуїтивно зрозумілим. Це ідеальне рішення для спільної роботи над нотатками, протоколами зустрічей чи мозковими штурмами, яке пропонує миттєву синхронізацію та можливість перегляду історії змін.

Попередні вимоги та підготовка

Перш ніж розпочати встановлення Etherpad, переконайтеся, що ваш сервер відповідає мінімальним вимогам і готовий до роботи з Docker.

Вимоги

  • Віртуальний або виділений сервер із встановленою Ubuntu 24.04 LTS.
  • Мінімум 1 ГБ оперативної пам’яті (рекомендовано 2 ГБ для стабільної роботи).
  • Мінімум 10 ГБ вільного дискового простору.
  • root-доступ або користувач із правами sudo.
  • Встановлені Docker та Docker Compose. У межах цієї статті їх встановлення не розглядається.

Змінні середовища

Під час виконання інструкції вам може знадобитися замінити такі плейсхолдери:

  • SERVER_IP: IP-адреса вашого сервера.
  • YOUR_ADMIN_PASSWORD: Надійний пароль адміністратора Etherpad.
  • YOUR_DB_USER: Ім’я користувача бази даних.
  • YOUR_DB_PASSWORD: Пароль користувача бази даних.
  • YOUR_DB_NAME: Ім’я бази даних.

Оновлення системи Ubuntu

Перед встановленням будь-яких нових пакетів завжди рекомендується оновити список та встановлені пакети до останніх версій. Це гарантує використання найактуальніших версій ПЗ, які виправляють відомі помилки та вразливості.

Виконайте команду:

sudo apt update && sudo apt upgrade -y

Створення каталогу проєкту Etherpad

Рекомендується створювати окремий каталог для кожного Docker Compose-проєкту, щоб підтримувати порядок і відокремлювати конфігураційні файли та дані.

  1. Створіть каталог для Etherpad:
mkdir -p ~/etherpad

Пояснення:

  • mkdir — створює каталог.
  • -p — створює батьківські каталоги, якщо вони не існують.
  • ~/etherpad — шлях до нового каталогу у вашій домашній директорії.
  1. Перейдіть у створений каталог:
cd ~/etherpad

Пояснення: Усі подальші дії з файлом docker-compose.yml виконуватимуться з цього каталогу.

Створення файлу docker-compose.yml для Etherpad

Файл docker-compose.yml — це основа вашого багатоконтейнерного застосунку. У ньому визначаються всі сервіси, мережі та томи, потрібні для роботи Etherpad.

  1. Створіть файл docker-compose.yml:
nano docker-compose.yml
  1. Вставте вміст:
docker-compose.yml
services:
  etherpad:
    image: etherpad/etherpad:1.9.0
    ports:
      - "9001:9001"
    environment:
      # Вбудована файлова БД (не для продакшену)
      - DB_TYPE=sqlite
      - DB_PATH=/opt/etherpad-lite/var

      # Адмін (опційно)
      - ADMIN_USER=admin
      - ADMIN_PASSWORD=YOUR_ADMIN_PASSWORD

      # Базові налаштування
      - TITLE=Etherpad
      - TRUST_PROXY=true
    volumes:
      - etherpad_data:/opt/etherpad-lite/var
    restart: always

volumes:
  etherpad_data:

Збережіть файл (Ctrl+O, Enter, Ctrl+X).

Налаштування Etherpad через docker-compose.yml

Налаштування бази даних (SQLite)

За замовчуванням використовується SQLite, яка не потребує додаткової конфігурації, окрім зазначення шляху до файлу БД:

- DB_TYPE=sqlite
- DB_PATH=/opt/etherpad-lite/var

Пояснення:

  • DB_TYPE=sqlite — використання SQLite.
  • DB_PATH — шлях до dirty.db у контейнері (дані зберігаються на хості через том).

Запуск Etherpad за допомогою Docker Compose

Переконайтеся, що перебуваєте в каталозі ~/etherpad, де є docker-compose.yml, і виконайте:

docker compose up -d

Перевірка роботи

Перегляд логів

docker compose logs -f etherpad

Статус сервісів

docker compose ps

Доступ до Etherpad у браузері

Відкрийте браузер і перейдіть за адресою:

http://SERVER_IP:9001

Налаштування додаткових функцій

Плагіни Etherpad

  1. Перейдіть: http://SERVER_IP:9001/admin
  2. Увійдіть за допомогою YOUR_ADMIN_PASSWORD.
  3. У розділі керування плагінами можна шукати та встановлювати плагіни.

Поширені помилки

Поширені помилки
Помилка / Симптом Причина Рішення Діагностика (логи / команди)
Etherpad недоступний на порту 9001 Контейнер не запущено або порт зайнятий. Переконайтеся, що контейнер etherpad запущено. Перевірте, чи не зайнятий порт 9001 іншим застосунком на хості. docker compose ps , docker logs etherpad , `sudo ss -tulpn
Доступ за доменом не працює (Nginx) Помилка у конфігурації Nginx, домен не вказує на сервер або Nginx не перезапущено. Перевірте синтаксис конфігурації Nginx, переконайтеся, що доменні записи (A/AAAA) вказують на IP вашого сервера. Перезапустіть Nginx. sudo nginx -t , sudo systemctl status nginx , dig YOUR_DOMAIN
Зміни у settings.json не застосовуються Контейнер не було перезапущено після зміни файлу. Перезапустіть контейнер Etherpad: docker compose down && docker compose up -d . docker logs etherpad (шукати повідомлення про завантаження налаштувань)
Помилки під час роботи з падами (наприклад, збереження) Проблеми з правами доступу до директорії ./data або нестача місця на диску. Переконайтеся, що користувач Docker має права на запис у ~/etherpad/data. Перевірте наявність вільного місця на диску. docker logs etherpad , df -h , ls -l ~/etherpad/data
Не вдається встановити плагіни через вебінтерфейс Проблеми з мережевим доступом із контейнера або неправильні права. Перевірте мережеве підключення контейнера. Переконайтеся, що Etherpad має доступ до репозиторію плагінів. docker logs etherpad

Корисні посилання