Ubuntu 24.04サーバーにEtherpadコラボレーションエディタをインストールする方法

Etherpadは、チームのためのオープンソースのコラボレーティブでリアルタイムのテキストエディタであり、ウェブベースのテキストエディタであるため、いつでもどこでもアクセスできます。Etherpadはバージョン管理と組み込みのフォーマットをサポートしており、さまざまなプラグインのサポートを受けた非常にカスタマイズ可能なエディタを提供します。また、doc、pdf、odt、markdownなどの現代的な文書形式もサポートしています。

このガイドでは、Ubuntu 24.04サーバーにEtherpadコラボレーションエディタをインストールするプロセスを説明します。MariaDBデータベースサーバーを使用してEtherpadをセットアップし、Nginxをリバースプロキシとして使用し、CertbotとLetsencryptを通じてHTTPSでEtherpadを保護します。

前提条件

このガイドを始める前に、次のものを用意してください：

Ubuntu 24.04サーバー。
管理者権限を持つ非ルートユーザー。
サーバーIPアドレスにポイントされたドメイン名。

依存関係のインストール

EtherpadはNode.jsで書かれたコラボレーティブなリアルタイムエディタです。これをインストールするには、Node.js、NPM、Gitなどのパッケージ依存関係をインストールする必要があります。Etherpadはデータベース用にPython3とMySQL/MariaDBも必要です。

まず、次のコマンドでUbuntuリポジトリを更新します：

sudo apt update

update repo

次に、以下のコマンドを使用してEtherpadの依存関係をインストールします。このコマンドで、MariaDBサーバー、Nginx、Node.js、Python3、Git、およびいくつかの必須ツールをインストールします。

sudo apt install mariadb-server nginx nodejs npm gzip git curl python3 libssl-dev

インストールを確認するためにYを入力します。

install deps

インストール後、MariaDBとNginxサービスを確認して、両方のサービスが実行中であることを確認します。

以下のコマンドでMariaDBサービスを確認します：

sudo systemctl is-enabled mariadb  
sudo systemctl status mariadb

以下のように、MariaDBサービスが実行中であり、ブート時に自動的に開始されることがわかります。

check mariadb

次に、以下のコマンドを使用してNginxサービスを確認します。Nginxサービスが実行中で有効な場合、同様の出力が得られるはずです。

sudo systemctl is-enabled nginx  
sudo systemctl status nginx

check nginx

最後に、以下のコマンドでNode.jsのバージョンを確認します。

node -v

Node.js v18.x以上がインストールされていることを確認してください。EtherpadはNode.js v18以上をサポートしています。

MariaDBサーバーの設定

依存関係をインストールした後、MariaDBサーバーを設定し、Etherpad用の新しいデータベースとユーザーを作成します。次に、’mariadb-secure-installation’ユーティリティを使用してMariaDBを保護し、MariaDBクライアントを通じてデータベースとユーザーを設定します。

MariaDBサーバーを保護するには、次のコマンドを実行します：

sudo mariadb-secure-installation

MariaDBサーバーの設定が求められます：

デフォルトのMariaDBインストールにはパスワードがないため、パスワードを求められたらENTERを押します。
MariaDBのrootパスワードを設定するためにYを入力します。次に、MariaDBの新しいパスワードを入力し、パスワードを繰り返します。
MariaDBインストールから匿名ユーザーを削除するためにYを入力します。
MariaDBのrootユーザーのリモートログインを無効にするように求められたら再度Yを入力します。
MariaDBからデフォルトのデータベーステストを削除するためにYを入力します。
最後に、テーブルの権限を再読み込みして新しい変更を適用するためにYを入力します。

MariaDBサーバーを保護して設定した後、Etherpad用の新しいデータベースとユーザーを作成します。

以下のコマンドでMariaDBサーバーにログインします。求められたらMariaDBのrootパスワードを入力します。

sudo mariadb -u root -p

次に、以下のMariaDBクエリを実行して、新しいデータベース ‘etherpad_db‘、ユーザー ‘etherpad‘、パスワード ‘StrongPasswordEtherpadDB‘ を作成します。以下のデータベースの詳細をあなたの情報に合わせて調整できます。

CREATE DATABASE etherpad_db;  
CREATE USER etherpad@localhost IDENTIFIED BY 'StrongPasswordEtherpadDB';  
GRANT CREATE,ALTER,SELECT,INSERT,UPDATE,DELETE on etherpad_db.* to etherpad@localhost;  
FLUSH PRIVILEGES;

create database and user

次に、以下のクエリを実行して、ユーザー ‘etherpad‘ がデータベース ‘etherpad_db‘ にアクセスできることを確認します。

SHOW GRANTS FOR etherpad@localhost;

