bitwarden-server

mirror of https://github.com/bitwarden/server.git synced 2024-12-22 16:57:36 +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

Kyle Spearrin bfb945ac5f Update README.md		2017-08-20 22:27:23 -04:00
docker	move docker dir	2017-08-19 22:40:21 -04:00
scripts	download sh not ps1	2017-08-19 22:57:06 -04:00
src	script fixes for mac	2017-08-19 15:27:57 -04:00
util	new dir for docker env overrides dir	2017-08-19 22:09:00 -04:00
.gitignore	script fixes for mac	2017-08-19 15:27:57 -04:00
bitwarden-core.sln	stubbed out jobs worker console app	2017-08-17 11:28:27 -04:00
build.ps1	mssql image with setup script on entrypoint	2017-08-17 22:28:56 -04:00
build.sh	script fixes for mac	2017-08-19 15:27:57 -04: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	Update README.md	2017-08-20 22:27:23 -04:00
SECURITY.md	Update SECURITY.md	2017-05-19 12:04:07 -04:00

README.md

bitwarden

The bitwarden Core project contains the APIs, database, and other infrastructure items needed for the "backend" of all other bitwarden projects.

The core infrastructure 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

.NET Core 2.x SDK
SQL Server 2016 or 2017 (2017 for cross-platform)

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 -f netcoreapp2.0
dotnet run -f netcoreapp2.0

visit http://localhost:5000/alive

Identity

cd src/Identity
dotnet restore
dotnet build -f netcoreapp2.0
dotnet run -f netcoreapp2.0

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.

Requirements

Docker
Docker Compose (already included with some Docker installations)

These dependencies are free to use.

Windows

Invoke-RestMethod -OutFile bitwarden.ps1 -Uri https://raw.githubusercontent.com/bitwarden/core/master/scripts/bitwarden.ps1

.\bitwarden.ps1 -install
.\bitwarden.ps1 -updatedb
.\bitwarden.ps1 -run

macOS

curl -s -o bitwarden.sh https://raw.githubusercontent.com/bitwarden/core/master/scripts/bitwarden.sh

./bitwarden.sh install
./bitwarden.sh updatedb
./bitwarden.sh runmac

Linux

curl -s -o bitwarden.sh https://raw.githubusercontent.com/bitwarden/core/master/scripts/bitwarden.sh

./bitwarden.sh install
./bitwarden.sh updatedb
./bitwarden.sh run

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.