agenda admin

アジェンダ管理者

アジェンダのダッシュボード

---

特徴

• ジョブのステータス、更新間隔はデフォルトで 15 秒です
• オートコンプリートを含む名前で求人を検索する
• メタデータとステータスによるジョブのフィルタリング
• ジョブの詳細を表示する
• ジョブの削除と再キューイング
• 新しいジョブをスケジュールする

---

前提条件

MongoDB の必要なバージョン: >2.6.0

---

ミドルウェアの使用状況

Agenda Admin は、 mountAgendaAdmin関数を使用してエクスプレス ミドルウェアとして使用できます。引数として、次のフィールドを持つオブジェクトを受け取ります。

• publicUrl - フロントエンドが提供される URL
• mountPath - ミドルウェアをマウントするパス ( app.use()に渡されます)
• expressApp - エクスプレス アプリ
• agenda - アジェンダインスタンス
• options - オプションの引数。オブジェクトは次のプロパティを持つことができます。
  • itemsPerPage
  • username
  • password

例：

 const express = require('express');
const Agenda = require('agenda');
const { mountAgendaAdmin } = require('agenda-admin');

const app = express();

// Other express middleware

const agenda = new Agenda({ db: { address: 'mongodb://127.0.0.1/agendaDb' } });

mountAgendaAdmin({
  publicUrl: 'http://localhost:7878/agenda-admin',
  mountPath: '/',
  expressApp: app,
  agenda
});

app.listen(7878);

---

Docker の使用法

Docker コンテナはポート 7878 を公開します

現時点では、AgendaAdmin はポートの再マッピングをサポートしていないため、コンテナはポート 7878 にのみ接続する必要があります。

 docker run -p 7878:7878 
--env CONNECTION_STRING=mongo://username:password@host/database 
--env COLLECTION=collection lexissolutions/agenda-admin:latest

Docker環境の構成

名前	説明	必須	デフォルト値
接続文字列	MongoDB 接続文字列	はい
コレクション	MongoDB のジョブのコレクション	いいえ	議題仕事
ITEMS_PER_PAGE	ページあたりのジョブ数	いいえ	20
AGENDA_USERNAME	認証に使用されるユーザー名 (パスワードが指定された場合のみ)	いいえ	管理者
アジェンダ_パスワード	パスワードが指定されていない場合、認証は必要ありません	いいえ

---

貢献する

依存関係をインストールする

yarn install

ランニング

apiディレクトリ内にCONNECTION_STRING変数とCOLLECTION変数を含む.env.developmentファイルを作成し、 yarn devを実行します。
apiディレクトリとclientディレクトリでyarn start実行することもできます。

テストの実行

apiディレクトリ内にCONNECTION_STRING変数とCOLLECTION変数を含む.env.testingファイルを作成し、 yarn testを実行します。

メッセージをコミットする

Agenda Admin は従来のコミット形式を使用します。