1. ホーム
  2. マニュアル
  3. VPS
  4. アプリイメージの利用
  5. Zulipアプリイメージを利用する

Zulipアプリイメージを利用する

1.Zulipについて

1-1.Zulipとは

Zulipは、リアルタイムチャットとスレッド型メッセージの特徴を併せ持つ、チーム向けのチャットツールです。
話題ごとにトピックを分けてやり取りできるため、複数の話題が同時に進行しても、情報が整理された状態でやり取りできます。

1-2.特徴

特徴 説明
スレッド型チャット 各トピックごとにスレッドを分けて会話できるため、話題ごとに情報を整理できます。
ストリーム機能 Slackのチャンネルに似た機能で、プロジェクトや部署などの単位で作成し、話題を分けて管理できます。
通知設定の柔軟性 通知はトピック単位でのON/OFF設定が可能で、必要な話題だけを確認できます。
外部サービス連携 GitHubやJenkinsなどと連携でき、開発や運用に関する通知をまとめて受け取れます。
マルチデバイス対応 専用アプリが提供されており、スマートフォンからでもアクセスできます。

1-3.活用例

活用例 説明
複数プロジェクトの話題整理 プロジェクトごとにストリームを分けることで、並行する案件も整理してやりとりできます。
チームのタスク管理 作業内容ごとにトピックを分けて会話を進めることで、タスクの対応状況を整理できます。
開発チームの通知集約 コードの更新やテスト結果などを通知することで、最新の状況を確認できます。

2.Zulipアプリイメージインストール手順

利用可能プランについて

本イメージは2GBプラン以上のご契約で利用可能です。

シンVPSをご利用中の方

利用中のサーバーにZulipアプリイメージをインストールしたい場合、「OS再インストール」をご参照の上、インストールを行ってください。

1.「追加申し込み」をクリック

シンアカウントへログインし、「追加申し込み」をクリックしてください。

追加申し込み

2.Zulipをインストール

「イメージタイプ」における「アプリケーション」タブより「Zulip」をクリックしてください。

Zulipをインストール

お申し込み・お支払いを完了することでサーバーへ自動でインストールされます。

アプリケーションが選択できない場合

Zulipイメージは1GBプラン以下ではご利用いただけませんので、2GBプラン以上をお申込みください。

3.事前準備

3-1.パケットフィルターの設定

Zulipを利用するには、使用する機能に応じて、以下のポートを開放する必要があります。
必須ポートについては必ず開放し、任意ポートについては必要に応じて設定してください。

VPSパネルの「パケットフィルター設定」画面から「ONにする(推奨)」にチェックを入れ、該当のポートを許可するルールを追加してください。

必須ポート
用途 ポート番号 目的
HTTP TCP 80 Let's EncryptによるSSL証明書の取得・更新を行うため。
HTTPS TCP 443 Webブラウザやアプリにて暗号化通信でアクセスするため。
任意ポート
用途 ポート番号 目的
SSH TCP 22 Tera TermなどのSSHクライアントを使ってサーバーに接続する場合。
ご利用の構成や機能に応じて必要なポートのみ開放してください。
使用していない機能に関連するポートは、セキュリティ上の観点から開放しないことを推奨します。

パケットフィルターの設定は下記マニュアルからご確認ください。
パケットフィルターの設定について

3-2.ドメインの準備

Zulipは、Webブラウザまたは専用アプリを通じたアクセスが前提となるため、SSL/TLSによる暗号化通信(HTTPS)の利用を推奨します。
独自のドメインを準備し、DNSの「Aレコード」にVPSのIPアドレスを設定してください。

3-3.SMTPサーバーの準備

Zulipは、ユーザー招待にSMTPサーバーが必要になります。
SMTPサーバー(Gmail・Yahooなど)及びSMTPサーバーを使用するアカウントを準備してください。

4.Zulipセットアップ手順

4-1.Zulipセットアップ

1.サーバーに接続する

VPS管理画面のコンソールからも接続可能ですが、コピー&ペーストが可能なSSHクライアントソフトの使用をおすすめします。本マニュアルではTera Termを使用します。

Tera Termを起動し、VPSのIPアドレスを入力してください。

IPアドレスを入力

2.ユーザー名、パスフレーズを入力

「ユーザー名(N)」に「root」、「パスフレーズ(P)」にアプリイメージのインストール時に設定したパスフレーズを入力してください。

認証情報を入力

3.Zulipをインストール

下記のコマンドを実行してください。

/opt/zulip-server-*/scripts/setup/install --certbot --email= 管理者用のメールアドレス --hostname=事前にご用意いただいたFQDN

