bitwarden-server

mirror of https://github.com/bitwarden/server.git synced 2024-12-24 17:17:40 +01:00

The core infrastructure backend (API, database, Docker, etc).

api aspnet aspnetcore bitwarden csharp docker dotnet dotnet-core signalr sql sql-server

Go to file

Chad Scharf f6044f0d00 Missed one other PR comment fix		2020-04-01 15:47:10 -04:00
scripts	bump docker version for web vault	2020-03-25 11:25:55 -04:00
src	Missed one other PR comment fix	2020-04-01 15:47:10 -04:00
test/Core.Test	upgrade more lgos. remove sendgrid	2020-03-05 10:33:44 -05:00
util	[Soft Delete] - API updates for soft delete + retrieval	2020-04-01 13:00:25 -04:00
.editorconfig	fix prefix fields with _	2020-01-15 09:19:15 -05:00
.gitattributes	Added .gitattributes file to files requiring LF endings are properly checked out on Windows. (#380 )	2018-10-18 12:15:41 -04:00
.gitignore	gulp build for libs	2018-03-23 15:07:17 -04:00
appveyor.yml	remove old indented option	2020-01-10 16:11:15 -05:00
bitwarden-server.sln	swagger cli tool fixes	2020-01-10 16:06:44 -05:00
build.sh	build events container into docker deployment	2019-07-09 14:49:34 -04:00
dotnet-tools.json	swagger cli tool fixes	2020-01-10 16:06:44 -05:00
ISSUE_TEMPLATE.md	Update ISSUE_TEMPLATE.md	2018-03-10 14:35:33 -05:00
LICENSE.txt	License changed to AGPLv3	2016-12-03 00:16:25 -05:00
NuGet.Config	initial commit of source	2015-12-08 22:57:38 -05:00
README.md	bump .net core to 3.1 in readme	2020-02-18 17:15:08 -05:00
SECURITY.md	Uppercase Bitwarden	2018-02-27 14:16:19 -05:00

README.md

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.

Build/Run

Requirements

These dependencies are free to use.

Recommended Development Tooling

Visual Studio (Windows and macOS)
Visual Studio Code (other)

These tools are free to use.

API

cd src/Api
dotnet restore
dotnet build
dotnet run

visit http://localhost:5000/alive

Identity

cd src/Identity
dotnet restore
dotnet build
dotnet run

visit http://localhost:33657/.well-known/openid-configuration

Deploy

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 Docker Hub.

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

Requirements

Docker
Docker Compose (already included with some Docker installations)

These dependencies are free to use.

Linux & macOS

curl -s -o bitwarden.sh \
    https://raw.githubusercontent.com/bitwarden/server/master/scripts/bitwarden.sh \
    && chmod +x bitwarden.sh
./bitwarden.sh install
./bitwarden.sh start

Windows

Invoke-RestMethod -OutFile bitwarden.ps1 `
    -Uri https://raw.githubusercontent.com/bitwarden/server/master/scripts/bitwarden.ps1
.\bitwarden.ps1 -install
.\bitwarden.ps1 -start

Contribute

Code contributions are welcome! Visual Studio or VS Code is highly recommended if you are working on this project. Please commit any pull requests against the master branch.

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.