コンテンツにスキップ

プレリリース版のドキュメントを表示していますこちらのコンテンツはテスト用であり、本番のドキュメントとは異なる場合があります。

本番のドキュメントへ

セルフホスティングの概要

独自のインスタンスを運用すれば、すべてのシークレット、アカウント、ログ行が自分の管理するインフラストラクチャに留まります。アカウントの認証方法、インスタンスを公開インターネットから到達可能にするかどうか、インターフェースにどのブランディングを表示するかを自分で決められます。

認証モードによって、ほかに何を稼働させる必要があるかが決まります。インストール前に決めておいてください。

simple は出荷時のデフォルトで、Valkey/Redis データストアだけで動作します。full はアカウント用の SQL データベースを追加します。デフォルトは sqlite://data/auth.db の SQLite で、PostgreSQL は必須ではなくサポート対象の選択肢です。コンテナ内では、このファイルを再起動後も保持するためにマウントしたボリュームが必要です。

Simple と Full の比較では、各モードで何が有効になるか、そのデータベースをどこに置く必要があるか、後からモードを切り替えるのがどれほど難しいかを説明しています。

急いでいて、すでに稼働中の Valkey または Redis がありますか?Docker でインストールの単一 docker run コマンドなら、生成された SECRET 値を使ってポート 3000 でインスタンスを起動できます。起動後は、このページの残りの内容がそのまま当てはまります。

  • イメージとバリアント — 公開されているイメージのどれを実行すべきか、リリースタグの仕組み。
  • Docker でインストール — プロジェクトが提供する 2 つの Compose スタック。
  • Linux にインストール — Debian または Ubuntu へのベアメタルインストール。これ以外のディストリビューション系統はプロジェクトのインストールテストの対象外です。
  • サービスとして実行 — リポジトリに含まれる systemd ユニットと、systemd のないホスト向けの Procfile ランナー。
  • リバースプロキシと TLS — アプリケーションは TLS を終端しないため、前段にプロキシを置くことを前提としています。インスタンスを公開する前にお読みください。
  • インストールの確認 — 誰かに引き渡す前にインスタンスが実際に動作していることを確かめ、最初のアカウントを作成します。サイト運用者ロールは CLI からのみ付与できます。

既存のインストールをアップグレードしますか?アップグレードガイドには、利用可能なガイドが新しいものから順に一覧されています。現在運用中のリリースの次のガイドから始めて順に進め、その間のすべてのリリースのリリースノートを読んでください。

認証モード simple で運用するインスタンスの推奨構成:

  • CPU 2 コア以上
  • RAM 2GB 以上
  • ディスク容量 10GB 以上

PostgreSQL、バックグラウンドワーカー、スケジューラーも稼働させる full モードのデプロイでは、およそその 2 倍が必要です。

管理作業の一部にはアプリケーション上の画面がなく、インスタンスのコマンドラインから実行します。

主なものは、組織を新しいオーナーに移管する操作です。組織のオーナーにはそのための画面もエンドポイントもないため、移管は運用者が行う必要があります。以下のコマンドを使用してください。自動化する場合は、Colonel API が同じ操作を POST /api/colonel/organizations/:org_id/transfer-ownership で公開しています。これには colonel ロールが必要で、確認として組織名を受け取り、プレビューなしで即時に適用されます。

ターミナルウィンドウ
bin/ots org transfer-ownership ORG NEW_OWNER

ORG は組織の公開 ID(extid、CLI が表示する ID)または内部 ID(objid)です。NEW_OWNER はメールアドレス、顧客 extid、または Rodauth アカウント ID で、すでにアクティブなメンバーである必要があります。このコマンドは顧客を作成しないため、メンバーでない場合は先に bin/ots memberships add ORG CUSTOMER を実行してください。

--yes を付けずに実行すると、何も変更する前に移管の計画を立て、誰がオーナー権を失うか、いくつのオーナーメンバーシップがどのロールに降格されるかを表示したうえで確認を求めます。n と答えることで移管をプレビューできます。オプションは --demote-to ROLE(owner 以外の任意のメンバーシップロール。デフォルトは admin)、--yes(-y と -f も可)、--json です。

元のオーナーは削除されるのではなく降格されます。この操作は新しいオーナーを昇格させたあとで元のオーナーを降格します。単独オーナー保護がほかのすべての順序を拒否するためです。そのため、この 2 回の書き込みの間は組織に 2 つのオーナーメンバーシップが存在し、bin/ots org doctor はチェック 4(membership_role_sync)を警告として報告します。移管がこの間に中断された場合は、org doctor ではなく移管コマンドを再実行してください。移管は冪等で、ほかのすべてのオーナーを降格します。org doctor はこのチェックを repairable: false としてマークし、修復しません。

エンドユーザー側の説明は所有権と移管にあります。ユーザーが問い合わせてくる前に読んでいるのはこのページです。