server README

The project's README from github.com/bitwarden/server. As one markdown file: README.md.

Bitwarden

Github Workflow build on main


The Bitwarden Server project contains the APIs, database, and other core infrastructure items needed for the "backend" of all bitwarden client applications.

The server project is written in C# using .NET Core with ASP.NET Core. The database is written in T-SQL/SQL Server. The codebase can be developed, built, run, and deployed cross-platform on Windows, macOS, and Linux distributions.

Developer Documentation

Please refer to the Server Setup Guide in the Contributing Documentation for build instructions, recommended tooling, code style tips, and lots of other great information to get you started.

Deploy

docker

You can deploy Bitwarden using Docker containers on Windows, macOS, and Linux distributions. Use the provided PowerShell and Bash scripts to get started quickly. Find all of the Bitwarden images on GitHub Container Registry.

Full documentation for deploying Bitwarden with Docker can be found in our help center at: https://help.bitwarden.com/article/install-on-premise/

Requirements

These dependencies are free to use.

Linux & macOS

curl -s -L -o bitwarden.sh \
    "https://func.bitwarden.com/api/dl/?app=self-host&platform=linux" \
    && chmod +x bitwarden.sh
./bitwarden.sh install
./bitwarden.sh start

Windows

Invoke-RestMethod -OutFile bitwarden.ps1 `
    -Uri "https://func.bitwarden.com/api/dl/?app=self-host&platform=windows"
.\bitwarden.ps1 -install
.\bitwarden.ps1 -start

Production Container Images

View Current Production Image Hashes (click to expand)

US Production Cluster

Service Image Hash
Admin admin
API api
Billing billing
Events events
EventsProcessor eventsprocessor
Identity identity
Notifications notifications
SCIM scim
SSO sso

EU Production Cluster

Service Image Hash
Admin admin
API api
Billing billing
Events events
EventsProcessor eventsprocessor
Identity identity
Notifications notifications
SCIM scim
SSO sso

We're Hiring!

Interested in contributing in a big way? Consider joining our team! We're hiring for many positions. Please take a look at our Careers page to see what opportunities are currently open as well as what it's like to work at Bitwarden.

Contribute

Code contributions are welcome! Please commit any pull requests against the main branch. Learn more about how to contribute by reading the Contributing Guidelines. Check out the Contributing Documentation for how to get started with your first contribution.

Security audits and feedback are welcome. Please open an issue or email us privately if the report is sensitive in nature. You can read our security policy in the SECURITY.md file. We also run a program on HackerOne.

No grant of any rights in the trademarks, service marks, or logos of Bitwarden is made (except as may be necessary to comply with the notice requirements as applicable), and use of any Bitwarden trademarks must comply with Bitwarden Trademark Guidelines.

Dotnet-format

Consider installing our git pre-commit hook for automatic formatting.

git config --local core.hooksPath .git-hooks

server (bitwarden/server)

Searching Database…

20.4K ·GitHub
这是什么?这是 Bitwarden 密码管理器的服务端:包含 API、数据库和核心后端基础设施,所有 Bitwarden 客户端应用都连接到它。把它部署在自己的硬件上,就能拥有属于自己的 Bitwarden 实例。
所以它本身不是应用——那我要运行的到底是什么?客户端应用是独立的项目;这个仓库是它们所连接的后端。它用 C# 编写,基于 .NET 和 ASP.NET Core,数据库使用 T-SQL/SQL Server,并以 Docker 容器的形式发布。
我怎么才能把自己的实例跑起来?用 Docker:安装 Docker 和 Docker Compose,然后运行提供的 Bash(Linux/macOS)或 PowerShell(Windows)脚本,从 GitHub Container Registry 拉取镜像并启动整套服务。
需要提前装好哪些东西?只需要 Docker 和 Docker Compose,而且某些 Docker 安装方式已经自带 Compose。两者都可以免费使用。
在决定自己搭建之前,有什么需要留意的坑吗?Docker 是 README 中唯一说明的部署方式,所以一套能正常运行的 Docker + Compose 环境是硬性前提。另外,它一旦成为你的密码服务器,更新和备份等日常维护就得靠你自己了。
许可证或商标方面有什么限制吗?README 没有为代码指定许可证,但划了一条界限:不授予 Bitwarden 商标、服务标志或徽标的任何权利,所以任何品牌使用都必须遵守其 Trademark Guidelines。
一次完整的部署由哪些服务组成?每个组件都以独立容器的形式发布:除了主 API 之外,还有 Identity、SSO、SCIM、Notifications、Events、EventsProcessor、Billing 以及一个 Admin 管理门户——这正是 Bitwarden 公布生产环境镜像哈希值的完整服务集合。
这就是实际支撑 Bitwarden 托管服务的那套东西吗?基本是——README 公布了 Bitwarden 美国和欧盟集群当前生产环境的镜像哈希值,覆盖的正是这些服务,所以这个仓库构建的镜像就是托管产品背后所用的镜像。
我能在任何操作系统上开发和构建它吗?可以:这套代码可以在 Windows、macOS 和 Linux 上跨平台开发、构建、运行和部署。贡献文档中的 Server Setup Guide 提供了构建说明和工具介绍,还有一个可选的 dotnet-format git pre-commit 钩子。
Creator
bitwarden
Size
68 MB
Stars
20.4K
Age
10y
Commits · 90 Days