server Documentation

File: README.md Copy Chapter

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 Copy Chapter

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 Copy Chapter

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 Copy Section

• Docker
• Docker Compose (already included with some Docker installations)

These dependencies are free to use.

Linux & macOS Copy Section

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 Copy Section

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 Copy Chapter

View Current Production Image Hashes (click to expand)

US Production Cluster Copy Section

EU Production Cluster Copy Section

We're Hiring! Copy Chapter

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 Copy Chapter

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 Copy Section

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

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

File: bitwarden_license/README.md Copy Chapter

Bitwarden Licensed Code

All source code under this directory is licensed under the Bitwarden License Agreement.

File: util/SqlServerEFScaffold/README.MD Copy Chapter

Usage Copy Chapter

The SqlServerEFScaffold project is intended to be used as a tool for developers to validate their Microsoft SQL Server database changes and Infrastructure.EntityFramework.Models stay in sync for entity framework MS SQL Server repositories.

Check Infrastructure.EntityFramework.Models (Database First) Copy Chapter

Run the following:

dotnet ef dbcontext scaffold "<local db connection string>" Microsoft.EntityFrameworkCore.SqlServer -o Model

The dotnet entity framework command will generate models from the local database provided.

Engineers can reference these models and validate they match with Infrastructure.EntityFramework.Models.

Check Microsoft SQL Server Database changes (Code/Model First) Copy Chapter

Run the following:

dotnet ef migrations add Init
dotnet ef migrations script

This will generate a SQL script to initialize a database based on the models in Infrastructure.EntityFramework.Models.

This is helpful to check against the proposed database changes provided in /src/SQL