以下のように、ユーザー ‘etherpad‘ がデータベース ‘etherpad_db‘ に対して複数の権限を持っていることがわかります。

最後に、quitと入力してMariaDBサーバーから退出します。

check db user

Etherpad Liteのインストール

データベースとユーザーを作成した後、Etherpadのソースコードをダウンロードし、インストーラースクリプトでEtherpadの依存関係をインストールし、MariaDBサーバーでEtherpadのインストールを構成します。

デフォルトでは、Etherpadはpnpmパッケージマネージャーを使用してインストールを管理するため、最初にシステムに’pnpm’をグローバルにインストールする必要があります。

まず、以下のnpmコマンドを使用してpnpmパッケージをグローバルに(-g)インストールします。デフォルトで、Etherpadプロジェクトは標準のnpmではなくNode.jsパッケージマネージャーとしてpnpmを使用します。

npm install pnpm -g

次に、以下のコマンドを実行して新しいシステムユーザー ‘etherpad‘ を作成します。このユーザーはEtherpadアプリケーションを実行するために使用されます。

sudo adduser --system --no-create-home --home=/opt/etherpad-lite --group etherpad

次に、/optに移動し、gitを使用して’etherpad-lite‘ディレクトリにEtherpadのソースコードをダウンロードします。その後、’/opt/etherpad-lite‘ディレクトリの所有権をユーザー’etherpad‘に変更します。

cd /opt && git clone --branch master https://github.com/ether/etherpad-lite.git   
sudo chown -R etherpad:etherpad /opt/etherpad-lite

その後、’opt/etherpad-lite’ディレクトリに移動し、以下のコマンドでEtherpadのNode.js依存関係をインストールします。

cd /opt/etherpad-lite  
sudo su -s /bin/bash -c "./bin/run.sh" etherpad

以下は、pnpmパッケージマネージャーを使用してEtherpadの依存関係をダウンロードするプロセスです。

dependencies installation

依存関係がインストールされた後、Etherpadは自動的に実行されるはずです。以下のように、Etherpad 2.0.3が実行中であることがわかります。

Ctrl+cを押して現在のEtherpadプロセスを終了します。MariaDBデータベースでEtherpadを構成します。

running etherpad

次に、以下のnanoエディタで’settings.json‘ファイルを開きます。

nano settings.json

Etherpadインストールのタイトルを変更します。

 "title": "Etherpad Ubuntu 24",

デフォルトのIPアドレスを12.0.0.1またはlocalhostに変更します。これにより、Etherpadプロセスがlocalhostのみで開始されます。

"ip": "127.0.0.1",  
"port": 9001,

デフォルトの’dirty‘データベース設定を以下のようにコメントアウトします。

 /*  
 *"dbType": "dirty",  
 *"dbSettings": {  
 * "filename": "var/dirty.db"  
 *},  
 */

以下の設定を挿入して、MariaDBサーバーでデータベースを設定します。データベース情報の詳細を自分のものに変更してください。

 "dbType" : "mysql",  
 "dbSettings" : {  
 "user": "etherpad",  
 "host": "127.0.0.1",  
 "port": 3306,  
 "password": "StrongPasswordEtherpadDB",  
 "database": "etherpad_db",  
 "charset": "utf8mb4"  
 },

完了したら、ファイルを保存してエディタを終了します。

systemdサービスとしてEtherpadを実行する

Etherpadをインストールして構成したので、Etherpad用の新しいsystemdサービスファイルを作成します。これにより、Etherpadをバックグラウンドで実行し、’systemctl’コマンドを通じてEtherpadを管理できます。

以下のコマンドでnanoエディタを使用してEtherpadの新しいsystemdサービスファイル’/etc/systemd/system/etherpad.service‘を作成します。

sudo nano /etc/systemd/system/etherpad.service

ファイルに以下の設定を追加します。これにより、’pnpm’コマンドを通じてバックグラウンドでsystemdサービスとしてEtherpadを実行します。

[Unit]  
Description=Etherpad-lite, the collaborative editor.  
After=syslog.target network.target mariadb.service  
  
[Service]  
Type=simple  
User=etherpad  
Group=etherpad  
WorkingDirectory=/opt/etherpad-lite  
ExecStart=/usr/local/bin/pnpm run prod  
# use mysql plus a complete settings.json to avoid Service hold-off time over, scheduling restart.  
Restart=always  
  
[Install]  
WantedBy=multi-user.target

ファイルを保存して終了します。

次に、以下のコマンドを実行してsystemdマネージャーを再読み込みし、Etherpadサービスファイルを適用します。

sudo systemctl daemon-reload

systemdが再読み込みされた後、以下のsystemctlコマンドで’etherpad’サービスを開始し、有効にします。

