エージェントのインストールを構成する

ビルドエージェントは、<TeamCity Agent Home>/conf/buildAgent.properties ファイルで調整することで構成できます。

一般的なエージェント設定

この Java プロパティ(英語)構成ファイルには、エージェントプロパティとしてサーバーに公開され、エージェント要件式に参加できるプロパティを保存できます。ファイルで定義されているすべてのシステムプロパティと環境プロパティは、エージェントで実行されるすべてのビルドに渡されます。

構文リファレンス:

property_name=value<newline> 構文を使用します。
コメントには、行の最初の位置に # を使用します。
パス区切り文字として、\ の代わりに / を使用します。\ を含める必要がある場合は、別の \ でエスケープします。
空白は他のシンボルと同じように処理されます。

エージェント構成ファイルの例:

## The address of the TeamCity server. The same as is used to open the TeamCity web interface in the browser.
## Must include the protocol specification (https:// is recommended).
serverUrl=http://localhost:8111/

## The unique name of the agent used to identify this agent on the TeamCity server
## Use blank name to let server generate it.
## By default, this name would be created from the build agent's host name
name=Default agent

## Container directory to create default checkout directories for the build configurations.
workDir=../work

## Container directory for the temporary directories.
## Please note that the directory may be cleaned between the builds.
tempDir=../temp
 
## Container directory for agent state files and caches.
## TeamCity agent assumes ownership of the directory and can delete the content inside.
systemDir=../system

 
######################################
#   Optional Agent Properties        #
######################################
## A token which is used to identify this agent on the TeamCity server for agent authorization purposes.
## It is automatically generated and saved back on the first agent connection to the server.
authorizationToken=1234567890abcdefghijklml

ファイルがビルドエージェントプロセス自体に対して書き込み可能であることを確認してください。例: サーバー側で生成された認証トークンを保存するようにファイルが更新されること。

リバースプロキシの背後に複数の TeamCity ノードをインストールする場合は、serverUrl をプロキシ URL に設定する必要があります。

name プロパティが指定されていないと、サーバーは自動的にビルドエージェント名を生成します。デフォルトでは、この名前はビルドエージェントのホスト名から作成されます。

ファイルは、エージェントの実行中に編集できます。エージェントは変更を検出し、（実行中のビルドが終了した場合は）自動的に新しい設定の読み込みを再開します。

オプションプロパティ

エージェントポートの構築

TeamCity エージェントは単方向モードで動作します。つまり、サーバーへの接続はすべてエージェント側から開始され、その逆は行われません。接続後は、エージェントは定期的にサーバーをポーリングし、キュー内のビルド処理などの新しいコマンドの有無を確認します。サーバー側からの接続は行われないため、エージェントマシンの設定時にポートの開放設定は必要ありません。

ごくまれに、エージェントが同じマシン上で実行されている他のビルド関連プロセスとデータを共有するプロセスを実行することがあります。これは主に、古いビルドステップやプラグインの実行に当てはまります。このような場合、エージェントはローカルホストのポート 9090 を使用してデータを共有します。このポートは buildAgent.properties ファイルで再定義できます。

ownPort=9090

このポートはローカルホスト上でのみ開かれているため、外部からの受信接続には使用できません。

代替フェッチ URL

特定のエージェントに対して、元の Git リポジトリよりも大幅に近い自己更新 Git リポジトリプロキシがある場合は、これらのエージェントがこのミラーからソースをダウンロードできるようにすることができます。これを行うには、エージェント構成ファイルに teamcity.git.fetchUrlMapping.<name>=<original URL> => <proxy URL> 設定を追加します。詳細については、このセクションを参照してください: Git VCS ルート | 一般設定。

構成コマンド

buildAgent.properties ファイルを設定するには、configure コマンドを使用して <Agent_folder>/bin/agent.bat または <Agent_folder>/bin/agent.sh スクリプトを実行します。このコマンドを使用すると、コアエージェントのプロパティを設定し、それをターゲット構成ファイルに保存できます。構成ファイルのパスが指定されていない場合、変更はデフォルトの <Agent_folder>/conf/buildAgent.properties プロパティに保存されます。

使用可能なパラメーターのリストを表示するには、--help フラグを指定してこのコマンドを実行します。

./agent.sh configure --help
Java executable is found: '/Library/Java/JavaVirtualMachines/amazon-corretto-11.jdk/Contents/Home/bin/java'
Configuring TeamCity build agent...
TeamCity Agent configurator
Usage: 
	configure PROPERTIES_FILE
	configure -f PROPERTIES_FILE
	configure [PROPERTIES]
	configure --usage
	status
	status short
