-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Command line arguments ja JP
ASFには、プログラムランタイムに影響を与える可能性のある複数のコマンドライン引数のサポートが含まれています。 上級ユーザーは、プログラムの実行方法を指定するためにこれらを使用できます。 ASF.json
の設定ファイルを使ったデフォルトの方法と比較して、コマンドライン引数はコアの初期化(例: --path
)、プラットフォーム固有の設定(例: --system-required
)、または機密データ(例: --cryptkey
)に使用されます。
使用方法はOSとASFの種類によって異なります。
一般:
dotnet ArchiSteamFarm.dll --引数 --別の引数
Windows:
.\ArchiSteamFarm.exe --引数 --別の引数
Linux/macOS:
./ArchiSteamFarm --引数 --別の引数
コマンドライン引数は、 ArchiSteamFarm.cmd
や ArchiSteamFarm.sh
などの一般的なヘルパースクリプトでもサポートされています。 それに加えて、 ASF_ARGS
環境プロパティも使用できます。 例えば、
管理 と docker セクションで述べているように。
もしコマンドライン引数にスペースが含まれる場合は、その引数を引用符(クォーテーションマーク)で囲む必要があります。 この二つは間違っています:
./ArchiSteamFarm --path /home/archi/My Downloads/ASF # 駄目!
./ArchiSteamFarm --path=/home/archi/My Downloads/ASF # 駄目!
ただし、その2つは完全に問題ありません:
./ArchiSteamFarm --path "/home/archi/My Downloads/ASF" # OK
./ArchiSteamFarm "--path=/home/archi/My Downloads/ASF" # OK
--cryptkey <key>
または --cryptkey=<key>
- <key>
の値のカスタム暗号鍵でASFを開始します。 このオプションは セキュリティ に影響を与え、デフォルトの 1 つのハードコードされた <key>
キーを使用します。 このプロパティはデフォルトの暗号化キー(目的の暗号化)とソルト(目的のハッシュ化)に影響を与えるため、 このキーで暗号化された/ハッシュされたすべてのものは、ASF実行ごとにそれを渡す必要があることに注意してください。
<key>
の長さや文字に要件はありませんが、セキュリティ上の理由から、例えばランダムな32文字からなる十分に長いパスフレーズを選ぶことをお勧めします。例えば、Linuxで tr -dc A-Za-z0-9 < /dev/urandom | head -c 32; echo
コマンドを使用することで生成できます。
また、この詳細は他の2つの方法でも提供できます。それは、--cryptkey-file
(ファイルからパスフレーズを読み込む) と --input-cryptkey
(実行時に入力を求める) です。
このプロパティの性質上、 ASF_CRYPTKEY
環境変数を宣言することで cryptkey を設定することもできます。 プロセスの議論で機密性の高い詳細を避けたい人には適しているかもしれません。
--cryptkey-file <path>
または --cryptkey-file=<path>
- カスタム暗号鍵を <path>
ファイルから読み込んだ状態でASFを開始します。 これは、上記で説明された --cryptkey <key>
と同じ目的を果たしますが、メカニズムが異なります。このプロパティは、提供された <path>
から <key>
を読み込むことになります。 もしこれを --path
と一緒に使う場合、引数の順番によって相対パスが変わる可能性がある点に留意してください。つまり、--path
を --cryptkey-file
の前とどちらに切り替えるかによって変わります。
このプロパティの性質上、 ASF_CRYPTKEY
環境変数を宣言することで cryptkey を設定することもできます。 プロセスの議論で機密性の高い詳細を避けたい人には適しているかもしれません。
--ignore-unsupported-environment
- これは、サポートされていない環境での実行に関連する問題をASFが無視するようにします。通常、これらの問題はエラーと強制終了によって通知されます。 サポートされていない環境には、例えば linux-x64
上で win-x64
OS固有のビルドを実行する場合などが含まれます。 このフラグは、ASFがそのようなシナリオで実行しようとすることを可能にします。 正式なサポートは行っておらず、お客様ご自身のリスク でASFに完全にを行うことを強制されていることにご注意ください。 重要なのは、サポートされていない環境シナリオのすべてが修正可能であることだ。 この引数を宣言する代わりに未解決の問題を修正することを強くお勧めします。
--input-cryptkey
- 起動時に、ASFに--cryptkey
の入力を求める。 このオプションは、環境変数やファイルに関わらず、cryptkey を提供する代わりに便利かもしれません。 どこにも保存せず、ASF実行ごとに手動で入力する必要があります。
--minimized
- 起動後まもなくASFコンソールウィンドウが最小化されます。 主に自動起動シナリオで便利ですが、それらの外で使用することもできます。 このオプションは適切な環境サポートが必要です - すべてのシナリオで適切に動作しない可能性があります。
--network-group <group>
または --network-group=<group>
- カスタムネットワークグループ <group>
の値でリミッターを初期化します。 このオプションは、 複数のインスタンス で、同じネットワークグループを共有するインスタンスにのみ依存することを示すことによって、ASFを実行することに影響します。 残りの部分から独立しています。 通常、このプロパティはカスタムメカニズムを介してASFリクエストをルーティングしている場合にのみ使用します。 異なるIPアドレス)ネットワークグループを ASFに自動的に実行させることなく(現在、 WebProxy
のみを考慮しています)自分で設定します。 カスタムネットワークグループを使用する場合、これはローカルマシン内でユニークな識別子であり、ASFは WebProxy
値のような他の詳細を 考慮しないことに 注意してください。
このプロパティの性質上、 ASF_CRYPTKEY
環境変数を宣言することで cryptkey を設定することもできます。 プロセスの議論で機密性の高い詳細を避けたい人には適しているかもしれません。
--no-config-migrate
- デフォルトでは、ASFは自動的に設定ファイルを最新の構文に移行します。 移行には非推奨のプロパティを最新のものに変換することが含まれており、デフォルト値のプロパティを削除します (効果はありません)。 また、一般的にファイルをクリーンアップすることもできます(インデントの修正など)。 これはほとんどの場合良いアイデアですが、ASFに設定ファイルを自動的に上書きしないようにする特定の状況があるかもしれません。 例えば、設定ファイルを chmod 400
(所有者のみ読み取り許可) に設定したり、chattr +i
を適用したりすることを検討すると良いでしょう。結果として、これはセキュリティ対策として、誰に対しても書き込みアクセスを拒否することになります。 通常、設定の移行を有効にしておくことをお勧めします。 しかし、特定の理由でそれを無効にし、代わりにASFがそうしないことを好む場合は、 このスイッチを使ってその目的を達成することができます。 しかし、ASFに正しい設定を提供することは、今後あなたの新しい責任で行われることに注意してください。 将来のASFバージョンにおける廃止およびプロパティのリファクタリングに関しては特に。
--no-config-watch
- デフォルトでは、ファイルの変更に関連するイベントをリッスンするために、 FileSystemWatcher
を config
ディレクトリに設定します。 対話的に適応できるのです。 たとえば、設定削除時にボットを停止する、設定変更時にボットを再起動するなどです。 または、 BGR config
ディレクトリにキーをドロップします。 このスイッチでは、このような動作を無効にできます。これにより、ASFは config
ディレクトリ内のすべての変更を完全に無視します。 適切と判断された場合(通常はプロセスを再起動することを意味します)は、お客様からそのようなアクションを手動で行うことを要求します。 設定イベントを有効にしておくことをお勧めします。 しかし、それらを無効にする特定の理由があり、代わりにASFがそうしないことを好む場合は、 このスイッチを使ってその目的を達成することができます。
--no-restart
- デフォルトのASFは AutoRestart
設定プロパティに従います。 これは、必要に応じて再起動が許可されるかどうかを指定するために使用できます。 当社が提供する一部のソリューションは、プロセス管理を担当し、ASFの自動再起動機能と明示的に互換性がありません。 例えば、 docker
または systemd
でASFを実行するなど。 終了するにはプロセスが必要だから適切と判断された場合は 後で再起動するのが彼らの責任だからです 任意の設定編集はユーザーエクスペリエンスからは不要ですので。 このスイッチは AutoRestart
config プロパティを明示的に false
に初期化するだけです。 たとえ設定で指定したとしてもです そのおかげで、ASFはそのような環境での実行について事前に通知することができます。 互換性のある AutoRestart: false
設定ファイルを提供する必要はありません。
In addition to the above, --no-restart
, in contrary to AutoRestart: false
, will also forbid you from using restart
command or otherwise issuing ASF process to restart, since the switch explicitly states it's not compatible with such setup, while AutoRestart
property only specifies default behaviour.
通常は、ここで説明されている動作を制御することができます(また、設定ファイルで説明されている動作を制御する必要があります)。 カスタムスクリプトやその他の同様の環境でASFを実行している場合は、 ASFの再起動を禁止するこのスイッチを使用することもできます。
--no-steam-parental generation
- デフォルトではASFは自動的にSteamペアレンタルPINを生成しようとします。 を
**
`SteamParentalCode</0> 設定プロパティで説明します。 ただし、OSリソースの過剰な量が必要になる可能性があるため、このスイッチを使用すると、その動作を無効にできます。 自動生成をスキップし、代わりにユーザーにPINを要求するためにASFが発生します。 通常は自動生成が失敗した場合にのみ起こります。 設定イベントを有効にしておくことをお勧めします。 しかし、それらを無効にする特定の理由があり、代わりにASFがそうしないことを好む場合は、 このスイッチを使ってその目的を達成することができます。
--path ` または `--path=` - ASFは常に起動時に独自のディレクトリに移動します。 この引数を指定すると、ASFは初期化後に指定されたディレクトリに移動します。これにより、バイナリを同じ場所に複製する必要なく、様々なアプリケーション部分(`config`、`logs`、`plugins`、`www`ディレクトリ、`NLog.config`ファイルなど)にカスタムパスを使用することができます。 実際の設定からバイナリを分離したい場合に特に便利になるかもしれません。 Linuxのようなパッケージングで行われているため、この方法では複数の異なるセットアップで1つの(最新の)バイナリを使用することができます。 パスは、ASFバイナリの現在の場所に従って相対するか、絶対パスにするかのどちらかです。 このコマンドは新しい "ASFホーム" を指すことに留意してください - オリジナルのASFと同じ構造を持つディレクトリです。 with `config` directory 詳細は以下の例を参照してください。
このプロパティの性質上、 ASF_CRYPTKEY
環境変数を宣言することで cryptkey を設定することもできます。 プロセスの議論で機密性の高い詳細を避けたい人には適しているかもしれません。
ASFの複数のインスタンスを実行するために、このコマンドライン引数を使用することを検討している場合。 管理ページ をこの方法で読むことをお勧めします。
例:
dotnet /opt/ASF/ArchiSteamFarm.dll --path /opt/TargetDirectory # 絶対パス
dotnet /opt/ASF/ArchiSteamFarm.dll --path ../TargetDirectory # 相対パスも有効
ASF_PATH=/opt/TargetDirectory dotnet /opt/ASF/ArchiSteamFarm.dll # env 変数と同じ
├── 📁 /opt
│ ├── 📁 ASF
│ │ ├── ⚙️ ArchiSteamFarm.dll
│ │ └── …
│ └── 📁 TargetDirectory
│ ├── 📁 config
│ ├── 📁 logs (生成される)
│ ├── 📁 plugins (オプション)
│ ├── 📁 www (オプション)
│ ├── 📄 log.txt (生成される)
│ └── 📄 NLog.config (オプション)
└── …
--service
- このスイッチは主に systemd
サービスで使用され、 ヘッドレス
の true
を強制します。 特定のニーズがない限り、設定で AutoRestart
プロパティを直接設定してください。 このスイッチはここにありますので、docker スクリプトは、独自の環境に合わせるためにグローバル設定に触れる必要はありません。 もちろん、スクリプト内でASFを実行している場合は、このスイッチを使用することもできます (そうでなければ、グローバル設定プロパティを使用する方が良いです)。
--system-required
- このスイッチを宣言すると、ASFはプロセスがシステムを起動し、その寿命全体にわたって実行する必要があるというOSをシグナルしようとします。 現在、このスイッチは、プロセスが実行されている間、システムがスリープモードに入ることを禁止するWindowsマシンにのみ効果があります。 これは、夜間にPCやラップトップでファーミングをするときに特に有用であることが証明できます ASFは起動中にシステムをスリープ状態に保つことができます。