パートとセーフモード

セットアップ

使わないパート(オン・オフできる機能のまとまり)をオフにし、問題が起きたときはセーフモードで起動し、ブラウザーから HolyArrs を再起動します。

パートをオン・オフする

HolyArrs には 5 つのパートがあります: Movies(映画)、TV shows(TV 番組)、Music(音楽)、Subtitles(字幕)、Requests(リクエスト)。最初は初回セットアップのウィザードで選びます。

Settings > Parts(設定 > パート)を開きます。
パートの横の Turn on(オンにする)または Turn off(オフにする)をクリックします。そのパートのメニュー項目が表示されるか、消えます。

何も削除されません。パートをもう一度オンにすると、前の続きから再開します。

セーフモードで起動する

セーフモードは、基本的な機能だけを起動します。何かが原因で HolyArrs が起動しない、または動かないときに使います。サインイン、ライブラリの閲覧、設定の変更、バックアップの作成と復元ができます。検索、追加、更新、ダウンロード、インポートは、次の通常起動まで待機します。

Settings > Danger zone(設定 > 危険な操作)を開きます。
Restart in safe mode(セーフモードで再起動)をクリックします。すべてのページにバナーが表示されます。
問題を直してから、Restart HolyArrs(HolyArrs を再起動)をクリックします。次は通常どおり起動します。

このページを開けない場合は、Compose で HOLYARRS_SAFE_MODE=1 を設定するか、-safe-mode を付けて起動します。直したあとは取り除いてください。どちらも、残している限り毎回セーフモードで起動します。

オプション

パートがオフのときに止まるもの

パート	止まるもの	続くもの
映画	映画のページとメニュー項目、追加、検索、更新	ダウンローダーにすでにあるダウンロードは引き続き追跡されます。ファイルは残ります。
TV 番組	番組のページ、追加、検索、シーズン検索、更新	映画と同じです。
音楽	アーティストとアルバムのページ、音楽の設定、アーティストの更新、アルバム検索	映画と同じです。
字幕	字幕の設定、不足している字幕のページ、検索とチェック	動画の横にある字幕ファイルは残ります。
リクエスト	リクエストのページと、タイトルのリクエスト	既存のリクエストは残り、オンに戻すと復帰します。

常にオンのもの: サインインとアカウント、ライブラリフォルダー、ソース、ダウンローダーとダウンロード、通知、履歴、バックアップ、ヘルスチェック、設定、API。

字幕には映画か TV 番組が必要です。リクエストには映画、TV 番組、音楽のいずれかが必要です。この条件を崩す変更は HolyArrs が拒否し、先に何を変えるべきかを示します。
オフのパートのキューに入っているジョブは待機し、パートがオンになると実行されます。
パートをオフにしてもメモリは節約されません。すべて 1 つのプログラムで動いています。

再起動、一時停止、シャットダウン

Settings > Danger zone(オーナーと管理者)には、Restart HolyArrs、Restart in safe mode、Shut down(シャットダウン)があります。さらに、バックアップやダウンロードの同期といったバックグラウンドタスクごとに、Pause(一時停止)、Resume(再開)、Restart(再起動)があります。

何かを止める操作では、60 秒以内の確認を求められます。
使った操作はすべて、名前とともに履歴に記録されます。
パスワードでのサインインが必要です。ローカルネットワークでのパスワードなしのサインインは拒否されます。

再起動では、HolyArrs が正常に停止し、Docker が起動し直します。そのため restart: unless-stopped を設定してください。

再起動ポリシー	再起動	シャットダウン
`unless-stopped` または `always`	復帰する	こちらも復帰する
`on-failure`	復帰する	停止したまま
`no`	停止したまま	停止したまま

うまくいかないとき

症状	原因	対処
HolyArrs がパートをオフにできない	別のパートがそれを必要としている	メッセージのとおり、先にそのパートをオフにします。
再起動したら HolyArrs が停止したままになった	再起動ポリシーが `no` になっている	コンテナを起動し、`restart: unless-stopped` を設定します。
操作が拒否される	パスワードなしのローカルサインインである、またはキーに `control` がない	パスワードでサインインします。
タスクが failed のままになる	対応が必要	`/health` で理由を読み、直してから、そのタスクの Restart をクリックします。

そのほかの対処: トラブルシューティング。

上級者向け

稼働状態

/health、Settings > Parts、GET /api/v1/health/states には、各バックグラウンドタスク、パート、連携アプリが、状態と理由とともに一覧表示されます。

状態	意味
off	オフにされている、一時停止中、またはセーフモードで起動されていない。
starting	起動中、またはまだチェックされていない。
running	動いている。
retrying	失敗した。HolyArrs が、待ち時間を毎回延ばしながら再試行します。
failed	クラッシュした、固まった、または対応が必要。理由に、何をすべきかが書かれています。

クラッシュしたタスクは failed、次に retrying と表示され、そのあと再び起動します。その間も、サインイン、ライブラリ、バックアップは動き続けます。固まったタスクは、完全に再起動すると解消します。

メモリと低メモリモード

HolyArrs は 384 MiB 以内に収まるように動作し、500 MB のコンテナ上限に収まります。目標値を自分で決めるには、GOMEMLIMIT をコンテナのメモリの約 80 パーセントに設定します。

低メモリモードでは、メモリに保持する量を減らし、データベースから読み取る量を増やします。一部のページは表示に少し時間がかかり、音楽カタログのコピーなどのバックグラウンド処理は実行頻度が下がります。

設定	効果
(既定、Linux)	メモリが約 2.5 GiB 以下のとき、自動でオンになります。
`HOLYARRS_LOW_MEMORY=1`	常にオン。
`HOLYARRS_LOW_MEMORY=0`	常にオフ。

ログの最初の行に、オンかどうかとその理由が出ます。

API キーのスコープ

Settings > API > API keys(設定 > API > API キー)でキーを作成し、X-Api-Key ヘッダーで送ります。

スコープ	対象
`read`	ライブラリ、ジョブ、ダウンロード、履歴、稼働状態、設定。シークレットは隠されます。
`health_read`	稼働状態のみ。監視ツール向け。
`write`	管理者用ルートと操作を除く、すべての変更。
`admin`	ユーザー、招待、リクエストの上限、API キー、パスワードと 2 要素認証、サインインの設定、バックアップ。
`control`	このページの操作。付与できるのはオーナーと管理者だけです。
`all`	`read`、`write`、`admin`。`control` は含みません。

キーは、作成した本人にできる以上のことはできません。スコープはあとから変更できないので、新しいキーを作成してください。すべてのルートとそのスコープ: /api/v1/openapi.json。