Self-hostingインストール&デプロイガイド

Linux標準デプロイメント

この記事では、自分のLinuxサーバーにBitwardenをインストールしてデプロイする手順を説明します。BitwardenはWindowsマシンにもインストールして展開することができます。Bitwarden ソフトウェアリリースサポートのドキュメンテーションをご確認ください。

システム仕様

最小限

おすすめ

プロセッサー

x64、1.4GHz

x64、2GHzデュアルコア

記憶

2GB RAM

4GB RAM

ストレージ

12GB

25GB

Dockerバージョン

エンジン19+およびコンポーズ1.24+

エンジン19+とコンポーズ1.24+

チップ

手頃な価格で質の高いサービスを提供する企業をお探しであれば、DigitalOceanをお勧めします。今日から始めましょう、または私たちのDigitalOcean上のBitwardenについてのブログ投稿を読んでください。

要約すると

この記事におけるインストール手順の概要は次のとおりです。このセクションのリンクは、詳細なインストール手順セクションにジャンプします。

  1. ドメインを構成します。あなたのマシンを指すドメイン名のDNSレコードを設定し、マシンの80番と443番のポートを開きます。

  2. マシンにDocker と Docker Compose をインストールします

  3. インストールを完了するためのBitwarden ユーザーとディレクトリを作成します

  4. インストールに使用するために、https://bitwarden.com/hostからインストールIDとキーを取得してください。

    詳細については、インストールIDとインストールキーは何に使われますか?をご覧ください。

  5. マシンにBitwarden をインストールします

  6. ./bwdata/env/global.override.envの設定を調整して環境を構成します

    チップ

    少なくとも、globalSettings__mail__smtp...変数を設定して、ユーザーを招待し確認するためのメールアドレスサーバーを設定してください。

  7. インスタンスを開始します

  8. 設定したドメインをウェブブラウザで開いて、インストールをテストしてください。

  9. デプロイしたら、定期的にサーバーのバックアップを取り、システムの更新を確認することをお勧めします。

インストール手順

あなたのドメインを設定してください

デフォルトでは、Bitwardenはホストマシンのポート80(http)および443(https)を通じて提供されます。これらのポートを開けて、ネットワーク内部および/または外部からBitwardenにアクセスできるようにしてください。インストール中に異なるポートを選択することもできます。

インターネット経由でBitwardenを提供している場合、特に、ホストマシンを指すDNSレコードを持つドメイン名(例:bitwarden.example.com)を設定することをお勧めします。

DockerとDocker Composeをインストールしてください。

Bitwardenは、一連のDockerコンテナを使用して、あなたのマシンにデプロイされ、実行されます。Bitwardenは、どのDockerエディションやプランでも実行できます。あなたのインストールに最適な版を評価してください。

コンテナのデプロイメントは、Docker Composeを使用してオーケストレーションされます。一部のDockerインストール、macOS用Dockerを含む、はすでにDocker Composeがインストールされています。

インストールを進める前に、あなたのマシンにDockerとDocker Composeをインストールしてください。次のDockerのドキュメントを参照してヘルプを得てください:

Bitwardenローカルユーザー&ディレクトリを作成する

私たちは、Bitwardenをインストールして実行するための専用のBitwardenサービスアカウントを持つLinuxサーバーを設定することをお勧めします。これにより、サーバー上で実行されている他のアプリケーションからBitwardenインスタンスが隔離されます。

これらのステップはBitwardenが推奨するベストプラクティスですが、必須ではありません。詳細については、DockerのLinux用のインストール後の手順のドキュメンテーションをご覧ください。

  1. Bitwardenユーザーを作成する:

    Bash
    sudo adduser bitwarden
  2. Bitwardenユーザーのパスワードを設定します(強力なパスワード):

    Bash
    sudo passwd bitwarden
  3. Dockerグループを作成します(まだ存在しない場合):

    Bash
    sudo groupadd docker
  4. Bitwardenユーザーをdockerグループに追加します:

    Bash
    sudo usermod -aG docker bitwarden
  5. Bitwardenディレクトリを作成します:

    Bash
    sudo mkdir /opt/bitwarden
  6. /opt/bitwardenディレクトリの権限を設定します:

    Bash
    sudo chmod -R 700 /opt/bitwarden
  7. /opt/bitwardenディレクトリの所有者としてBitwardenユーザーを設定します:

    Bash
    sudo chown -R bitwarden:bitwarden /opt/bitwarden