Where PROPERTIES format is --key=value or --key value
Supported properties:
	* --agent-config-file=PATH - path to build agent properties file (<Agent Root>/conf/buildAgent.properties by default)
	* All default properties that can be configured in buildAgent.properties file
	  Also there are aliases for some of them:
		auth-token = authorizationToken
		logs-dir = logsDir
		name = name
		server-url = serverUrl
		system-dir = systemDir
		temp-dir = tempDir
		work-dir = workDir

サーバーの URL を書き込み、カスタムエージェント名を設定するサンプルコマンド:

./agent.sh configure --server-url http://localhost:8111/ --name AG2

プロキシの背後にエージェントを設定する

エージェントからサーバーへの接続用にフォワードプロキシサーバーを構成することができます。

TeamCity エージェント側で、 buildAgent.properties ファイルの次のプロパティを使用して TeamCity サーバーに接続するプロキシを指定します。

## The domain name or the IP address of the proxy host and the port
teamcity.http.proxyHost=123.45.678.9
teamcity.http.proxyPort=8080
 
## If the proxy requires authentication, specify the login and password
teamcity.http.proxyLogin=login
teamcity.http.proxyPassword=password

HTTPS エンドポイント (GitHub でホストされるリポジトリなど) にアクセスするには、teamcity.https.* プロパティも構成します。

2025 年 11 月 02 日

関連ページ：

エージェント要件の設定

エージェントの要件は、ビルド構成を実行できるエージェントを指定する条件です。現在存在するすべての要件を表示して新しい要件を作成し、特定の構成を実行できるエージェントを確認するには、ビルド設定 | エージェント要件にアクセスしてください。エージェント要件ビデオガイド：要件構文：エージェント要件は式です。ここは、定義済みまたはカスタム (ユーザー定義) のビルドパラメーターです。例: エージェントにインストールされているオペレーティングシステムを報告するパラメーター。要件では、エージェントがこの特...

事前定義されたビルドパラメーターのリスト

TeamCity には、ビルド構成の設定やビルドスクリプトですぐに使用できる定義済みのビルドパラメーターが数十個用意されています。これらのパラメーターはすべて（事前定義された構成パラメーターを除く）ビルドプロセスに渡されます。これらのパラメーターにアクセスするために必要な手法は、ビルド型によって異なる場合があることに注意してください（たとえば、Gradle ビルドで TeamCity システムプロパティにアクセスする方法については、ビルドプロパティセクションを参照してください）。事前定義されたサ...

高可用性のためのマルチノードセットアップ

TeamCity サーバーは、高可用性と柔軟な負荷分散のために複数のノード (またはサーバー) を使用するように構成できます。TeamCity ノードのクラスターをセットアップすることが可能です。各ノードは、ビルドからのデータの処理や VCS リポジトリからの変更の収集など、さまざまなタスクを担当します。または、すべての作業を行うメインノードを 1 つと、読み取り専用インターフェースを提供するセカンダリノードを 1 つ保持します。メインノードがダウンした場合、最小限のダウンタイムですべてのデータ...

Git

TeamCity は、Git をすぐにサポートします。Azure DevOps Services を使用した Git ソース管理がサポートされています (以下の認証に関する注意事項を参照)。このページには、VCS ルート設定の Git 固有のフィールドの説明が含まれています。一般的な VCS ルートプロパティについては、このセクションを参照してください。注意事項: リモート実行とテスト済みのコミットは IntelliJ IDEA プラグインでサポートされています。Visual Studio アドインで...

アーティファクトストレージの構成

プロジェクト設定 | アーティファクトストレージタブには、このプロジェクトで構成されたアーティファクトストレージと、親から継承されたストレージが表示されます。デフォルトでは、組み込み TeamCity アーティファクトストレージが表示され、アクティブとしてマークされています。対応するリンクを使用して別のストレージを有効化することができます。組み込みアーティファクトストレージ：TeamCity は、ビルドによって生成されたアーティファクトを、TeamCity サーバーがアクセスできるファイルシステ...

Amazon S3 および S3 互換ストレージ

TeamCity には、Amazon S3 Artifact Storage プラグインがバンドルされており、これにより、ビルドアーティファクトを Amazon S3 バケットや MinIO、バックブレイズ B2 などの S3 互換バケットに保存できます。S3 互換ストレージは、AWS 環境と AWS 以外の環境の両方でホストできます。新しい AWS S3 ストレージを作成してセットアップする：「管理 | <あなたのプロジェクト>」ページに移動し、「アーティファクトストレージ」タブに切...