リファレンス

Updated 2 years ago by Admin

サーバ構成設定のインデックス：

  • DRONE_BITBUCKET_CLIENT_ID
    文字列値。 Bitbucket OAuthクライアントIDを構成します。これは、Droneユーザーに代わってBitbucketへのアクセスを承認するために使用されます。
    DRONE_BITBUCKET_CLIENT_ID=05136e57d80189bef462
  • DRONE_BITBUCKET_CLIENT_SECRET
    文字列値。 Bitbucket OAuthクライアントシークレットを構成します。これは、Droneユーザーに代わってBitbucketへのアクセスを承認するために使用されます。
    DRONE_BITBUCKET_CLIENT_SECRET=7c229228a77d2cbddaa61ddc78d45e
  • DRONE_BITBUCKET_DEBUG
    オプションのブール値。Bitbucket認証が提供する詳細なトレースログを設定します。これは、Droneサーバをインストールする際のログインに関する問題のトラブルシューティングに使用する必要があります。
    DRONE_BITBUCKET_DEBUG=false
  • DRONE_CLEANUP_DEADLINE_PENDING
    オプションオプションの期間値。保留中のジョブがリーパによって強制終了されるまでの間隔を構成します。デフォルト値は24時間です。
    24時間以上経過した保留中のジョブを強制終了します：値。Bitbucket認証が提供する詳細なトレースログを設定します。これは、Droneサーバをインストールする際のログインに関する問題のトラブルシューティングに使用する必要があります。
    DRONE_CLEANUP_DEADLINE_PENDING=24h
  • DRONE_CLEANUP_DEADLINE_RUNNING
    オプションの期間値。実行中のジョブがリーパによって強制終了されるまでの間隔を構成します。デフォルト値は24時間です。
    24時間以上経過した実行中のジョブを強制終了します。
    DRONE_CLEANUP_DEADLINE_RUNNING=24h
  • DRONE_CLEANUP_DISABLED
    ブール値はリーパを無効にします。リーパは、保留状態または実行状態で永続的にスタックしているゾンビジョブを見つけて強制終了します。デフォルト値はfalseです。
    DRONE_CLEANUP_DISABLED=true
     DRONE_CLEANUP_DISABLED=false
  • DRONE_CLEANUP_INTERVAL
    オプションの期間値。リーパが実行される間隔を構成します。リーパは、デフォルトで24時間ごとに、保留状態または実行状態で永続的にスタックしているゾンビジョブを見つけて強制終了します。
    24時間ごとにリーパを実行します。
    DRONE_CLEANUP_INTERVAL=24h
    1時間ごとにリーパを実行します。
    DRONE_CLEANUP_INTERVAL=60m
  • DRONE_CONVERT_PLUGIN_ENDPOINT
    文字列値は、構成ファイルを自動的に変換または変更するために使用される、変換プラグインのエンドポイントを構成します。
    DRONE_CONVERT_PLUGIN_ENDPOINT=http://hostname.com:3000
  • DRONE_CONVERT_PLUGIN_EXTENSION
    文字列値は、変換プラグインで使用する必要があるファイル拡張子を構成します。この構成パラメータは、他の方法では変換されないファイルタイプの変換プラグインへの不要なトラフィックを減らすために使用されます。それは完全にオプションです。
    DRONE_CONVERT_PLUGIN_EXTENSION=.star
  • DRONE_CONVERT_PLUGIN_SECRET
    http署名の作成に使用される共有シークレット。変換プラグインは、共有シークレットを使用してリクエストの信頼性を検証します。
    DRONE_CONVERT_PLUGIN_SECRET=correct-horse-battery-staple
  • DRONE_CONVERT_PLUGIN_SKIP_VERIFY
    ブール値は、リモート変換プラグインへの接続を確立するときにTLS検証を無効にします。デフォルト値はfalseです。
    DRONE_CONVERT_PLUGIN_SKIP_VERIFY=false
  • オプションの文字列値。認証Cookieの署名に使用されるシークレットキーを構成します。設定されていない場合、サーバが起動するたびにランダムな値が生成されます。
    DRONE_COOKIE_SECRET=correct-horse-battery-staple
  • オプションの期間値。認証Cookieの有効期限を設定します。この値はオプションであり、デフォルト値は72時間です。
    DRONE_COOKIE_TIMEOUT=72h

  • DRONE_CRON_DISABLED
    ブール値はcronスケジューラを無効にします。デフォルト値はfalseです。
    DRONE_CRON_DISABLED=false
  • DRONE_CRON_INTERVAL
    オプションの期間値。cronスケジューラが実行される間隔を設定します。cronスケジューラは正確であるようには意図されておらず、デフォルトでは1時間ごとに保留中のジョブをバッチ処理します。
    保留中のcronジョブを1時間ごとに処理します。
    DRONE_CRON_INTERVAL=1h
    保留中のcronジョブを5分ごとに処理します。
    DRONE_CRON_INTERVAL=5m
    cron間隔を短くしても、高レベルの精度は期待できないことに注意してください。私たちの主な設計目標は、ユーザーがシステムに過負荷をかけるのを防ぐ、安全で効率的なcronスケジューラーを作成することでした。これには精度が犠牲になります。

  • DRONE_DATABASE_DATASOURCE
    オプションの文字列値。データベース接続文字列を構成します。デフォルト値は、埋め込まれたsqliteデータベースファイルのパスです。
    DRONE_DATABASE_DATASOURCE=/data/database.sqlite
    mysql接続文字列の例（以下）。接続文字列の詳細については、公式のドライバドキュメントを参照してください。
    DRONE_DATABASE_DATASOURCE=root:password@tcp(1.2.3.4:3306)/drone?parseTime=true
    postgres接続文字列の例（以下）。接続文字列の詳細については、公式のドライバドキュメントを参照してください。
    DRONE_DATABASE_DATASOURCE=postgres://root:password@1.2.3.4:5432/postgres?sslmode=disable
  • DRONE_DATABASE_DRIVER
    オプションの文字列値。データベースドライバ名を設定します。デフォルト値はsqlite3ドライバです。代替ドライバはpostgresとmysqlです。
    DRONE_DATABASE_DRIVER=mysql
     DRONE_DATABASE_DRIVER=postgres
     DRONE_DATABASE_DRIVER=sqlite3
  • DRONE_DATABASE_SECRET
    オプションの文字列値。データベース内のシークレットを暗号化するために使用されるシークレットキーを構成します。暗号化はデフォルトで無効になっているため、システムを最初に使用する前に構成する必要があります。
    DRONE_DATABASE_SECRET=7c229228a77d2cbddaa61ddc78d45e
  • DRONE_GIT_ALWAYS_AUTH
    オプションのブール値。パブリックリポジトリのクローンを作成するときに認証するようにドローンを構成します。これは、ソースコード管理システム（GitHub Enterpriseなど）でプライベートモードが有効になっている場合にのみ必要です。
    DRONE_GIT_ALWAYS_AUTH=false
  • DRONE_GIT_PASSWORD
    オプションの文字列値。プライベートリポジトリの認証とクローン作成に使用されるデフォルトのgitユーザー名とパスワードを上書きします。
    DRONE_GIT_USERNAME=x-oauth-token
     DRONE_GIT_PASSWORD=7c229228a77d2cbddaa61ddc78d45e
  • DRONE_GIT_USERNAME
    オプションの文字列値。プライベートリポジトリの認証とクローン作成に使用されるデフォルトのgitユーザー名とパスワードを上書きします。
    DRONE_GIT_USERNAME=x-oauth-token
     DRONE_GIT_PASSWORD=7c229228a77d2cbddaa61ddc78d45e
  • DRONE_GITEA_CLIENT_ID
    文字列値は、Gitea OAuthクライアントIDを構成します。これは、Droneユーザーに代わってGiteaへのアクセスを承認するために使用されます。
    DRONE_GITEA_CLIENT_ID=05136e57d80189bef462
  • DRONE_GITEA_CLIENT_SECRET
    文字列値は、Gitea OAuthクライアントシークレットを構成します。これは、Droneユーザーに代わってGiteaへのアクセスを承認するために使用されます。
    DRONE_GITEA_CLIENT_SECRET=7c229228a77d2cbddaa61ddc78d45e
  • DRONE_GITEA_SERVER
    文字列値はGiteaサーバアドレスを構成します。
    DRONE_GITEA_SERVER=https://try.gitea.io

  • DRONE_GITEA_SKIP_VERIFY
    ブール値は、リモートGiteaサーバへの接続を確立するときにtls検証を無効にします。デフォルト値はfalseです。
    DRONE_GITEA_SKIP_VERIFY=false
  • DRONE_GITHUB_CLIENT_ID
    文字列値は、GitHub OAuthクライアントIDを構成します。これは、Droneユーザーに代わってGitHubへのアクセスを承認するために使用されます。
    DRONE_GITHUB_CLIENT_ID=05136e57d80189bef462
  • DRONE_GITHUB_CLIENT_SECRET
    文字列値は、GitHub oauthクライアントシークレットを構成します。これは、Droneユーザーに代わってGitHubへのアクセスを承認するために使用されます。
    DRONE_GITHUB_CLIENT_SECRET=7c229228a77d2cbddaa61ddc78d45e
  • DRONE_GITHUB_SCOPE
    文字列値は、OAuthスコープのコンマ区切りのリストを提供します。デフォルト値は変更しないでください。
    DRONE_GITHUB_SCOPE=repo,repo:status,user:email,read:org
  • DRONE_GITHUB_SERVER
    文字列値はGitHubサーバーアドレスを構成します。デフォルト値はhttps://github.comです。
    DRONE_GITHUB_SERVER=https://github.com
  • DRONE_GITHUB_SKIP_VERIFY
    ブール値は、リモートGitHubサーバーへの接続を確立するときにTLS検証を無効にします。デフォルト値はfalseです。
    DRONE_GITHUB_SKIP_VERIFY=false
  • DRONE_GITLAB_CLIENT_ID
    文字列値は、GitLab OAuthクライアントIDを構成します。これは、Droneユーザーに代わってGitLabへのアクセスを承認するために使用されます。
    DRONE_GITLAB_CLIENT_ID=05136e57d80189bef462
  • DRONE_GITLAB_CLIENT_SECRET
    文字列値は、GitLab OAuthクライアントシークレットを構成します。これは、Droneユーザーに代わってGitLabへのアクセスを承認するために使用されます。
    DRONE_GITLAB_CLIENT_SECRET=7c229228a77d2cbddaa61ddc78d45e
  • DRONE_GITLAB_SERVER
    文字列値はGitLabサーバーアドレスを構成します。デフォルト値はhttps://gitlab.comです
    DRONE_GITLAB_SERVER=https://gitlab.com
  • DRONE_GITLAB_SKIP_VERIFY
    ブール値は、リモートGitLabサーバーへの接続を確立するときにTLS検証を無効にします。デフォルト値はfalseです。
    DRONE_GITLAB_SKIP_VERIFY=false
  • DRONE_GOGS_SERVER
    文字列値は、Gogsサーバーアドレスを構成します。
    DRONE_GOGS_SERVER=https://try.gogs.io
  • DRONE_GOGS_SKIP_VERIFY
    ブール値は、リモートGogsサーバーへの接続を確立するときのTLS検証を構成します。デフォルト値はfalseです。
    DRONE_GOGS_SKIP_VERIFY=false
  • DRONE_JSONNET_ENABLED
    ブール値は、.jsonnetで終わる構成ファイルをyamlに自動的に変換するようにDroneを構成します。これはデフォルトで無効になっており、信頼できる環境でのみ有効にする必要があります。
    DRONE_JSONNET_ENABLED=true

  • DRONE_LICENSE
    オプションの文字列値は、Drone Enterpriseライセンスキーのファイルパスを提供します。これは、Droneエンタープライズエディションのロックを解除するために使用されます。
    DRONE_LICENSE=/etc/drone.key
    DockerコンテナでDroneサーバを実行している場合は、ライセンスキーをボリュームとしてマウントする必要があります。
    $ docker run \
      --volume=/path/on/host/drone.key:/etc/drone.key
    docker-composeまたはKubernetesを使用してDroneサーバを実行している場合、またはYamlを使用してDroneを構成している場合は、サーバに環境変数としてライセンスキーを提供できます。
    DRONE_LICENSE: |
      -----BEGIN LICENSE KEY-----
      Thjh7sTA1VDE4OjM2tpmQQZCyRd43M1ODI1OVoiLCJkYXQiSukU/Y
      -----END LICENSE KEY-----
    一般的な問題
    ライセンスエラーの最も一般的な根本原因は、ライセンスキーのマウントに失敗したか、古いまたは期限切れのライセンスキーを提供したことです。デバッグサーバログは、ライセンスの問題のトラブルシューティングに役立つ有用な情報を提供します。
    エラーは、ライセンスファイルが正しくマウントされていないことを示します。
    1 {
    2 "error": "open /tmp/LICENSE.txt: no such file or directory",
    3 "level": "fatal",
    4 "msg": "main: invalid or expired license",
    5 "time": "2020-10-01T12:04:39-04:00"
    6 }
    エラーは、ライセンスファイル自体に問題があることを示します。これは、最新バージョンのDroneサーバ（1.9.2以降）を使用していることを確認するか、新しいライセンスキーを要求することで解決できます。
    1 {
    2 "error": "unexpected end of JSON input",
    3 "level": "fatal",
    4 "msg": "main: invalid or expired license",
    5 "time": "2020-10-29T09:42:19Z"
    6 }
    エラーは、ライセンス環境変数が空であり、適切に構成されていないため、試用ライセンスが発行されていることを示します。試用版のビルド制限を超えた場合、これによりライセンスの期限切れエラーが発生します。
    1 {
    2 "build.limit": 5000,
    3 "expires": "0001-01-01T00:00:00Z",
    4 "kind": "trial",
    5 "level": "debug",
    6 "msg": "main: license loaded",
    7 "repo.limit": 0,
    8 "time": "2020-10-01T12:05:32-04:00",
    9 "user.limit": 0
    10 }
    ライセンスが正常にロードされたことを示すログエントリの例：
    1 {
    2 "build.limit": 0,
    3 "expires": "2020-11-24T23:26:34.67261883Z",
    4 "kind": "standard",
    5 "level": "debug",
    6 "msg": "main: license loaded",
    7 "time": "2019-12-02T10:38:21-08:00",
    8 "user.limit": 50
    9 }
    ユーザー制限を再確認して、期待どおりであることを確認してください。ライセンス超過エラーが引き続き発生する場合は、ガイドに従って、使用量がライセンス制限を超えないようにする必要があります。
  • DRONE_LOGS_COLOR
    ログのカラーフォーマットを有効にします。きれいに印刷されたログと組み合わせて使用されます。この構成パラメータはブール型であり、オプションです。
    DRONE_LOGS_COLOR=true
    DRONE_LOGS_COLOR=false
  • DRONE_LOGS_DEBUG
    デバッグログを有効にします。この構成パラメータはブール型であり、オプションです。
    DRONE_LOGS_DEBUG=true
    DRONE_LOGS_DEBUG=false
  • DRONE_LOGS_PRETTY
    デフォルトのjson形式の代わりに、人間が読める形式のログを有効にします。この構成パラメータはブール型であり、オプションです。
    DRONE_LOGS_PRETTY=true
    DRONE_LOGS_PRETTY=false
  • DRONE_LOGS_TRACE
    トレースログを有効にします。この構成パラメータはブール型であり、オプションです。
    DRONE_LOGS_TRACE=true
    DRONE_LOGS_TRACE=false
  • DRONE_PROMETHEUS_ANONYMOUS_ACCESS
    ブール値は、匿名アクセスを許可するようにPrometheusメトリクスエンドポイントを構成します。これはデフォルトで無効になっており、メトリクスエンドポイントにアクセスするには認証トークンが必要です。
    DRONE_PROMETHEUS_ANONYMOUS_ACCESS=false
  • DRONE_REGISTRATION_CLOSED
    ブール値は、オープン登録を無効にします。有効にした場合、システム管理者は、ユーザーがログインする前にユーザーアカウントを作成する必要があります。
    DRONE_REGISTRATION_CLOSED=false
  • DRONE_REPOSITORY_FILTER
    オプションのコンマ区切りのアカウントリスト。ソース管理管理システムとドローンの間で同期されるリポジトリを制限するために使用されます。この変数は、最初のログインの前に設定する必要があることに注意してください。アカウントを認証して同期した後でこの変数を設定しても、効果はありません。
    DRONE_REPOSITORY_FILTER=octocat,spacheghost
  • DRONE_RPC_SECRET
    必要なリテラル値は、Drone共有シークレットを提供します。これは、サーバへのRPC接続を認証するために使用されます。サーバとランナーには同じシークレット値を指定する必要があります。
    DRONE_RPC_SECRET=correct-horse-batter-staple
  • DRONE_S3_BUCKET
    オプションの文字列値は、S3バケット名を設定します。
    DRONE_S3_BUCKET=my-bucket
  • DRONE_S3_ENDPOINT
    オプションの文字列値は、S3エンドポイントを設定します。これは、MinioなどのS3互換サービスでよく使用されます。
    DRONE_S3_ENDPOINT=https://play.min.io
  • DRONE_S3_PATH_STYLE
    オプションのブール値は、パススタイルを使用するようにS3クライアントを設定します。これは、MinioなどのS3互換サービスでよく使用されます。
    DRONE_S3_PATH_STYLE=false
  • DRONE_S3_PREFIX
    オプションの文字列値は、ログファイルをバケットサブディレクトリに保存するようにS3クライアントを設定します。未設定のログファイルがバケットルートに保存されている場合。
    DRONE_S3_PREFIX=some/path
  • DRONE_SERVER_HOST
    必須の文字列値は、ユーザー向けのホスト名を構成します。この値は、ウェブフックを作成してURLをリダイレクトするために使用されます。トラフィックの処理に実際の影響はありません。
    DRONE_SERVER_HOST=drone.company.com
  • DRONE_SERVER_PROTO
    必要な文字列値は、ユーザー向けプロトコルを構成します。この値は、ウェブフックを作成してURLをリダイレクトするために使用されます。トラフィックの処理に実際の影響はありません。
    DRONE_SERVER_PROTO=https
  • DRONE_SERVER_PROXY_HOST
    代替プロキシサーバを介してルーティングされるウェブフックを作成するために使用されるオプションの文字列値。この設定のターゲットユースケースは、サーバがファイアウォールの背後にあり、パブリックプロキシを介してルーティングするためにGitHubウェブフックが必要な場合です。
    DRONE_SERVER_PROXY_HOST=external.drone.company.com

  • DRONE_SERVER_PROXY_PROTO
    代替プロキシサーバを介してルーティングされるウェブフックを作成するために使用されるオプションの文字列値。この設定のターゲットユースケースは、サーバがファイアウォールの背後にあり、パブリックプロキシを介してルーティングするためにGitHubウェブフックが必要な場合です。
    DRONE_SERVER_PROXY_PROTO=https
  • DRONE_STARLARK_ENABLED
    ブール値は、パイプライン構成を提供するため.starで終わるファイルを自動的に実行するようにDroneを構成します。これはデフォルトで無効になっています。この機能には、Droneサーババージョン1.10.0以降が必要です。
    DRONE_STARLARK_ENABLED=true
  • DRONE_STASH_CONSUMER_KEY
    文字列値は、Bitbucket Serverコンシューマキーを構成します。
    DRONE_STASH_CONSUMER_KEY=OauthKey
  • DRONE_STASH_PRIVATE_KEY
    文字列値は、Bitbucket Serverプライベートキーファイルへのパスを構成します。このファイルは、ボリュームとしてDroneサーバコンテナにもマウントする必要があることに注意してください。
    DRONE_STASH_PRIVATE_KEY=/etc/bitbucket/key.pem
  • DRONE_STASH_SERVER
    文字列値は、Bitbucketサーバアドレスを構成します。
    DRONE_STASH_SERVER=https://bitbucket.company.com
  • DRONE_STASH_SKIP_VERIFY
    ブール値は、リモートBitbucketサーバへの接続を確立するときにTLS検証を無効にします。デフォルト値はfalseです。
    DRONE_STASH_SKIP_VERIFY=false
  • DRONE_STATUS_DISABLED
    ブール値は、システムがステータスAPIを使用してビルド状態をソース管理管理システムに伝達することを無効にします。デフォルト値はfalseです。
    DRONE_STATUS_DISABLED=true
  • DRONE_STATUS_NAME
    文字列値は、ビルド状態をソース管理管理システムに伝達するために使用されるステータス名を構成します。デフォルト値はcontinuous-integration/droneです。
    DRONE_STATUS_NAME=continuous-integration/drone

  • DRONE_TLS_AUTOCERT
    Lets Encryptを使用してSSL証明書を自動的に生成し、HTTPS要求を受け入れるようにサーバを構成します。この構成パラメータはブール型でオプションであり、デフォルトでは無効になっています。
    DRONE_TLS_AUTOCERT=true
  • DRONE_TLS_CERT
    サーバがHTTPS要求を受け入れるために使用するSSL証明書へのパス。この構成パラメータは文字列型であり、オプションです。
    証明書ファイルは、サーバの証明書、中間体、および認証局の証明書を連結したものである必要があることに注意してください。
    DRONE_TLS_CERT=/path/to/cert.pem
  • DRONE_TLS_KEY
    サーバがHTTPS要求を受け入れるために使用するSSL証明書キーへのパス。この構成パラメータは文字列型であり、オプションです。
    DRONE_TLS_KEY=/path/to/key.pem
  • DRONE_USER_CREATE
    起動時に作成する必要があるオプションのユーザーアカウント。これは、管理者アカウントでシステムをシードするために使用する必要があります。実際のアカウント（つまり、実際のGitHubユーザー）にすることも、マシンアカウントにすることもできます。
    DRONE_USER_CREATE=username:octocat,machine:false,admin:true,token:55f24eb3d61ef6ac5e83d550178638dc
    トークンの提供はマシンアカウントに必要であり、32バイトである必要があります。次のコマンドを使用して、ランダムな32バイトのトークンを生成できます。
    $ openssl rand -hex 16
    55f24eb3d61ef6ac5e83d550178638dc
  • DRONE_USER_FILTER
    オプションのコンマ区切りのアカウントリスト。登録は、このリストのユーザー、またはこのリストに含まれる組織のメンバーであるユーザーに制限されています。
    DRONE_USER_FILTER=octocat,spacheghost,github
    ユーザーが登録を試み、そのユーザーが指名されたユーザーでも指名された組織のメンバーでもない場合、次のエラーが表示されます。
    ログインに失敗しました。ユーザーは、承認された組織のメンバーである必要があります。
  • DRONE_VALIDATE_PLUGIN_ENDPOINT
    文字列値は、検証プラグインのエンドポイントを構成し、パイプライン構成にカスタムリンティングルールを適用するために使用されます。
    DRONE_VALIDATE_PLUGIN_ENDPOINT=http://hostname.com:3000
  • DRONE_VALIDATE_PLUGIN_SECRET
    http-signatureの作成に使用される共有シークレット。検証プラグインは、共有シークレットを使用してリクエストの信頼性を検証します。
    DRONE_VALIDATE__PLUGIN_SECRET=correct-horse-battery-staple
  • DRONE_VALIDATE_PLUGIN_SKIP_VERIFY
    ブール値は、リモート検証プラグインへの接続を確立するときにTLS検証を無効にします。デフォルト値はfalseです。
    DRONE_VALIDATE_PLUGIN_SKIP_VERIFY=false
  • DRONE_WEBHOOK_ENDPOINT
    文字列値は、グローバルシステムイベントが配信されるウェブフックエンドポイントのコンマ区切りリストを構成します。
    DRONE_WEBHOOK_ENDPOINT=http://postb.in/b/cajf7cIU
  • DRONE_WEBHOOK_EVENTS
    オプションの文字列値は、ウェブフックをトリガーするイベントとアクションのコンマ区切りのリストを提供します。設定を解除すると、すべてのイベントとアクションがウェブフックをトリガーします。
    イベントタイプによる制限：
    DRONE_WEBHOOK_EVENTS=user,build
    イベントの種類とアクションによる制限：
    DRONE_WEBHOOK_EVENTS=user:created,repo
    利用可能なイベントのリスト：
    user:created
    user:updated
    user:deleted
    repo:enabled
    repo:disabled
    repo:updated
    build:created
    build:updated
  • DRONE_WEBHOOK_SECRET
    http-signatureの作成に使用される共有シークレット。ウェブフック受信者は、共有シークレットを使用して要求の信頼性を検証できます。
    DRONE_WEBHOOK_SECRET=correct-horse-battery-staple
  • DRONE_WEBHOOK_SKIP_VERIFY
    ブール値は、リモートウェブフックアドレスへの接続を確立するときにTLS検証を無効にします。デフォルト値はfalseです。
    DRONE_WEBHOOK_SKIP_VERIFY=false

How did we do?