一般ランナー
準備
クイックスタート
1. 一般ランナーのデプロイ
Apidogホームページに移動し、希望のチームを選択し、右側のリソースをクリックします。そこから一般ランナーをデプロイをクリックして開始します。2. ランナーデプロイコマンドの取得
一般ランナーをデプロイをクリックすると、ポップアップウィンドウから一般ランナーのデプロイコマンドをコピーできます。必要に応じてコマンドをカスタマイズでき、サーバーOS、公開ポート、マウントデータディレクトリなどをカスタマイズできます。以下はこれらの設定の詳細な説明です：General、Slim、Custom。もし「カスタムスクリプト」が外部プログラムを呼び出す必要がある場合、必要な環境に基づいて適切なイメージを選択してインストールします：-pパラメータを使用して、コンテナの内部ポートをホストマシンのポートにマッピングし、コンテナが提供するサービスに外部からアクセスできるようにします。例えば、-p 80:4524はコンテナの内部ポート4524をホストマシンのポート80にマッピングします。-vパラメータを使用して、ホストマシンのディレクトリをコンテナにマウントし、コンテナがホスト上のファイルにアクセスして操作できるようにします（例：データベース設定や外部プログラム）。例えば、-v "/opt/runner":/opt/runnerはホストの/opt/runnerディレクトリをコンテナの/opt/runnerディレクトリにマウントします。TIP
一般ランナーをデプロイをクリックするたびに新しいコマンドが生成されます。3. サーバー上にランナーをデプロイ
TIP
4. サーバー上のランナーステータスを確認
docker psコマンドを使用して、コンテナの実行ステータスを確認することもできます。
5. Apidogでデプロイされた一般ランナーを確認
サーバー上で一般ランナーが正常にデプロイされているが、Apidogクライアントに表示されない場合は、「一般ランナー」の右側にある更新ボタンをクリックしてページを更新し、再度確認してください。
| ステータス | 説明 |
|---|---|
| 開始済み | サーバー上のコンテナ内でランナーが正常に有効化され、Apidogとの通信を維持し、Apidogから発行された関連タスクを処理できます。 |
| 停止済み | ランナーがApidogで手動で停止されましたが、サーバー上のコンテナ内では正常に実行され、通信を維持しています。Apidogから発行されたタスクを処理せず、新しいタスクは停止されたランナーを指定して実行できません。Apidogで手動で有効化することで、ランナーを開始済みの状態に戻すことができます。 |
| オフライン | ランナーがApidogから切断され、タスクを処理できません。これは、サーバー上のランナーコンテナが停止しているか、サーバーとApidog間の通信に問題があるためです。ランナーを復元するには、ランナーコンテナが実行中であり、Apidogとの通信に問題がないことを確認し、ランナーを開始済みの状態に戻します。 |
ランナー内でのファイル保存
| 使用内容 | 指定ディレクトリパス（またはファイル名） | 例 Dockerコマンド |
|---|---|---|
| 他のプログラミング言語 | /app/external-programs/ | -v /Users/xxx/runner/packages/api-test/external-programs:/app/externalPrograms |
| データベース(/jp/database%E3%83%87%E3%83%BC%E3%82%BF%E3%83%99%E3%83%BC%E3%82%B9-646353m0) 接続設定ファイル | /app/database/database-connections.json | -v /Users/xxx/runner/packages/api-test/database/database-connections.json:/app/database/database-connections.json |
| SSL証明書 リストファイル | /app/ssl/ssl-client-cert-list.json | -v /Users/xxx/runner/packages/api-test/ssl/ssl-client-cert-list.json:/app/ssl/ssl-client-cert-list.json |
{
"19731": {
"configs": {
"default": {
"username": "accountname",
"password": "123456",
"host": "192.168.0.0"
}
},
"id": 19731,
"name": "データベース名",
"type": "mysql",
"projectId": 1320441,
"description": "ダミーデータ。",
"createdAt": "2022-09-27T07:51:09.000Z",
"updatedAt": "2024-05-09T11:38:07.000Z",
"deletedAt": null
}
}Apidogクライアントから設定ファイルをエクスポートする方法はこちらを参照してください。
[
{
"name": "domain1",
"matches": ["https://test.domain1.com/*", "https://www.domain1/*"],
"key": {"src": "./client.domain1.key"},
"cert": {"src": "./client.domain1.crt"},
"passphrase": "changeme"
},
{
"name": "domain2",
"matches": ["https://domain2.com/*"],
"key": {"src": "./client.domain2.key"},
"cert": {"src": "./client.domain2.crt"},
"passphrase": "changeme"
}
]ランナーのアップグレードと再デプロイ
ランナーのアップグレード
ランナーの再デプロイ
再デプロイをクリックします。Q&A
docker psコマンドを使用して問題のあるランナーを特定します。teamId変数のIDデータエラー： これは既知のバグで、最新バージョンで修正されています。問題が続く場合は：