OSK の部室の様子をオンラインで確認できるプロジェクト 部室ちゃん その部室に置いてある PC で動かすプログラム
bushitsuchan-PC は単一の Ubuntu PC 上で動作します。 限られた特定の人に，WEB site と Slack を介して部室の動画,画像または物体検出結果を表示します。
bushitsuchan-PC ではDockerというソフトフェアを活用しています。
Docker はコンテナ技術を体現したシステムの一つで，独立したサービス単位で環境それぞれを Container という形で OS レベルに分離させることができます。必要最低な構成を独立して扱うため再利用性が高まり，また分離しているため取り回しも良くなります。
各 Container の説明はここに置かれています。
bushitsuchan-PC 全体のフローはSequence 図で確認できます。
bushitsuchan-PC を動作させるための設定を各部分ごとに説明します。
環境変数は独立したアプリケーション間で共通の値を参照できる値を設定するもので，通常は不変な ID やパスワードをセットしておきます。
最終的に.envファイルに以下の様に書き保存してください。
各変数へと何をセットすれば良いのかはこれから説明します。
AWS_REST_API_ID=j3i... # 二回目以降に必要
AWS_ACCESS_KEY_ID=FUB...
AWS_SECRET_ACCESS_KEY=vKw...
NGROK_AUTH=8HU...
SESSION_SECRET=presetprivatekey # 暗に暗号化へ使う任意の頑強な文字列
SLACK_CLIENT_ID=179...
SLACK_CLIENT_SECRET=38b...
WORKSTATION_ID=I6B...
SLACK_BOT_ACCESS_TOKEN=xoxb-3814...
SLACK_SIGNING_SECRET=fb36...
CONTACT_CHANNEL=BN3...
NOTIFICATION_CHANNEL=O6C...
ファイルを作成せずに direnvなどで環境変数にセットしても動作します
特定のネットワーク下では，権限なしにウェブサーバーを外部に公開することはできません。
その状況下でも外部に暴露させることができるサービスの 1 つに ngrok があります。
ngrok はユーザー登録をしていると使い勝手が良くなるので， bushitsuchan-PC ではユーザ登録後に有効な機能を使っています。
このとき，ユーザーごとに割り振られたキーが必要です。
ngrokに登録して，Tunnel Authtoken を取得します。
それを前述したように環境変数NGROK_AUTHにセットしてください。
ngrok 外部に公開したサイトへの URL は変動するので，API Gatewayを用いて固定された URL を ngrok の URL へリダイレクトします。
API Gateway を利用するためには AWS アカウントと AWS へアクセスするキーが必要です。
新たにユーザー作成し，アクセスキー IDとシークレットアクセスキーを作成してください。
それをを前述したように環境変数AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEYにセットしてください。
そのユーザーにはポリシーAmazonAPIGatewayAdministratorをアクセス権にアタッチしてください。
二回目以降の起動時は環境変数にAWS_REST_API_IDをセットする必要があります。この値はUsage remoteにかかれている方法で確認できます。
Slack と連携し特定の Workspace に属する場合のみ LIVE Streaming 視聴を許可するように設定します。
その際，Slack App という枠組みを利用しています。新たに Slack App を作成し，それに対応するいくつかの ID やキーが必要です。
また，Slash Commands やメッセージへのアクションを受け取るために追加でSlack 追加設定に従う必要があります。
まずSign in with Slack に従い Slack App を作成してください。
Bot User メニューにて Redirect URLs は
https://[RESOURCE_ID].execute-api.[REGION].amazonaws.com/prod/oauth-redirectのみに設定し，
Scopes にidentity.basicを追加してください。
作成した Slack App から以下の環境変数を設定してください。
どの部分から得るのかの対応を書いておきます。
SLACK_CLIENT_ID: Basic Information > App Credentials > Client IDSLACK_CLIENT_SECRET: Basic Information > App Credentials > Signing Client SecretSLACK_BOT_ACCESS_TOKEN: OAuth & Permissions > Tokens for Your Workspace > Bot User OAuth Access TokenSLACK_SIGNING_SECRET: Basic Information > App Credentials > Signing Secret
bushitsuchan-PC では slack で特定のワークスペースに属する場合のみ配信等を提供します。
そのワークスペースに属するかどうかの判定に，ワークスペース固有の ID が必要です。
まず，そのワークスペースのサイトをブラウザで開きます。
URL がhttps://app.slack.com/client/VYS39C27C/UC7CHE35Jのようになっているはずです。
この URL のVYS39C27C部分が必要な ID です。
これを前述したように環境変数WORKSTATION_IDにセットしてください。
- Docker compose
- Camera
docker-compose -f docker-compose.prod.yml up -d
http://localhost/viewerを開いてください。
docker-compose -f docker-compose.prod.yml logs tunnelを実行すると表示される log の中に
Forwarding https://[AWS_REST_API_ID].execute-api.[AWS_REGION].amazonaws.com/prod -> https://[NGROK_DOMAIN].jp.ngrok.io
とあります。1 つ目の URL に/viewerを付け加えたhttps://[AWS_REST_API_ID].execute-api.[AWS_REGION].amazonaws.com/prod/viewerを開いてください。
この URL は半永久的に変わりません
すると，初回実行時(過去に Slack で認証をしていなければ) Slack の認証ページへリダイレクトされます。
Sign in すると自動的に配信再生ページへ移動します。
設定した Workspace 内で/bushitsu-photoコマンドを任意の場所で送信すると，現在の現在の部室の様子が投稿されます。
また，環境変数NOTIFICATION_CHANNELにセットしたチャンネルに部室を物体検出した結果が随時投稿されます。
ここに詳細が記されています。
以下の OS をサポートします。
- Ubuntu 18.04
- macOS 10.14 (Debug mode のみ)
Debug mode 下では挙動に以下の差異があります。
- ストリーミング映像がカメラからではなく任意の動画ファイルから取得される
- Time zone の設定がされず時刻がずれる