Bitwardenをインストールします

注意

あなたがBitwardenユーザー&ディレクトリを作成した場合、bitwardenユーザーとして/opt/bitwardenディレクトリから以下を完了してください。インストール中に問題が発生する可能性があるため、 Bitwarden を root としてインストールしないでください

Bitwardenは、LinuxとWindows(PowerShell)への簡単なインストールのためのシェルスクリプトを提供しています。次の手順を完了して、シェルスクリプトを使用してBitwardenをインストールします:

  1. Bitwardenのインストールスクリプト(bitwarden.sh)をあなたのマシンにダウンロードしてください:

    Bash
    curl -Lso bitwarden.sh "https://func.bitwarden.com/api/dl/?app=self-host&platform=linux" && chmod 700 bitwarden.sh
  2. インストーラースクリプトを実行してください。./bwdataディレクトリは、bitwarden.shの位置に対して相対的に作成されます。

    Bash
    ./bitwarden.sh install
  3. インストーラーのプロンプトを完了させてください:

    • あなたのBitwardenインスタンスのドメイン名を入力してください:

      通常、この値は設定されたDNSレコードであるべきです。

    • Let's Encryptを使用して無料のSSL証明書を生成しますか? (はい/いいえ):

      yを指定して、Let's Encryptを使用して信頼性のあるSSL証明書を生成します。Let's Encryptからの有効期限のリマインダーのために、メールアドレスを入力するように求められます。詳細については、証明書のオプションをご覧ください。

      あるいは、nを指定し、SSL証明書を使用するためのオプションを使用しますか?

    • あなたのインストールIDを入力してください:

      有効なメールアドレスを使用して、https://bitwarden.com/hostでインストールIDを取得してください。詳細については、インストールIDとインストールキーは何に使われますか?をご覧ください。

    • あなたのインストールキーを入力してください:

      有効なメールアドレスを使用して、https://bitwarden.com/hostでインストールキーを取得してください。詳細については、インストールIDとインストールキーは何に使われますか?をご覧ください。

    • SSL証明書をお持ちですか? (はい/いいえ):

      すでに自分自身のSSL証明書を持っている場合は、yを指定し、必要なファイルを./bwdata/ssl/your.domainディレクトリに配置してください。それが信頼できるSSL証明書であるかどうか尋ねられます(はい/いいえ)。詳細については、証明書のオプションをご覧ください。

      あるいは、nを指定し、テスト目的のみに推奨される自己署名SSL証明書?オプションを使用しますか?

    • 自己署名SSL証明書を生成しますか? (はい/いいえ):

      Bitwardenが自己署名証明書を生成するようにyを指定してください。このオプションはテスト用にのみ推奨されます。詳細については、証明書のオプションをご覧ください。

      あなたがnを指定すると、あなたのインスタンスはSSL証明書を使用せず、HTTPSプロキシをインストールの前に設定するか、それ以外の場合はBitwardenアプリケーションは正常に機能しません。

インストール後の設定

あなたの環境を設定するには、2つのファイル、つまり環境変数ファイルとインストールファイルに変更を加えることが含まれます。

