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, причём Compose уже входит в состав некоторых установок Docker. И то и другое бесплатное.
Есть ли подводные камни, прежде чем я решусь на самостоятельный хостинг?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 из документации для контрибьюторов описаны сборка и инструменты, а также необязательный git pre-commit hook для dotnet-format.
Creator
bitwarden
Size
68 MB
Stars
20.4K
Age
10y
Commits · 90 Days