设置指南
此页面将向您展示如何为开发目的设置本地 Bitwarden 服务器。
Bitwarden 服务器由多个可以独立运行的服务组成。对于基本的开发设置，需要 API 和 Identity 服务。
- Docker Desktop
- Visual Studio
- Powershell
- Azure Data Studio
1、克隆 Bitwarden 服务器项目：
git clone https://github.com/bitwarden/server.git
2、打开终端并导航到已克隆的存储库的根目录。
配置 Git 以忽略 Prettier 修订：
git config blame.ignoreRevsFile .git-blame-ignore-revs
我们提供了一个 Docker Compose 配 置，用于在开发过程提供所需的依赖。这被分成多个服务配置文件，以方便自定义。
1、一些 Docker 设置被配置在环境文件
dev/.env 中。复制示例环境文件：cd dev
cp .env.example .env
2、使用您喜欢的编辑器打开
.env。3、设置
MSSQL_PASSWORD 变量。这将是用于您的 MSSQL 数据库服务器的密码。- 它必须至少有八个字符。
- 它必须包含来自以下四个类别中的三个类别的字符：
- 拉丁文大写字母 (A-Z)
- 拉丁文小写字母 (a-z)
- 基本的 10 位数数字 (0-9)
- 非字母数字字符，例如：感叹号 (!)、美元符号 ($)、数字符号 (#) 或百分比 (%)。
4、您可以更改其他变量，也可以使用它们的默认值。保存并退出此文件。
5、启动 Docker 容器。
使用 PowerShell 导航到已克隆的服务器存储库位置，进入 dev 文件夹然后运行下面的 docker 命令。
社区开发人员
Bitwarden 开发人员
如果您是社区开发人员，我们推荐使用以下命令。它启动 MSSQL 和本地邮件服务器容器，这应该适合大多数社区贡献。
docker compose --profile mssql --profile mail up -d
如果您是 Bitwarden 开发人员，我们推荐使用以下命令。它同时启动 MSSQL 和 Azurite 容器，Azurite 容器被云实例用于模拟 Azure 服务。
docker compose --profile cloud --profile mail up -d
首次运行 docker compose 后更改
MSSQL_PASSWORD 变量将需要重新创建存储卷。警告：这将删除您的开发数据库。
为此，请运行
docker compose --profile mssql down docker volume rmbitwardenserver_edgesql_dev_data之后，重新运行步骤 5 中的 docker compose 命令。
为了支持基于 ARM 的开发环境，例如 M1 Mac，我们使用 Azure SQL Edge docker 容器而不 是普通的 Microsoft SQL Server 容器。它的行为与常规 SQL Server 实例基本相同，并运行在 1433 端口上。
您可以使用 Azure Data Studio 并通过以下凭据连接到它：
- 服务器：localhost
- 用户名：sa
- 密码：（您在
dev/.env中设置的密码）
此服务器使用电子邮件进行许多用户交互。我们提供了一个预配置的 MailCatcher 实例，它可以捕获任何出站电子邮件并防止将其被发送到真实的电子邮件地址。您可以通过
http://localhost:1080 打开其 Web 界面。本部分仅适用于 Bitwarden 开发人员。
要引导本地 Azurite 实例：
1、安装 Az 模块。在不提供任何用户反馈的情况下，这可能需要几分钟才能完成（它可能会显示为冻结）。
pwsh -Command "Install-Module -Name Az -Scope CurrentUser -Repository PSGallery -Force"
2、运行安装脚本：
pwsh setup_azurite.ps1
现在 MSSQL 服务器已经运行了。下一步是创建 Bitwarden 服务器所使用的数据库。
我们提供了一个帮助脚本用于创建开发数据库
vault_dev 并同时运行所有迁移。1、创建数据库并运行所有迁移：
pwsh migrate.ps1
2、您应该会收到各个迁移脚本已成功运行的确认信息：
Performing /mnt/migrator/DbScripts/2017-08-19_00_InitialSetup.sql
Performing /mnt/migrator/DbScripts/2017-08-22_00_LicenseCheckScripts.sql
Performing /mnt/migrator/DbScripts/2017-08-30_00_CollectionWriteOnly.sql
[...]
下一步是为本地开发创建两个自签名证书。我们提供了一个帮助脚本，用于生成这些证书并将它们添加到您系统的钥匙串或证书存储中。
1、生成证书并将它们保存到您的钥匙串中：
sh create_certificates_mac.sh
2、您将收到类似于以下内容的输出。下一部分将需要此信息。
Certificate fingerprints:
Identity Server Dev: 0BE8A0072214AB37C6928968752F698EEC3A68B5
Data Protection Dev: C3A6CECAD3DB580F91A52FC9C767FE780300D8AB
3、打开钥匙串访问并转到您的登录钥匙串。
4、双击
Bitwarden Data Protection Dev 和 Bitwarden Identity Server Dev 证书。5、将每个证书的信任设置更改为「始终信任」。
1、生成证书并将它们保存到证书存储中：
.\create_certificates_windows.ps1
2、您将收到类似于以下内容的输出。下一部分将需要此信息。
PSParentPath: Microsoft.PowerShell.Security\Certificate::CurrentUser\My
Thumbprint Subject
---------- -------
0BE8A0072214AB37C6928968752F698EEC3A68B5 CN=Bitwarden Identity Server Dev
C3A6CECAD3DB580F91A52FC9C767FE780300D8AB CN=Bitwarden Data Protection Dev
用户机密是一种开发人员管理应用程序设置的方法。它们覆盖每一个项目的
appsettings.json 中的设置。您的用户机密文件应与您打算覆盖的设置的 appsettings.json 文件的结构相匹配。我们提供了一个帮助脚本，可以简化为服务器存储库中的所有项目设置用户机密的步骤。
1、复制示例
secret.json 文件。cp secrets.json.example secrets.json
2、编辑
secrets.json 并更新以下字符串：sqlServer>connectionString：在指示的地方插入您的密码identityServer>certificateThumbprint：插入上一步中您的的 Identity 证书指纹dataProtection>certificateThumbprint：插入上一步中您的数据保护证书指纹
3、您还需要以下附加用户机密：
licenseDirectory：将此设置为空目录，这是用于存储上传的许可证文件的位置
4、将机密添加到每一个 Bitwarden 服务器项目：
pwsh setup_secrets.ps1
此帮助脚本 还支持一个可选标志，该标志用于在重新应用之前删除所有现有的设置：
pwsh setup_secrets.ps1 -clear:$True
您现在已准备好构建和运行您的开发服务器了。
1、在存储库的根目录中打开一个新的终端窗口。
2、恢复 Identity 服务所需的 nuget 包：
cd src/Identity
dotnet restore
3、启动 Identity 服务：
dotnet run
5、在另一个终端窗口中，恢复 API 服务所需的 nuget 包：
cd src/Api
dotnet restore
6、启动 API 服务：
dotnet run
如果您无法连接到 API 或 Identity 项目，请检查终端输出以确认它们所运行的端口。
在 macOS 上，您必须先为每个项目运行
dotnet restore，然后才能在调试器中启动它。调试：
- 在 Windows 上，右键点击每个项目 → 点击 Debug → 点击 Start New Instance
- 在 macOS 上，右键点击每个项目 → 点击 Start Debugging Project
通过分别点击每一个项目的「play」按钮来启动 API 项目和 Identity 项目。
最近更新 3mo ago