sudo systemctl start etherpad  
sudo systemctl enable etherpad

次に、以下のコマンドを実行してEtherpadサービスのステータスを確認し、サービスが実行中であることを確認します。

sudo systemctl status etherpad

以下のように、Etherpadサービスがサービスとして実行中であることがわかります。

最後に、以下の’ss‘コマンドでデフォルトのEtherpadポート9001を確認します。Etherpadプロセスによってポート9001が使用されていることがわかります。

ss -tulpn | grep 9001

Nginxをリバースプロキシとして設定する

このガイドでは、Nginxをリバースプロキシとして使用してEtherpadを実行します。したがって、Etherpad用のNginxサーバーブロック設定を作成し、Etherpad用のドメイン名を準備していることを確認します。

以下のnanoエディタコマンドを使用して新しいNginxサーバーブロック’/etc/nginx/sites-available/etherpad.conf’を作成します。

sudo nano /etc/nginx/sites-available/etherpad.conf

以下の設定を追加し、server_nameオプションをあなたのドメイン名に変更します。この設定により、ポート9001で実行されているEtherpadのためにNginxをリバースプロキシとして使用します。

server {  
 listen 80;  
 server_name etherpad.howtoforge.local;  
  
 access_log /var/log/nginx/eplite.access.log;  
 error_log /var/log/nginx/eplite.error.log;  
  
location / {  
 proxy_pass http://127.0.0.1:9001;  
 proxy_buffering off; # be careful, this line doesn't override any proxy_buffering on set in a conf.d/file.conf  
 proxy_set_header Host $host;  
 proxy_pass_header Server;  
# Note you might want to pass these headers etc too.  
 proxy_set_header X-Real-IP $remote_addr; # https://nginx.org/en/docs/http/ngx_http_proxy_module.html  
 proxy_set_header X-Forwarded-For $remote_addr; # EP logs to show the actual remote IP  
 proxy_set_header X-Forwarded-Proto $scheme; # for EP to set secure cookie flag when https is used  
 proxy_http_version 1.1; # recommended with keepalive connections  
# WebSocket proxying - from https://nginx.org/en/docs/http/websocket.html  
 proxy_set_header Upgrade $http_upgrade;  
 proxy_set_header Connection "upgrade";  
 }  
  
}

完了したら、ファイルを保存して閉じます。

次に、以下のコマンドを実行してサーバーブロック’etherpad.conf’ファイルを有効にし、Nginxの構文を確認します。

sudo ln -s /etc/nginx/sites-available/etherpad.conf /etc/nginx/sites-enabled/  
sudo nginx -t

適切なNginx構文で’nginx is ok…test is successful‘という出力が得られるはずです。

最後に、以下のコマンドを実行してNginxサービスを再起動し、新しいサーバーブロックを適用します。コマンドを実行した後、EtherpadはNginxウェブサーバーを通じてアクセス可能になります。

sudo systemctl restart nginx

HTTPSでEtherpadを保護する

Nginxリバースプロキシを設定した後、HTTPSでEtherpadを保護します。パブリックドメインを使用している場合は、CertbotとLetsencryptを使用してHTTPSを設定するための以下の手順を使用できます。ローカルドメインユーザーは自己署名証明書を使用できます。

以下のコマンドを使用してCertbotとCertbot Nginxプラグインをインストールします。プロンプトが表示されたら、インストールを確認するためにYを入力します。

sudo apt install certbot python3-certbot-nginx

次に、以下のcertbotコマンドを実行してLetsencryptからSSL/TLS証明書を生成します。ドメイン名とメールアドレスをあなたの詳細に変更してください。

sudo certbot --nginx --agree-tos --redirect --hsts --staple-ocsp --email [email protected] -d etherpad.howtoforge.local

プロセスが完了すると、証明書は’/etc/letsencrypt/live/domain.com‘ディレクトリに保存されます。また、EtherpadインストールはCertbot Nginxプラグインを通じて自動的にHTTPSで実行されるはずです。

Etherpadへのアクセス

Etherpadのドメイン名 https://etherpad.howtoforge.localにアクセスして、Etherpadインストールにアクセスします。成功すると、次のページが表示されます：

最初のパッドの新しい名前を入力し、OKをクリックして確認します。

create pad

これで、Etherpadのドキュメントエディタが表示されます。友人や同僚と同時にドキュメントを編集できます。

etherpad editor

結論

おめでとうございます！Ubuntu 24.04サーバーにEtherpadコラボレーションエディタをインストールしました。MariaDBデータベースサーバーとNginxウェブサーバーでEtherpadが実行されています。また、CertbotとLetsencryptを通じてHTTPSでEtherpadを保護しました。