コマンドを実行するとメッセージが流れます。
途中でLet's Encryptの利用規約が表示されますので、「Y」キーを入力し、同意してください。
※自己証明書でSSL/TLSを設定する場合は表示されません。

メールアドレスを入力

インストールが完了したら、初回セットアップ用URLが表示されるので控えてください。

メール受け取り確認

4.SMTP設定

Zulipはメール通知をするためにSMTPサーバーの設定が必要なため、設定ファイルを編集します。

以下コマンドを実行します。

nano /etc/zulip/settings.py

以下項目を指定の値に設定します。
※行頭の#は削除してください。
※EMAIL_HOSTとEMAIL_HOST_USERは""で囲ってください。

EMAIL_HOST = "SMTPサーバーのホスト名"
                                                
EMAIL_HOST_USER = "SMTPユーザー名(メールアドレス)"
EMAIL_USE_TLS = True
EMAIL_PORT = SMTPポート番号

以下コマンドを実行します。

nano /etc/zulip/zulip-secrets.conf

一番下に以下を追記します。

email_password = SMTPユーザーのパスワード

GoogleのSMTPサーバーを利用する場合

GmailのSMTPサーバーを利用する場合はプリンタ、スキャナ、アプリからのメール送信からSMTPサーバーの情報を確認できます。

Googleアカウントの2段階認証の設定と「アプリパスワード」を設定する必要があります。
2段階認証の設定は2段階認証プロセスを有効にするから確認できます。
アプリパスワードの設定方法はアプリ パスワードでログインするから確認できます。
設定したアプリパスワードを「email_password」に入力してください。

以下コマンドを実行し、Zulipを再起動して、設定を反映します。

sudo -u zulip /home/zulip/deployments/current/scripts/restart-server

4-2.Zulipサーバー接続

1.新しいZulip組織を作成

3.Zulipをインストール」で控えた初回セットアップ用URLをブラウザで開きます。
「新しいZulip組織を作成」より、各設定を入力し、組織の作成をクリックします。

URLを紛失したり、無効となった場合は以下コマンドを実行し、再度URLを発行してください。

su zulip -c '/home/zulip/deployments/current/manage.py generate_realm_creation_link'

Zulipにログイン

項目 説明
組織名 任意の組織名を設定
組織のタイプ 任意の組織タイプを設定
Organization language 任意の言語を設定
Your email 管理者用メールアドレスを設定

2.登録

各設定を入力し、「登録」ボタンをクリックします。

登録

項目 説明
名前 任意の管理者アカウント名を設定
パスワード 任意のパスワードを設定
How did you first hear about Zulip? 「どこでZulipを知ったか」任意の選択肢を選択

3.セットアップ完了

以下画面が表示されたら、初回セットアップが完了です。

セットアップ完了

5.ユーザーを招待

ユーザーの招待は招待リンクを作成する方法と招待メールを送付する方法があります。

1.招待リンクを作成

右側「組織にユーザーを招待する」をクリックします。

招待リンクを作成

2.ユーザーを招待

「Invitation link」を選択し、「Create link」をクリックします。

※Invitation expires afterでリンクの有効期限、Users join asでユーザー権限を任意で設定します。

ユーザーを招待

3.ユーザーに連携

上部にリンクが作成されますので、招待したいユーザーに連携します。

ユーザーに連携

4.登録

ユーザー側で招待リンクをブラウザで開き、メールアドレスを入力後、登録をクリックします。

登録

5.メール送信

以下画面が表示され、入力したメールアドレス宛にメールが送付されます。

メール送信

6.招待メール確認

招待メールが送付されているので、「登録を完了」をクリックします。

招待メール確認

7.登録完了

各設定を入力し、「登録」ボタンをクリックします。

登録完了

項目 説明
名前 任意のアカウント名を設定
パスワード 任意のパスワードを設定

以上でユーザーの招待は完了です。

6.招待メールを送付

1.「組織にユーザーを招待する」をクリック

右側「組織にユーザーを招待する」をクリックします。

「組織にユーザーを招待する」をクリック

2.「招待」をクリック

「Email invitation」を選択し、メールアドレスの欄に招待したいユーザーのメールアドレスを入力し、「招待」をクリックします。

※Invitation expires afterでリンクの有効期限、Users join asでユーザー権限を任意で設定します。

「招待」をクリック

3.「登録を完了」をクリック

入力したメールアドレス宛に招待メールが送付されているので「登録を完了」をクリックします。

「登録を完了」をクリック

4.登録完了

「名前」にアカウント名、「パスワード」に設定したいパスワードを入力し、「登録」をクリックします。

登録完了

以上でユーザーの招待は完了です。