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
What is this?This is the server side of Bitwarden, the password manager: the APIs, database, and core backend infrastructure that all Bitwarden client apps talk to. Run it on your own hardware to get your own Bitwarden instance.
So it's not the app itself — what exactly would I be running?The client apps are separate projects; this repo is the backend they connect to. It's written in C# on .NET with ASP.NET Core, uses a T-SQL/SQL Server database, and ships as Docker containers.
How do I get my own instance up and running?With Docker: install Docker and Docker Compose, then run the provided Bash (Linux/macOS) or PowerShell (Windows) scripts to pull the images from GitHub Container Registry and start the stack.
What do I need to have installed beforehand?Just Docker and Docker Compose, and Compose already comes bundled with some Docker installations. Both are free to use.
Any gotchas before I commit to self-hosting it?Docker is the only deployment path the README documents, so a working Docker + Compose setup is a hard prerequisite. And since it becomes your password server, upkeep like updates and backups is on you.
Is there a catch in the licensing or trademarks?The README names no code license, but it sets one boundary: no rights in Bitwarden trademarks, service marks, or logos are granted, so any use of the brand must follow their Trademark Guidelines.
What services make up a full deployment?Each component ships as its own container: alongside the main API there are Identity, SSO, SCIM, Notifications, Events, EventsProcessor, Billing, and an Admin portal — the full set Bitwarden publishes production image hashes for.
Is this what actually runs Bitwarden's hosted service?Close — the README publishes current production image hashes for Bitwarden's US and EU clusters covering exactly these services, so the images this repo builds are the ones behind the hosted product.
Can I develop and build it on any OS?Yes: the codebase can be developed, built, run, and deployed cross-platform on Windows, macOS, and Linux. The Contributing Documentation's Server Setup Guide covers build instructions and tooling, plus an optional git pre-commit hook for dotnet-format.
Creator
bitwarden
Size
68 MB
Stars
20.4K
Age
10y
Commits · 90 Days