幻魔ナイトブログ

主に絵、音楽、プログラミングなどについて書きます。

Rocket.Chatのドキュメント解読①（管理者ガイド:General）

f:id:MahiroN:20200615164546p:plain

今回は管理者ガイド(Administration Guide)を解読していく。

実際のRocket.Chat上では管理者タブの「設定」に当たる部分の説明と理解している。 公式サイトでの場所は以下

Administrator Guides - Rocket.Chat Docs

てっきりドキュメントのサイト内でajaxか何かによって表示を切り替えて要るのかと思ったが、どうやらURLからして違うらしい。

項目一覧と今回の方針

まずどんな項目があるのかを見ていこう。。あまりにも多い。
今回はGeneralの中だけを見ていきます。

では見ていきましょう。

General

「設定」配下の「全般(英語だとGeneral)」の内部についての説明。 一般設定についての話らしい。この中だけでもかなりの内容がある。。。 以下がアクセス先
General - Rocket.Chat Docs

Generals

Generalの中は大きく分けて Generals Apps GraphQL API Iframe Integration Notifications REST API Reporting Stream Cast Translations UTF8 Updatte に分かれるが、この中のGeneralsについて解読する。

  • Allow Invalid Self-Signed Certs/無効な自己署名証明書を許可する
    無効な証明書の許可設定。オレオレ証明書が利用できるようになる。

  • Bugsnag API Key
    どうやらBugsnagという外部サービスがあるらしく、それを利用するためのAPIキーを設定できるらしい。 Bugsnagというのはエラーイベントを取得するためのサービスのようだ。
    使わない人にとってはそこまで重要な機能ではない。

qiita.com

  • CDN Prefix for JS/CSS
    Rocket.Chatでcssやjavascriptを加えてデザイン変更や機能追加を行うことはよくあることだと思います。
    その際に使用するフレームワークのCDNを設定できるようです。

  • CDN Prefix
    上記とあまり変わらないが、一般公開されているCDNではなく自サーバーのCDNを用いる時はこちらを指定するらしい。

  • Use CDN Prefix for all assets
    よくわからなかった。わかり次第書きます。

  • nable Favorite Rooms
    これをYesにしておくとRocket.Chatのチャネルに対してお気に入り機能を使えるようになる。

  • First Channel After Login
    Rocket.Chatにログインした場合、通常はホーム画面に飛ばされます。 この設定をして置くことでログイン後に直で設定しておいたチャネルを表示することができます。

  • Force Disable OpLog for Cache（Todo）
    昔はなかったがRocket.ChatではOpLogというものを使うらしくそのときに必要。よくわからん。

  • Force SSL
    httpsによる接続を強制できるらしいが、強く非推奨とのこと（なら出すなよ。。） リバプロとして使用する必要があるとか？

  • Google Tag Manager Id
    Google Tag Managerを使用するためのIDを設定するらしい。

  • Language/言語
    言語設定。私が入れた環境では「default」担っていたが、表示はきっちり日本語になっていた。

  • Restart/サーバーを再起動 サーバーを再起動するためのボタン。設定画面に置くものかどうかは疑問に思った。

  • Robots.txt File Content/Robots.txtファイルの内容
    Robots.txtファイルに書いておく内容をここに記述する。

  • Show Setup Wizard/セットアップウィザードを表示する
    なんのための設定かよくわからな買った。

  • Site Name/サイト名
    サイト名入れます

  • Site Name/サイトURL
    サイトURLを入れます

  • Store Last Message/最後のメッセージを保存する
    かくルームで最後のメッセージを保存するかどうかの設定

  • Unread Counter/未読数
    Rocket.Chatはサイドバーに未読数を表示することができ、未読としてカウントするメッセージ数を設定することができる。

  • Unread Count for Direct Messages/ダイレクトメッセージの未読数
    ダイレクトメッセージについての未読数も上と同様に、対象を設定できる。
    設定項目は以下

① 全てのメッセージ 全てのメッセージにおいて未読数を表示する。 ② メンションのみ メンションされていないメッセージ時のみをや未読数としてカウントする。

Apps/アプリ
  • Enable the App Framework/Appフレームワークを有効にする(おそらく) Rocket.Chatのフレームワークを有効にするかどうかの設定などがある。画面上はアプリ配下。
    なお、これ以外の開発者モードやゲームセンターについては言及されていなかった。
GraphQL API

それらしい機能は存在しなかった。 3.2だとまだない？

