Zero Key セットアップジェネレーター

必要な項目を入力し、設定ファイルを生成してダウンロードしてください。全ての処理はブラウザ上で完結します。入力情報は外部に送信されません。

ご利用の前に:
このツールはメールアドレスやドメインの新規作成・登録を行うものではありません。
以下をご用意の上、ご利用ください:
送受信が可能なメールアドレス(既にお持ちのもの)
取得済みのドメイン(Zero Keyに割り当てるホスト名)
メール送信用のSMTPサーバー情報(ご利用中のメールサービスの送信設定)

公開URL

取得済みで、Zero Keyに割り当てるドメインのホスト名を入力してください。https://は不要です。
例: zerokey.example.com
ドメイン名を入力してください

管理者設定

管理者ログインに使用するメールアドレスです。パスワードリセットやセキュリティ通知の送信先にもなります。
実在する受信可能なメールアドレスを入力してください。仮アドレスのまま運用すると、ロックアウト時にリセットメールを受け取れず、ログインできなくなります。
有効なメールアドレスを入力してください
初回ログイン時に使用するパスワードです。12文字以上で設定してください。ログイン後にパスキーを登録すれば、以降はパスワード不要になります。
パスワードは12文字以上で入力してください
セキュリティイベント(不審なログイン試行等)の通知先です。管理者メールと同じアドレスを推奨します。

SMTP設定(メール送信)

