本文へスキップ

Web インストール手順 ​

バイナリ、Docker Compose、Kubernetesのいずれかで Sayrud を起動し、http://server-address:2830/setup を開きます。未インストールの場合、ホームページからもこの画面に転送されます。

インストールは、本人確認、データベース、管理者、完了の 4 ステップです。画面右上で言語を切り替えられます。

本人確認 ​

インストールトークンを指定していない場合、起動ログに Setup token: とトークン付きのインストールリンクが表示されます。トークンを画面に入力して「確認」をクリックします。リモート環境では、ログのリンク内の localhost を実際のアクセス先に置き換えてください。

デプロイ方法ログの確認先
フォアグラウンド実行現在のターミナル
systemdsudo journalctl -u sayrud -n 100 --no-pager
Docker Composedocker compose logs --tail=100 sayrud
Kuberneteskubectl -n sayrud logs deployment/sayrud --tail=100

SAYRUD_SETUP_TOKEN を設定している場合は、その環境変数の値を入力します。K8s の手順ではこの方法を使い、トークンは Secret の作成に使ったローカルファイルに保存されています。

任意のトークンを指定する場合、空白とハイフンを除いて 16 文字以上必要です。openssl rand -hex 24 で生成できます。確認時は大文字と小文字、空白、ハイフンを区別しません。

トークンを固定していない場合、インストール中にプロセスを再起動すると新しいトークンが生成されます。最新のログから取得してください。トークンとトークン付きリンクはインストール担当者だけに共有してください。管理者の作成後、インストール用の API は閉じられます。

データベースの設定 ​

新規インストールでは、次の情報を入力します。

サービス入力項目
PostgreSQLホスト、ポート、データベース名、ユーザー名、パスワード、SSL モード
Redisホスト:ポート 形式のアドレスと、必要に応じてユーザー名とパスワード

接続するのは Sayrud のプロセスであり、ブラウザーを開いているパソコンではありません。Docker Compose では postgres と redis:6379、K8s ではクラスター内の Service 名または接続可能な外部ドメインを使用します。

PostgreSQL の SSL モードには「暗号化しない」「暗号化する」「暗号化して CA を検証」「暗号化して CA とホスト名を検証」があります。データベースサービスの要件に合わせて選んでください。証明書を検証する場合は、実行環境でも該当する CA を信頼する必要があります。

「接続をテスト」をクリックし、PostgreSQL と Redis の両方に接続できることを確認してから、「保存して続行」をクリックします。

管理者の作成 ​

メールアドレス、ユーザー名、パスワード、確認用パスワードを入力し、「インストールを完了」をクリックします。

最初のシステム管理者が作成され、自動的にログインします。「使い始める」をクリックするとアプリケーションに移動します。

インストール後、プロジェクトの作成、レコードの編集、添付ファイルのアップロードができることを確認し、デプロイ方法に応じて設定とアップロードしたファイルが永続化されているかを確認してください。サイト設定、ユーザー登録の可否、ログイン方法、AI モデルなどは管理画面で変更できます。

設定ファイルを事前に用意する ​

構成管理システムから接続情報を渡す場合は、sayrud.yaml を事前に用意できます。以下はローカルストレージを使う設定です。接続パスワードと auth.secret_key を置き換えてください。

yaml
postgres:
  dsn: "postgres://sayrud:[email protected]:5432/sayrud?sslmode=disable"
redis:
  address: "127.0.0.1:6379"
  username: ""
  password: ""
auth:
  secret_key: "REPLACE_WITH_BASE64_KEY"
storage:
  type: local
  local:
    path: ./data/storage

次のコマンドで auth.secret_key を生成し、出力全体を設定に貼り付けます。

sh
openssl rand -base64 32

PostgreSQL の URL を手書きする場合、パスワード内の @、:、/ などの特殊文字は URL エンコードが必要です。ウィザードで入力する場合はプログラムが処理します。

起動引数で指定したパスにファイルを配置します。すべての設定項目は設定例を参照してください。設定変更後はプログラムを再起動します。

トラブルシューティング ​

インストール画面が表示されない ​

ログで正常な起動を確認でき、データベースに既存のユーザーがいる場合は、アプリケーションが直接表示されます。既存のアカウントでログインしてください。

インストールトークンが無効になった ​

インストール中にプロセスを再起動していないか確認してください。SAYRUD_SETUP_TOKEN を設定していない場合は、最新のログのトークンを使います。K8s では Pod が想定した Secret を使用していることを確認し、初回インストール時は 1 レプリカにしてください。連続して間違えるとレート制限がかかるため、トークンを確認してから再試行してください。

データベースの接続テストに失敗する ​

データベースが作成済みか、認証情報が正しいか、アプリケーションのホストまたは Pod から接続できるかを確認してください。コンテナ内の 127.0.0.1 はそのコンテナ自身を指します。接続テストは成功しても保存に失敗する場合は、スキーマ移行の権限も確認してください。

新規インストールのウィザードでは、既存のユーザーがいるデータベースは使用できません。既存インスタンスの復元時は、元の設定、キー、アップロードしたファイルを復元し、通常の起動で元のデータベースに接続してください。データベース設定の手順をやり直す必要はありません。

設定の保存時に権限エラーが発生する ​

ウィザードは設定ディレクトリに一時ファイルを書き込み、その後 sayrud.yaml として確定するため、ディレクトリへの書き込み権限が必要です。読み取り専用マウント、ConfigMap、Secret、またはプロセスの UID/GID とボリューム所有者の不一致を確認してください。Docker と K8s のイメージは 10001:10001 を使用します。

設定は保存されたが再起動が必要と表示される ​

サービスのログで、その後の初期化に失敗した原因を確認して解消し、同じ設定パスで再起動してください。保存済みの設定が再度読み込まれるため、削除して再インストールする必要はありません。

コンテナを作り直すとインストール画面に戻る ​

設定ディレクトリが /home/app/config にマウントされているか、元の PostgreSQL データベースを使っているか、Compose のプロジェクト名や K8s の PVC が変わっていないか確認してください。新しいインストールを進める前に、元の設定とデータを復元してください。