環境変数(必須

Bitwardenの一部の機能はbitwarden.shスクリプトによって設定されていません。これらの設定を、./bwdata/env/global.override.envに位置する環境ファイルを編集することで設定します。少なくとも、以下の値を置き換えるべきです:

Bash
... globalSettings__mail__smtp__host=<placeholder> globalSettings__mail__smtp__port=<placeholder> globalSettings__mail__smtp__ssl=<placeholder> globalSettings__mail__smtp__username=<placeholder> globalSettings__mail__smtp__password=<placeholder> ... adminSettings__admins= ...

globalSettings__mail__smtp...=のプレースホルダーを置き換えて、新規ユーザーへの確認メールや組織への招待をSendするために使用されるSMTPメールサーバーに接続します。adminSettings__admins=にメールアドレスを追加すると、システム管理者ポータルへのアクセスが設定されます。

編集後にglobal.override.env、以下のコマンドを実行して変更を適用します:

Bash
./bitwarden.sh restart

インストールファイル

Bitwardenのインストールスクリプトは./bwdata/config.ymlの設定を使用して、インストールに必要なアセットを生成します。一部のインストールシナリオ(代替ポートを使用したプロキシ経由のインストールなど)では、標準インストール時に提供されなかったconfig.ymlへの調整が必要になる場合があります。

必要に応じてconfig.ymlを編集し、変更を適用するために次のコマンドを実行してください:

Bash
./bitwarden.sh rebuild

Bitwardenを開始します

すべての前のステップが完了したら、Bitwardenインスタンスを開始します:

Bash
./bitwarden.sh start
備考

初めてBitwardenを起動すると、Docker Hubからすべての画像をダウンロードするため、時間がかかる場合があります。

すべてのコンテナが正しく動作していることを確認してください。

Bash
docker ps
docker-healthy.png
docker-healthy.png

おめでとうございます!Bitwardenは現在、https://your.domain.comで稼働しています。それが機能していることを確認するために、ウェブブラウザでウェブ保管庫を訪れてください。

あなたは今、新しいアカウントを登録してログインすることができます。新しいアカウントのメールアドレスを確認するためには、smtp環境変数を設定する必要があります(環境変数を参照してください)。

チップ

デプロイしたら、定期的にサーバーのバックアップを取ることと、システムの更新を確認することをお勧めします。

次のステップ:

スクリプトコマンド参照

Bitwardenのインストールスクリプト(bitwarden.shまたはbitwarden.ps1)には、以下のコマンドが利用可能です:

備考

PowerShellのユーザーは、接頭辞として-(スイッチ)を付けてコマンドを実行します。例えば、.\bitwarden.ps1 -start

コマンド

説明

インストール

インストーラーを開始してください。

開始

すべてのコンテナを開始します。

再起動

すべてのコンテナを再起動します(スタートと同じ)。

止まって

すべてのコンテナを停止します。

更新

すべてのコンテナとデータベースを更新してください。

updatedbを更新する

データベースを更新/初期化します。

アップデート実行

run.sh ファイルを更新してください。

自分自身を更新する

このメインスクリプトを更新してください。

アップデート設定

実行中のインスタンスを再起動せずに、すべてのコンテナを更新してください。

アンインストール

このコマンドが実行される前に、データベースファイルの保存を求めるプロンプトが表示されます。 y は、最新のバックアップを含むデータベースのtarファイルを作成します。

コンテナを停止し、bwdata ディレクトリとそのすべての内容を削除し、一時的なボリュームを削除します。実行後、Bitwardenのすべてのイメージもパージしたいかどうか尋ねられます。

ログを圧縮する

すべてのサーバーログのターボールをダウンロードするか、指定した日付範囲のサーバーログのターボールを現在のディレクトリにダウンロードします。

例えば、2024年3月4日から2024年3月5日までのログをダウンロードするには、./bitwarden.sh compresslogs 20240304 20240305を使用します。

証明書を更新する

証明書を更新します。

再建する

config.ymlから生成されたインストールアセットを再構築します。

助けて

すべてのコマンドをリストします。

このページの変更を提案する

どうすればこのページを改善できますか?
技術、請求、製品に関するご質問は、サポートまでお問い合わせください。

クラウドのステータス

ステータスを確認する

あなたのサイバーセキュリティの知識をレベルアップさせましょう。

ニュースレターを購読してください。


© 2024 Bitwarden, Inc. 利用規約 プライバシー クッキーの設定 サイトマップ

このサイトは日本語でご利用いただけます。
Go to EnglishStay Here