ユーザー招待メール・パスキー再登録メール・セキュリティ通知の送信に使用します。
この送信元アドレスからのメールを、利用者・登録者に受信拒否しないよう周知することを推奨します。
SMTPサーバーURLを入力してください
SSL/TLS: 465、STARTTLS: 587
有効なポート番号を入力してください
SMTPユーザー名を入力してください
メールサービスのパスワードまたはアプリパスワードを入力してください。
SMTPパスワードを入力してください
形式: 表示名 <メールアドレス> 例: Zero Key <[email protected]>
送信元アドレスを入力してください
メールの件名に付加される接頭辞です。自社名や組織名に変更できます。
Gmailをお使いの場合の設定手順:
1. Googleアカウント → セキュリティ → 2段階認証を有効化
2. アプリパスワードを生成(https://myaccount.google.com/apppasswords)
3. SMTPサーバー: smtp.gmail.com
4. ポート: 465
5. ユーザー名: お使いのGmailアドレス
6. パスワード: 生成したアプリパスワード(Gmailのログインパスワードではありません)
※ Google Workspace(独自ドメインのGmail)も同じ手順です。

WebAuthn(パスキー)

自動入力された値を確認してください。通常はルートドメイン(example.com、example.co.jpなど)を入力します。
一度設定すると変更できません。変更した場合、全ユーザーがパスキーを再登録する必要があります。
※ co.jpなどの複合ドメインの場合、自動導出が不正確になることがあります。手動で確認・修正してください。
RP IDを入力してください
公開URLから自動導出されます。ポート:443はZeroKeyの検証要件で必須です。

タイムゾーン

メール内のタイムスタンプに使用されるデフォルトタイムゾーンです。IANA形式で入力してください(例: Asia/Tokyo、Europe/Berlin、America/New_York)。
ユーザー個別のタイムゾーンはAdmin UIのZero Key設定ページから動的に変更できます。

暗号化キー・シークレット

内部データベースの暗号化とクラスタ通信の認証に使用します。生成ボタンで安全な値を自動作成できます。
一度生成したら変更できません。紛失するとデータの復旧ができなくなります。
暗号化キーを生成してください
Raftシークレットを生成してください
APIシークレットを生成してください
生成されたシークレットは必ずセキュアな場所に別途バックアップ保存してください。紛失するとデータの復旧ができなくなります。

オプション設定

ログイン画面(トップページ)に管理者ページへのボタンを表示するかどうかを選択します。
ボタンを非表示にしても、管理者は URLに https://{ドメイン}/auth/v1/admin を直接入力してログインできます。
一般ユーザーが管理者ボタンを押しても、管理者権限がない場合は管理者画面にはアクセスできません。セキュリティ上の問題はありません。
API開発を行う技術者のみ有効にしてください。有効にするとAPI仕様書(/auth/v1/docs/)にアクセスできるようになります。

GCP自動デプロイ

上のフォームで全項目を入力後、Googleアカウントでログインすると、お使いのGCPアカウントにZero Keyを自動デプロイできます。
VM作成からZero Key起動まで全て自動で行われます。SSHやコマンド操作は不要です。
GCP e2-microの無料枠は us-west1、us-central1、us-east1 のみです。他のリージョンでは課金が発生します。
1プロジェクトあたりe2-micro 1台が無料枠の上限です。
Googleログイン後、GCPプロジェクト一覧が自動で読み込まれます。
このツールはお客様のGCPアカウントにVMを作成します。作成されたVMの管理・削除はお客様の責任です。
VMの起動後、外部からアクセスするにはCloudflare Tunnel等のネットワーク設定が別途必要です。
事前準備: GCPのOAuth2設定手順(管理者向け)
この自動デプロイ機能を利用するには、事前にGCPでOAuth2クライアントIDの設定が必要です。

1. Google Cloud Console(https://console.cloud.google.com)にアクセス
2. 「APIとサービス」→「認証情報」を開く
3. 「認証情報を作成」→「OAuth クライアント ID」
4. アプリケーションの種類: 「ウェブ アプリケーション」
5. 承認済みのJavaScriptオリジン: このページのURL
6. 「作成」→ 表示されるクライアントIDをコピー
7. 「OAuth同意画面」でアプリ名・メール等を設定

※ 上記は手順の例です。実際の手順はGCPの画面に合わせて確認してください。
入力に不備があります。赤く表示されている項目を確認してください。
※ secrets.txtはサーバーに配置せず、セキュアな場所に別途保管してください。
GCPにデプロイする場合(手順例)
1. 上のフォームで全項目を入力し、「GCP startup script をコピー」ボタンを押す
2. GCPコンソール(https://console.cloud.google.com)にログイン
3. Compute Engine → VMインスタンス → 「インスタンスを作成」
4. マシンタイプ例: e2-micro(無料枠対象)
5. リージョン例: asia-northeast1(東京)
6. OSイメージ例: Ubuntu 22.04 LTS
7. 「詳細オプション」→「管理」→「自動化」→「起動スクリプト」テキストボックスに、コピーしたスクリプトを貼り付け
8. 「作成」ボタンでVM作成。起動後、自動的にZero Keyがセットアップされます
9. ブラウザで https://{ドメイン}/auth/v1/ にアクセスし、設定した管理者メール・パスワードでログイン
10. Admin UI → Zero Key設定ページで運用ポリシーを設定

※ 上記は手順の例です。実際の手順は実装環境に合わせて確認・変更してください。
NAS・自前サーバーにデプロイする場合(手順例)
1. 上のボタンから全ファイル+setup.shをダウンロード
2. SSHでサーバーに接続
3. 任意のディレクトリを作成: mkdir -p ~/zerokey && cd ~/zerokey
※ Synology NASの場合は /volume1/docker/zerokey/ など、DSMやSMB共有から見える場所に作成してください。見えない場所ではファイルを直接ドロップ配置できません
4. ダウンロードした5ファイル(config.toml、compose.yaml、Caddyfile、secrets.txt、setup.sh)を配置
5. cd ~/zerokey && bash setup.sh を実行(フォルダ作成・権限設定・Docker起動を一括実行します)
6. ブラウザで https://{ドメイン}/auth/v1/ にアクセスし、設定した管理者メール・パスワードでログイン
7. Admin UI → Zero Key設定ページで運用ポリシーを設定

※ 上記は手順の例です。実際の手順は実装環境に合わせて確認・変更してください。