Iframe Integration/Iframeの統合
  • Enable Receive/受信を有効にする
    親ウィンドウからRocket.Chatにコマンドを送信することができるようにする機能らしいが正直よくわからない。

  • Enable Send/送信を有効にする
    受信とは微妙に違うのか？親ウィンドウにイベントを送信できるようになる。

  • Receive Origins/起源を受信する
    よくわからない。

  • Send Target Origin/ターゲット送信元を送信
    これもよくわからない。

Notifications/通知

  • Max Room Members Before Disabling All Message Notifications/すべてのメッセージ通知を無効にする前の最大ルームメンバー
    和訳がよくわからなかった。
    　
    要するに全てのメッセージについて通知を飛ばす設定をしているとルームメンバーが増えると大変なことになる。
    　
    そこで全てのメッセージに対する通知を無効にするための上限値を決めておこうということかな。
    必要に応じてトークルームの設定でも変えられるらしい。
    　
    以下和訳
    すべてのメッセージの通知が無効になったときのルームの最大メンバー数。ユーザーは引き続き部屋ごとの設定を変更して、すべての通知を個別に受信できます。 （無効にする場合は0）

  • Always notify mobile 3.2では存在しなかった。
    常にモバイル版のRocket.Chatに通知を飛ばすための設定らしい。

REST API

Generalsの次に巨大なブロック
それもそのはずREST APIについての設定です。

  • Allow Getting Eberything/全てを取得することを許可する おそらくだがREST APIを実行した時に返されるデータ数を制限するための設定
    「はい」：全てのデータが帰ってくる
    「いいえ」：返されるデータの上限数を設定することができる 　
    3.3から設定が変わったのか、3.2の現状では以下のようになっている f:id:MahiroN:20200615171825p:plain

  • CORS Origin CORSというのはajaxなどのセキュリティ設定で、読み込めるドメインを設定するものだったと思います。
    悪意のあるサイトに対してリクエストを送ってしまうことを防ぐために、許可するドメインだけを「オリジン」として設定するとかだったと思います。
    　CORSまとめ
    　なんとなく CORS がわかる...はもう終わりにする。
    　
    Rocekt.Chat3.2では以下のようになっている。この欄にオリジンとして使用可能なドメインを設定します。 f:id:MahiroN:20200615172523p:plain

  • Default Count/デフォルト数 何も指定しなかった場合にデフォルトでREST APIが返してくるデータ数の設定。
    画像については上記の「Allow Getting Eberything」の箇所を参照あれ。

  • Enable CORS/CORSを有効にする ここを設定しておくと上記で紹介したCORS Originに知っていしたドメイン

  • Enable Direct Message History Endpoint/ダイレクトメッセージ履歴エンドポイントを有効にする よくわからないが他のユーザーからのダイレクトメッセージも取得できるようになるらしい。
    /api/v1/im.history.others

  • Enable Shields/シールドを有効にする シールドを有効にする設定らしいがよくわからない。

  • Shields Type/シールドを有効にする 使用するシールドをここに描くらしい

f:id:MahiroN:20200615180303p:plain

  • Max Record Amount/最大レコード数 設定しない場合にREST APIが返してくる最大レコード数。

  • User Limit for Adding All Users to Channel/Channelに全ユーザーを追加するためのユーザー制限 チャネルに同時に追加できるユーザー数の上限を決めるための機能なようです。

  • Meteor呼び出しにWebSocketではなくRESTを使用する Rocket.Chat3.2の画面には実験的な機能として存在したが、ドキュメントにはなかったから消えちゃったのかな？ f:id:MahiroN:20200615182728p:plain

Reporting/報告
  • Send Statistics to Rocket.Chat/Rocket.Chatに統計情報を送信します 統計情報をRocket.Chatに送るための設定を行います。
Stream Cast/ストリームキャスト
  • Stream Cast Address/ストリームキャストアドレス ストリームキャストを行うためのホストのアドレスをここに記載します。
Translation/翻訳
  • Custom Tlansration/カスタム翻訳 翻訳というよりユーザー辞書。json形式で記入する
{
 "en": {
  "Channels": "Rooms"
 },
 "ja": {
  "Channels": "部屋"
 }
}
UTF8

文字コードの設定かと思ったがよくわからなかった。 f:id:MahiroN:20200615184205p:plain

Update/更新

最新バージョンに更新するかの設定のようだが、編集できなかった。

Generalに関しては以上！！

© 2020 幻魔ナイトの色々日記 All rights reserved.

お問合わせはこちら